Interface ShippingMethodSetCustomFieldAction

This action sets, overwrites, or removes any existing Custom Field for an existing ShippingMethod.

interface ShippingMethodSetCustomFieldAction {
    action: "setCustomField";
    name: string;
    value?: any;
}

Properties

action name value?

Properties

Readonly action

action: "setCustomField"

Readonly name

name: string

Name of the Custom Field.

Optional Readonly value

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

Theme

On This Page

actionnamevalue