Interface CustomerSetAddressCustomFieldAction

Adding a Custom Field to an Address of a Customer generates the CustomerAddressCustomFieldAdded Message, removing one generates the CustomerAddressCustomFieldRemoved Message, and updating an existing one generates the CustomerAddressCustomFieldChanged Message.

interface CustomerSetAddressCustomFieldAction {
    action: "setAddressCustomField";
    addressId: string;
    name: string;
    value?: any;
}

Properties

action addressId name value?

Properties

Readonly action

action: "setAddressCustomField"

Readonly addressId

addressId: string

User-defined unique identifier of the Address to be updated.

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. If value is provided, it is set for the field defined by name. Trying to remove a field that does not exist will fail with an InvalidOperation error.

Settings

Member Visibility

Theme

On This Page

actionaddressIdnamevalue