Interface CustomerSetAddressCustomTypeAction

Adding or updating a Custom Type on an Address of a Customer generates the CustomerAddressCustomTypeSet Message, and removing one generates the CustomerAddressCustomTypeRemoved Message.

interface CustomerSetAddressCustomTypeAction {
    action: "setAddressCustomType";
    addressId: string;
    fields?: FieldContainer;
    type?: TypeResourceIdentifier;
}

Properties

action: "setAddressCustomType"

addressId: string

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

Object containing the Custom Fields fields for the address.

Required if at least one Custom Field is defined as required in the `fieldDefinitions` of the referenced [Type](ctp:api:type:Type).

Defines the Type that extends the address with Custom Fields. If absent, any existing Type and Custom Fields are removed from the address.