Interface CustomerAddressCustomFieldChangedMessagePayload

Generated after changing an existing Custom Field on an Address of a Customer using the Set CustomField in Address update action.

interface CustomerAddressCustomFieldChangedMessagePayload {
    name: string;
    previousValue?: any;
    type: "CustomerAddressCustomFieldChanged";
    value: any;
}

Index

Properties

name previousValue? type value

Properties

`Readonly` name

name: string

Name of the Custom Field that changed.

`Optional` `Readonly` previousValue

previousValue?: any

CustomFieldValue based on the FieldType before the Set CustomField update action. When there has not been a Custom Field with the name on the Customer Address before, a Customer Address Custom Field Added Message is generated instead.

`Readonly` type

type: "CustomerAddressCustomFieldChanged"

`Readonly` value

value: any

CustomFieldValue based on the FieldType after the Set CustomField update action.