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

    Interface OrderSetShippingCustomFieldAction

    interface OrderSetShippingCustomFieldAction {
        action: "setShippingCustomField";
        name: string;
        shippingKey?: string;
        value?: any;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action name shippingKey? value?

    Properties

    action: "setShippingCustomField"
    name: string

    Name of the Custom Field.

    shippingKey?: string

    The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize on a Order with Multiple ShippingMode. Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Order.

    value?: any

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

    Settings

    Member Visibility

    On This Page

    Properties