Interface CartSetShippingCustomFieldAction

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

Properties

action name shippingKey? value?

Properties

Readonly action

action: "setShippingCustomField"

Readonly name

name: string

Name of the Custom Field.

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 value

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

Theme

On This Page

actionnameshippingKeyvalue