Interface CartSetShippingCustomTypeAction

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

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

Properties

action fields? shippingKey? type?

Properties

Readonly action

action: "setShippingCustomType"

Optional Readonly fields

fields?: FieldContainer

Sets the Custom Fields fields for the shippingMethod.

Optional Readonly shippingKey

shippingKey?: string

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

Optional Readonly type

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

Theme

On This Page

actionfieldsshippingKeytype