Typescript SDK Type Docs
    Preparing search index...

    Interface CustomerSetDefaultShippingAddressAction

    Sets the default shipping address from addresses. The action adds the id of the specified address to the shippingAddressIds if not contained already. Either addressId or addressKey is required.

    This action generates the [CustomerDefaultShippingAddressSet](ctp:api:type:CustomerDefaultShippingAddressSetMessage) Message.
    interface CustomerSetDefaultShippingAddressAction {
        action: "setDefaultShippingAddress";
        addressId?: string;
        addressKey?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action addressId? addressKey?

    Properties

    action: "setDefaultShippingAddress"
    addressId?: string

    id of the Address to become the default shipping address.

    addressKey?: string

    key of the Address to become the default shipping address.

    Settings

    Member Visibility

    On This Page

    Properties