@gradientedge/commercetools-utils
    Preparing search index...

    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;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action addressId name value?

    Properties

    action: "setAddressCustomField"
    addressId: string

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

    name: string

    Name of the Custom Field.

    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

    On This Page

    Properties