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

    Interface BusinessUnitSetAddressCustomFieldAction

    Adding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.

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

    Hierarchy (View Summary)

    Index

    Properties

    action addressId name value?

    Properties

    action: "setAddressCustomField"
    addressId: string

    ID of the address to be extended.

    name: string

    Name of the Custom Field.

    value?: any

    If value is absent or null, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

    Settings

    Member Visibility

    On This Page

    Properties