Add shipTo IDs to cart items

Add shipTo IDs to cart items

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.

Path Parameters

cartId

string

required

Required string length: 24

Body

application/json · object[]

itemId

string

required

lineItemId

number

required

shipTo

string

Required string length: 24

Response

200 - application/json

__v

number

account

string

allPromosApplied

any[]

approver

string

attributes

object[]

Show child attributes

attributes._id

string

attributes.attributeId

string

attributes.id

string

attributes.name

string

attributes.price

number

attributes.type

string

attributes.value

string

cartId

number

company

string

deleted

boolean

errors

object

Show child attributes

errors.inventory

any[]

errors.price

any[]

errors.promo

any[]

extra

object

items

object[]

Show child attributes

items.group

string[]

required

items.itemId

number

required

items.price

object

required

Show child attributes

items.price.base

number

required

items.price.currency

string

required

Required string length: 3

items.price.discount

object

required

Show child attributes

items.price.discount.price

number

default:

0

required

items.price.discount.discountAmount

number

default:

0

items.price.discount.promosApplied

object[]

Show child attributes

items.price.discount.promosApplied.id

string

items.price.discount.promosApplied.ON

object

Show child attributes

items.price.discount.promosApplied.promoCode

string

items.price.discount.promosApplied.promoId

string

items.price.discount.promosApplied.unit

string

items.price.discount.promosApplied.value

integer

items.price.sale

number

items.quantity

number

default:

1

required

Required range: x > 1

items._id

string

items.attributes

object[]

Show child attributes

items.attributes._id

string

items.attributes.attributeId

string

items.attributes.id

string

items.attributes.name

string

items.attributes.price

number

items.attributes.shipTo

object

Show child attributes

items.attributes.shipTo.city

string

required

Maximum length: 140

items.attributes.shipTo.country

string

required

Maximum length: 140

items.attributes.shipTo.email

string

required

Required string length: 5 - 100

items.attributes.shipTo.name

object

required

Show child attributes

items.attributes.shipTo.name.first

string

Required string length: 2 - 50

items.attributes.shipTo.name.last

string

Required string length: 2 - 50

items.attributes.shipTo.state

string

required

Maximum length: 25

items.attributes.shipTo.street1

string

required

Maximum length: 140

items.attributes.shipTo.zipCode

string

required

Required string length: 3 - 25

items.attributes.shipTo.attention

string

Maximum length: 140

items.attributes.shipTo.cartId

object

items.attributes.shipTo.kind

string

Maximum length: 24

items.attributes.shipTo.phone

object

Show child attributes

items.attributes.shipTo.phone.kind

string

required

Required string length: 3 - 25

items.attributes.shipTo.phone.number

string

required

Required string length: 5 - 25

items.attributes.shipTo.shipTo

object

Show child attributes

items.attributes.shipTo.shipTo.shipMethod

object

Show child attributes

items.attributes.shipTo.shipToId

string

items.attributes.shipTo.shipToType

string

items.attributes.shipTo.street2

string

Maximum length: 240

items.attributes.shipTo.taxCode

string

items.attributes.type

string

items.attributes.value

string

items.attributeTotalPrice

number

items.createdAt

string

items.discountedQuantity

number

items.id

string

items.isPickup

boolean

items.isUnique

string

items.lineItemId

number

items.priceListId

number

items.sample

boolean

items.sku

string

items.taxCode

string

items.title

string

items.totalPrice

object

Show child attributes

items.totalPrice.amount

number

items.totalPrice.currency

string

items.updatedAt

string

items.weight

number

items.weightUnit

string

po

string

quantity

number

registeredUser

boolean

status

string

totalAmmount"

object

Show child attributes

totalAmmount".amount

number

totalAmmount".currency

string