@gradientedge/commercetools-utils
    Preparing search index...

    Interface CustomObjectDraft

    interface CustomObjectDraft {
        container: string;
        key: string;
        value: any;
        version?: number;
    }
    Index

    Properties

    container key value version?

    Properties

    container: string

    Namespace to group CustomObjects.

    key: string

    User-defined unique identifier of the CustomObject within the defined container.

    value: any

    Can be any JSON standard type, such as number, string, boolean, array, object, or a common API data type.

    - Fields within `value` that have `null` values **are not saved**.
- For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
    version?: number

    Current version of the CustomObject.

    Settings

    Member Visibility

    On This Page

    Properties