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

    Interface OrderSetParcelCustomFieldAction

    interface OrderSetParcelCustomFieldAction {
        action: "setParcelCustomField";
        name: string;
        parcelId?: string;
        parcelKey?: string;
        value?: any;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action name parcelId? parcelKey? value?

    Properties

    action: "setParcelCustomField"
    name: string

    Name of the Custom Field.

    parcelId?: string

    id of an existing Parcel.

    Either `parcelId` or `parcelKey` must be provided.
    parcelKey?: string

    key of an existing Parcel.

    Either `parcelId` or `parcelKey` must be provided.
    value?: any

    If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

    Settings

    Member Visibility

    On This Page

    Properties