Create shipping details for all items specific cart

Create shipping details for all items in a specified cart. Shipping details are identified by a unique shippingDetailsId, and include the shipment’s delivery address, shipment method, pickup persons’ details, warehouse ID, store ID, and more.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

x-api-key

string

API Key for Gateway

Authorization

string

required

Authorization token for the user

Path Parameters

cartId

string

required

ID of cart for which shipping data is being created

Body

application/json

Request body used to create shipping details for a cart

shipToType

string

required

Shipping type

address

object

Shipping address

Show child attributes

address.attention

string | null

Address recipient

address.city

string | null

City name

address.country

string | null

Country name

address.email

string | null

Receiver's email address

address.kind

string | null

Address type

address.name

object

Recipient's name

Show child attributes

address.name.first

string | null

Individual's first name

address.name.last

string | null

Individual's last name

address.name.middle

string | null

Individual's middle name or initial

address.phone

object

address details for the shipping

Show child attributes

address.phone.number

string

required

Phone number

address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

address.state

string | null

State name

address.street1

string | null

Address line 1

address.street2

string | null

Address line 2

address.street3

string | null

Address line 3

address.street4

string | null

Address line 4

address.zipCode

string | null

Zip code

altPickupPerson

object

Alternative pickup person

Show child attributes

altPickupPerson.attention

string | null

Address recipient

altPickupPerson.city

string | null

City name

altPickupPerson.country

string | null

Country name

altPickupPerson.email

string | null

Receiver's email address

altPickupPerson.kind

string | null

Address type

altPickupPerson.name

object

Recipient's name

Show child attributes

altPickupPerson.name.first

string | null

Individual's first name

altPickupPerson.name.last

string | null

Individual's last name

altPickupPerson.name.middle

string | null

Individual's middle name or initial

altPickupPerson.phone

object

address details for the shipping

Show child attributes

altPickupPerson.phone.number

string

required

Phone number

altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

altPickupPerson.state

string | null

State name

altPickupPerson.street1

string | null

Address line 1

altPickupPerson.street2

string | null

Address line 2

altPickupPerson.street3

string | null

Address line 3

altPickupPerson.street4

string | null

Address line 4

altPickupPerson.zipCode

string | null

Zip code

estimatedDeliveryDate

string | null

Estimated date for delivery

estimatedShipDate

string | null

Estimated date for shipping

isPickup

boolean

true: Item is set for pickup<br />false: Item is set for delivery

pickupPerson

object

Designated pickup person

Show child attributes

pickupPerson.email

string | null

Receiver's email address

pickupPerson.name

object

Name of pickup person

Show child attributes

pickupPerson.name.first

string | null

Individual's first name

pickupPerson.name.last

string | null

Individual's last name

pickupPerson.name.middle

string | null

Individual's middle name or initial

pickupPerson.phone

object

Number of pickup person

Show child attributes

pickupPerson.phone.number

string

required

Phone number

pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

shipmentInstructions

string | null

Store ID

shipMethod

object

Shipping method

Show child attributes

shipMethod.cost

object

Shipping cost

Show child attributes

shipMethod.cost.amount

number

required

Shipping cost

shipMethod.cost.currency

string | null

Currency type

shipMethod.cost.discount

number | null

Shipping discount

shipMethod.shipmentCarrier

string | null

Shipment carrier

shipMethod.shipmentMethod

string | null

Shipment method type

shipMethod.shipMethodId

string

Shipping method ID

storeId

string | null

Store ID

taxCode

string | null

Shipping tax code

warehouseId

string | null

Warehouse ID

Response

200 - application/json

Shipping response body

address

object

Shipping address

Show child attributes

address.attention

string | null

Address recipient

address.city

string | null

City name

address.country

string | null

Country name

address.email

string | null

Receiver's email address

address.kind

string | null

Address type

address.name

object

Recipient's name

Show child attributes

address.name.first

string | null

Individual's first name

address.name.last

string | null

Individual's last name

address.name.middle

string | null

Individual's middle name or initial

address.phone

object

address details for the shipping

Show child attributes

address.phone.number

string

required

Phone number

address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

address.state

string | null

State name

address.street1

string | null

Address line 1

address.street2

string | null

Address line 2

address.street3

string | null

Address line 3

address.street4

string | null

Address line 4

address.zipCode

string | null

Zip code

altPickupPerson

object

Alternative pickup person

Show child attributes

altPickupPerson.email

string | null

Receiver's email address

altPickupPerson.name

object

Name of pickup person

Show child attributes

altPickupPerson.name.first

string | null

Individual's first name

altPickupPerson.name.last

string | null

Individual's last name

altPickupPerson.name.middle

string | null

Individual's middle name or initial

altPickupPerson.phone

object

Number of pickup person

Show child attributes

altPickupPerson.phone.number

string

required

Phone number

altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

cartId

string | null

Cart ID

createdAt

string | null

Shipping details creation time

estimatedDeliveryDate

string | null

Estimated date for delivery

estimatedShipDate

string | null

Estimated date for shipping

isPickup

boolean

true: Item is set for pickup<br />false: Item is set for delivery

pickupPerson

object

Designated pickup person

Show child attributes

pickupPerson.email

string | null

Receiver's email address

pickupPerson.name

object

Name of pickup person

Show child attributes

pickupPerson.name.first

string | null

Individual's first name

pickupPerson.name.last

string | null

Individual's last name

pickupPerson.name.middle

string | null

Individual's middle name or initial

pickupPerson.phone

object

Number of pickup person

Show child attributes

pickupPerson.phone.number

string

required

Phone number

pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

shipmentInstructions

string | null

Store ID

shipMethod

object

Shipping method and details

Show child attributes

shipMethod.cost

object

Shipping cost

Show child attributes

shipMethod.cost.amount

number

required

Shipping cost

shipMethod.cost.currency

string | null

Currency type

shipMethod.cost.discount

number | null

Shipping discount

shipMethod.shipmentCarrier

string | null

Shipment carrier

shipMethod.shipmentMethod

string | null

Shipment method type

shipMethod.shipMethodId

string

Shipping method ID

shipToId

string | null

Shipping details ID

shipToType

string | null

Shipping type

storeId

string | null

Store ID

taxCode

string | null

Shipping tax code

updatedAt

string | null

Last time shipping details were updated

warehouseId

string | null

Warehouse ID