commerce/checkouts/destinations

Use this resource to manage the addresses a shopper intends to ship items to. This resource remains active while the Checkouts resource is active (the Checkouts resource only applies to sites that enable shipping to multiple destinations within the same order). The Checkouts resource remains active until the shopper submits their order.

JSON Example

Destination Properties

Property Description
data

type: Mozu.Core.Api.Contracts.Json

A data bag that merchants can use for storing custom data. This one is tied to the associated destination.

destinationContact

type: contact

The contact associated with the destination.

contact.address

type: address

Address information to supply for a contact.

contact.address.address1

type: string

Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.

contact.address.address2

type: string

Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.

contact.address.address3

type: string

Physical or mailing address line three. Max length: 200.

contact.address.address4

type: string

Physical or mailing address line four. Max length: 200.

contact.address.addressType

type: string

The type of address, which is commercial or residential.

contact.address.cityOrTown

type: string

The entered city or town for the address.

contact.address.countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

contact.address.isValidated

type: bool

Indicates if the address has been validated. If true, the address has been verified by an address validation service.

contact.address.postalOrZipCode

type: string

The entered zip or postal code for an address.

contact.address.stateOrProvince

type: string

The entered state or province for an address.

contact.companyOrOrganization

type: string

The entered company or organization name entered for a customer account.

contact.email

type: string

The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.

contact.firstName

type: string

The full first name of a customer or contact name.

contact.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

contact.lastNameOrSurname

type: string

The full last name or surname of a customer or contact name.

contact.middleNameOrInitial

type: string

Character string of the middle name or initial for the customer.

contact.phoneNumbers

type: phone

List of phone numbers associated with the customer account contact. The phone numbers include area codes.

contact.phone.home

type: string

Home phone number.

contact.phone.mobile

type: string

Mobile phone number.

contact.phone.work

type: string

Work phone number.

id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

isDestinationCommercial

type: bool

True if the destination is a commercial address.

Operations

Operation Name Request URI Description
AddDestination POST %7bcheckoutId%7d%2fdestinations%3fresponseFields%3d%7bresponseFields%7d

Adds a destination to a checkout.

GetDestination GET %7bcheckoutId%7d%2fdestinations%2f%7bdestinationId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves a destination available on a checkout.

GetDestinations GET %7bcheckoutId%7d%2fdestinations

Retrieves all destinations available on a checkout.

RemoveDestination DELETE %7bcheckoutId%7d%2fdestinations%2f%7bdestinationId%7d

Removes a destination from a checkout.

UpdateDestination PUT %7bcheckoutId%7d%2fdestinations%2f%7bdestinationId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the details of a destination on a checkout.