Interface OrderSetDeliveryAddressCustomFieldAction

interface OrderSetDeliveryAddressCustomFieldAction {
    action: "setDeliveryAddressCustomField";
    deliveryId?: string;
    deliveryKey?: string;
    name: string;
    value?: any;
}

Properties

action deliveryId? deliveryKey? name value?

Properties

Readonly action

action: "setDeliveryAddressCustomField"

Optional Readonly deliveryId

deliveryId?: string

id of an existing Delivery.

Either `deliveryId` or `deliveryKey` must be provided.

Optional Readonly deliveryKey

deliveryKey?: string

key of an existing Delivery.

Either `deliveryId` or `deliveryKey` must be provided.

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

actiondeliveryIddeliveryKeynamevalue