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.

If the Tax Category of the Cart [ShippingInfo](ctp:api:type:ShippingInfo) is missing the TaxRate matching country and state given in the `shippingAddress` of that Cart, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned.
interface CustomerSetDefaultShippingAddressAction {
    action: "setDefaultShippingAddress";
    addressId?: string;
    addressKey?: string;
}

Properties

action addressId? addressKey?

Properties

Readonly action

action: "setDefaultShippingAddress"

Optional Readonly addressId

addressId?: string

id of the Address to become the default shipping address.

Optional Readonly addressKey

addressKey?: string

key of the Address to become the default shipping address.

Settings

Member Visibility

Theme

On This Page

actionaddressIdaddressKey