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

    Interface OrderSetShippingCustomTypeAction

    This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's shippingMethod or shipping.

    interface OrderSetShippingCustomTypeAction {
        action: "setShippingCustomType";
        fields?: FieldContainer;
        shippingKey?: string;
        type?: TypeResourceIdentifier;
    }

    Hierarchy (View Summary)

    Index
    action fields? shippingKey? type?
    action: "setShippingCustomType"
    fields?: FieldContainer

    Object containing the Custom Fields fields for the shippingMethod.

    Required if at least one Custom Field is defined as required in the `fieldDefinitions` of the referenced [Type](ctp:api:type:Type).
    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.

    type?: TypeResourceIdentifier

    Defines the Type that extends the specified ShippingMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the ShippingMethod.

    Settings
    Member Visibility

    On This Page
    Properties