Create order draft

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

cartId

string

required

ID of the cart for which order draft will be generated

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

Body

application/json

Request body to create order draft

Sample request to create order draft

paymentDetails

object[]

required

Payment details

Show child attributes

paymentDetails.connectorName

string

required

Payment connector name

Example:

"Authorizenet"

paymentDetails.paymentToken

string

required

Payment token identifier

Example:

534234543

paymentDetails.amount

number<double> | null

required

Payment amount

Example:

10.5

paymentDetails.currency

string

required

Currency code

Example:

"USD"

paymentDetails.conversion

number<double>

default:1

required

Currency Conversion (For USD = 1, For Non-USD = conversion ratio to USD)

Example:

0.5

paymentDetails.billToAddress

object

required

Billing address details Billing address for the order

Show child attributes

paymentDetails.billToAddress.street1

string

required

Address line 1

Example:

"100 NE 100th St."

paymentDetails.billToAddress.city

string

required

City name

Example:

"Seattle"

paymentDetails.billToAddress.state

string

required

State name

Example:

"Washington"

paymentDetails.billToAddress.country

string

required

Country name

Example:

"USA"

paymentDetails.billToAddress.postalCode

string

required

Postal code

Example:

"98125"

paymentDetails.billToAddress.customerId

string

required

Customer ID created for payment instruction

Example:

98121

paymentDetails.billToAddress.name

object

Recipient's name

Show child attributes

paymentDetails.billToAddress.name.first

string | null

Individual's first name

Example:

"Pat"

paymentDetails.billToAddress.name.middle

string | null

Individual's middle name or initial

Example:

"E"

paymentDetails.billToAddress.name.last

string | null

Individual's last name

Example:

"Kake"

paymentDetails.billToAddress.phone

object

Recipient's phone number details

Show child attributes

paymentDetails.billToAddress.phone.number

string

required

Phone number

Example:

"123-456-7899"

paymentDetails.billToAddress.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

paymentDetails.billToAddress.email

string | null

Receiver's email address

Example:

"[email protected]"

paymentDetails.billToAddress.street2

string | null

Address line 2

Example:

"Suite 710"

paymentDetails.billToAddress.street3

string | null

Address line 3

Example:

"Seventh floor"

paymentDetails.billToAddress.street4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

paymentDetails.billToAddress.type

string | null

Address type

Example:

"Residence"

paymentDetails.billToAddress.latitude

number | null

Latitude

Example:

35.294952

paymentDetails.billToAddress.longitude

number | null

Longitude

Example:

32.294952

paymentDetails.paymentMethod

string | null

Payment method

Example:

"card"

paymentDetails.paymentMethodType

string | null

Payment method type

Example:

"tamara or tabby"

paymentDetails.attributes

object

Payment Attributes

Example:

{ "Attribute1": "620d8896058edb0009385311" }

estimatedTax

object

required

Estimated tax object

Show child attributes

estimatedTax.itemsTaxes

object[]

required

Show child attributes

estimatedTax.itemsTaxes.type

string | null

Tax type

Example:

"state_tax"

estimatedTax.itemsTaxes.amount

number<double> | null

Tax amount

Example:

2.5

estimatedTax.itemsTaxes.rateType

string | null

Rate type

Example:

"rateType"

estimatedTax.itemsTaxes.rate

number<double> | null

Rate

Example:

10

estimatedTax.itemsTaxes.lineItemId

integer<int32> | null

Line item position (starts at 1)

Example:

1

estimatedTax.shipToTaxes

object[]

required

Show child attributes

estimatedTax.shipToTaxes.shipToId

string

required

Shipping detail identifier

Example:

"a1b26d22-cad2-6242-a2b4-e3c4282bad4"

estimatedTax.shipToTaxes.type

string | null

Tax type

Example:

"state_tax"

estimatedTax.shipToTaxes.amount

number<double> | null

Tax amount

Example:

2.5

estimatedTax.shipToTaxes.rateType

string | null

Rate type

Example:

"rateType"

estimatedTax.shipToTaxes.rate

number<double> | null

Rate

Example:

10

estimatedTax.feeTaxes

object[]

Show child attributes

estimatedTax.feeTaxes.feeId

string

required

Fee tax unique identifier

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

estimatedTax.feeTaxes.type

string | null

Tax type

Example:

"state_tax"

estimatedTax.feeTaxes.amount

number<double> | null

Tax amount

Example:

2.5

estimatedTax.feeTaxes.rateType

string | null

Rate type

Example:

"rateType"

estimatedTax.feeTaxes.rate

number<double> | null

Rate

Example:

10

orderNumber

string | null

Order number

Example:

123123123

orderSequence

object

Order sequence details

Show child attributes

orderSequence.sequenceName

string

required

Sequence module name

Example:

"ORDER_NUMBER_SEQUENCE"

orderSequence.sequenceKey

string | null

Sequence format or variant

Example:

"WHBM"

customer

object

Customer details

Show child attributes

customer.id

string | null

Customer ID

Example:

"8fb78749"

customer.type

string | null

Customer type

Example:

"employee"

customer.segments

string | null

Customer segments

Example:

"{subscription: ['premium']}"

customer.attributes

string | null

Customer attributes

Example:

"{email: [email protected]}"

orderType

string | null

Order type (WEB, CSC, MOBILE_APP, POS)

Example:

"WEB"

orderSubType

string | null

Order sub type (Android/IOS/International)

Example:

"Android"

Response

Order draft response

cartId

string

required

Cart ID

Example:

"b8a64b52-dab4-8137-8d6a-f2c2337abc1"

orderStatus

object

required

Show child attributes

orderStatus.paymentStatus

any

required

orderStatus.ready

boolean

default:false

true: Order draft is ready to generate the final order.
false: Order draft is not ready.

Example:

true

orderTotal

number<double>

required

Total amount for the order

Example:

60

orderSubTotal

number<double>

required

Total amount for the order without discounts

Example:

60

taxTotal

number<double>

required

Total tax applied on the order

Example:

60

orderDiscount

number<double>

required

Total discount applied on the order

Example:

60

currency

string

required

Currency code

Example:

"USD"

createdAt

string<date-time>

required

Time order draft was created

Example:

"2022-02-18T15:12:40.974580"

items

object[]

required

Show child attributes

items.itemId

string | null

required

Item ID

Example:

"1000000001"

items.sku

string

required

Item SKU

Example:

"16B2GS8LD5FDS"

items.items

object[]

required

Cart item details

Show child attributes

items.items.sku

string

required

Item SKU

Example:

"13B9CL6WT2SLW"

items.items.quantity

integer<int32>

required

total quantity of the line item

Example:

15

items.items.items

any[]

List of items in a cart

items.items.cartItemId

string | null

Cart item ID

Example:

"12gved0f-7645-40cb-y7b0-167f8bggdb3z"

items.items.itemId

string | null

Item ID

Example:

"1730902008"

items.items.title

string | null

Item name

Example:

"Light Cover"

items.items.attributes

object[] | null

Additional item options

Show child attributes

items.items.attributes.attributeId

string

required

Attribute ID

Example:

"60c2a358eb2ec30008ae70a1"

items.items.attributes.name

string

required

Attribute name

Example:

"gift wrapping (small)"

items.items.attributes.type

string

required

Attribute type

Example:

"GIFT"

items.items.attributes.price

number<float>

required

Attribute price

Example:

10

items.items.attributes.description

string | null

Attribute description

Example:

"Gift wrapping for a small package"

items.items.attributes.mapping

string | null

ITEM: Item-level attribute
ORDER: Cart-level attribute

Example:

"ITEM"

items.items.attributes.value

string | null

Attribute applicability

Example:

"true"

items.items.attributes.level

string | null

Attribute level

Example:

"order"

items.items.attributes.items

string[] | null

Discount object

items.items.createdAt

string<date-time> | null

Item creation time

Example:

"2022-02-18T15:12:40.974580"

items.items.updatedAt

string<date-time> | null

Last time item was updated

Example:

"2022-02-18T15:12:40.974580"

items.items.type

string | null

ItemType(WEB_SHIP/WEB_PICKUP/WEB_SDD/INTERNATIONAL/POS/POS_SHIP/POS_PICKUP)

Example:

"WEB_SHIP"

items.items.subType

string | null

ItemSubType(For International type, provide subType as Border-free)

Example:

"Border-free"

items.items.priceListId

string | null

Item price list ID

Example:

"108674"

items.items.lineItemId

integer<int32>

Cart item sequence number (starts at 1)

Required range: x >= 1

Example:

1

items.items.isActive

boolean

default:true

true = Item is active
false = Item is not active

Example:

true

items.items.unitPrice

object

Individual item price

Show child attributes

items.items.unitPrice.currency

string

default:USD

required

Currency type

Example:

"USD"

items.items.unitPrice.amount

number<double>

required

Price before discount

Example:

100

items.items.unitPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.items.unitPrice.discount.price

number<double>

required

Discounted price of the item

Required range: x >= 0

Example:

80

items.items.unitPrice.discount.promosApplied

object[]

required

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

items.items.unitPrice.discount.promosApplied.value

string | null

Promotion/coupon code discount value

Example:

"20"

items.items.unitPrice.discount.promosApplied.unit

string | null

Promotion/coupon code discount unit

Example:

"%OFF"

items.items.unitPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

Promotion name

Example:

"New Year discount"

items.items.unitPrice.discount.discounts.quantity

integer<int32> | null

Quantity of this item in the cart

Example:

1

items.items.unitPrice.discount.discounts.amount

number<double> | null

Total amount of discount applied

Example:

20

items.items.unitPrice.discount.discounts.value

number<double> | null

Promotion value

Example:

20

items.items.unitPrice.discount.discounts.groupId

string | null

Promotion group ID

Example:

"new-items"

items.items.unitPrice.discount.discounts.promotionType

string | null

Promotion type

Example:

"PROMOTION"

items.items.unitPrice.discount.discounts.priority

integer<int32> | null

Promotion priority

Example:

1

items.items.unitPrice.discount.discounts.stackable

boolean | null

true = This promotion is stackable with other promotions
false = This promotion cannot be stacked with other promotions

Example:

false

items.items.unitPrice.discount.discounts.sku

string | null

Item SKU to which promotion is applied

Example:

"16B2GS8LD5FDS"

items.items.unitPrice.discount.discounts.itemId

string | null

ID of item to which promotion is applied

Example:

"1000000001"

items.items.unitPrice.discount.discounts.itemKey

string | null

Key of item to which promotion is applied

Example:

"Key1234"

items.items.unitPrice.discount.discounts.message

string | null

Coupon code description

Example:

"New Year Promotion"

items.items.unitPrice.discount.discounts.unit

string | null

Discount unit

Example:

"%OFF"

items.items.unitPrice.discount.discounts.proratedQuantity

integer<int32> | null

The proratedQuantity is used in conjunction with proratedAmount to determine the discount portion allocated to the respective units of BuyGet promotions. This is applicable in partial return scenarios.

Example:

1

items.items.unitPrice.discount.discounts.proratedAmount

number<double> | null

The prorated discount amount.

Example:

3.33

items.items.unitPrice.discount.discountAmount

number<double>

Discounted percentage amount of the item

Required range: x >= 0

Example:

20

items.items.unitPrice.sale

number<double> | null

Price after discount

Example:

80

items.items.totalPrice

object

Total price for the full quantity of this item

Show child attributes

items.items.totalPrice.currency

string

default:USD

required

Currency type

Example:

"USD"

items.items.totalPrice.amount

number<double>

required

Price before discount

Example:

100

items.items.totalPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.items.totalPrice.discount.price

number<double>

required

Discounted price of the item

Required range: x >= 0

Example:

80

items.items.totalPrice.discount.promosApplied

object[]

required

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

items.items.totalPrice.discount.promosApplied.value

string | null

Promotion/coupon code discount value

Example:

"20"

items.items.totalPrice.discount.promosApplied.unit

string | null

Promotion/coupon code discount unit

Example:

"%OFF"

items.items.totalPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

Promotion name

Example:

"New Year discount"

items.items.totalPrice.discount.discounts.quantity

integer<int32> | null

Quantity of this item in the cart

Example:

1

items.items.totalPrice.discount.discounts.amount

number<double> | null

Total amount of discount applied

Example:

20

items.items.totalPrice.discount.discounts.value

number<double> | null

Promotion value

Example:

20

items.items.totalPrice.discount.discounts.groupId

string | null

Promotion group ID

Example:

"new-items"

items.items.totalPrice.discount.discounts.promotionType

string | null

Promotion type

Example:

"PROMOTION"

items.items.totalPrice.discount.discounts.priority

integer<int32> | null

Promotion priority

Example:

1

items.items.totalPrice.discount.discounts.stackable

boolean | null

true = This promotion is stackable with other promotions
false = This promotion cannot be stacked with other promotions

Example:

false

items.items.totalPrice.discount.discounts.sku

string | null

Item SKU to which promotion is applied

Example:

"16B2GS8LD5FDS"

items.items.totalPrice.discount.discounts.itemId

string | null

ID of item to which promotion is applied

Example:

"1000000001"

items.items.totalPrice.discount.discounts.itemKey

string | null

Key of item to which promotion is applied

Example:

"Key1234"

items.items.totalPrice.discount.discounts.message

string | null

Coupon code description

Example:

"New Year Promotion"

items.items.totalPrice.discount.discounts.unit

string | null

Discount unit

Example:

"%OFF"

items.items.totalPrice.discount.discounts.proratedQuantity

integer<int32> | null

Example:

1

items.items.totalPrice.discount.discounts.proratedAmount

number<double> | null

The prorated discount amount.

Example:

3.33

items.items.totalPrice.discount.discountAmount

number<double>

Discounted percentage amount of the item

Required range: x >= 0

Example:

20

items.items.totalPrice.sale

number<double> | null

Price after discount

Example:

80

items.items.attributeTotalPrice

number<double> | null

Total price of item attributes

Example:

10

items.items.group

string[] | null

Group or Category ID to which item belongs

items.items.extra

object

Extra metadata passed by caller

Example:

{ "productFamily": "Laptop computers" }

items.items.channel

number

Sales channel

Example:

12

items.items.isPickup

boolean

true: Item is set for pickup
false: Item is set for delivery

Example:

true

items.items.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

items.items.shipToId

string | null

Shipping ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

items.items.shipTo

object

Shipment details

Show child attributes

items.items.shipTo.shipToId

string | null

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

items.items.shipTo.cartId

string | null

Cart ID

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

items.items.shipTo.createdAt

string<date-time> | null

Shipping details creation time

Example:

"2022-02-18T15:12:40.974580"

items.items.shipTo.updatedAt

string<date-time> | null

Last time shipping details were updated

Example:

"2022-02-18T15:12:40.974580"

items.items.shipTo.shipMethod

object

Shipping method and details

Show child attributes

items.items.shipTo.shipMethod.cost

object

Shipping cost

Show child attributes

items.items.shipTo.shipMethod.cost.amount

number<double>

required

Shipping cost

Example:

10

items.items.shipTo.shipMethod.cost.currency

string | null

Currency type

Example:

"USD"

items.items.shipTo.shipMethod.cost.discount

number<double> | null

Shipping discount

Example:

5

items.items.shipTo.shipMethod.shipMethodId

string

Shipping method ID

Example:

"1234"

items.items.shipTo.shipMethod.shipmentCarrier

string | null

Shipment carrier

Example:

"FedEx"

items.items.shipTo.shipMethod.shipmentMethod

string | null

Shipment method type

Example:

"Next Day"

items.items.shipTo.address

object

Shipping address

Show child attributes

items.items.shipTo.address.attention

string | null

Address recipient

Example:

"Billing manager"

items.items.shipTo.address.street1

string | null

Address line 1

Example:

"100 NE 100th St."

items.items.shipTo.address.street2

string | null

Address line 2

Example:

"Suite 710"

items.items.shipTo.address.street3

string | null

Address line 3

Example:

"Seventh floor"

items.items.shipTo.address.street4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

items.items.shipTo.address.city

string | null

City name

Example:

"Seattle"

items.items.shipTo.address.state

string | null

State name

Example:

"Washington"

items.items.shipTo.address.country

string | null

Country name

Example:

"USA"

items.items.shipTo.address.zipCode

string | null

Zip code

Example:

"98125"

items.items.shipTo.address.email

string | null

Receiver's email address

Example:

"[email protected]"

items.items.shipTo.address.kind

string | null

Address type

Example:

"shipping"

items.items.shipTo.address.name

object

Recipient's name

Show child attributes

items.items.shipTo.address.name.first

string | null

Individual's first name

Example:

"Pat"

items.items.shipTo.address.name.middle

string | null

Individual's middle name or initial

Example:

"E"

items.items.shipTo.address.name.last

string | null

Individual's last name

Example:

"Kake"

items.items.shipTo.address.phone

object

address details for the shipping

Show child attributes

items.items.shipTo.address.phone.number

string

required

Phone number

Example:

"123-456-7899"

items.items.shipTo.address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

items.items.shipTo.shipToType

string | null

Shipping type

Example:

"SHIP_TO_ADDRESS"

items.items.shipTo.taxCode

string | null

Shipping tax code

Example:

"FR1000"

items.items.shipTo.isPickup

boolean

true = Item is set for pickup
false = Item is set for delivery

Example:

true

items.items.shipTo.altPickupPerson

object

Alternative pickup person

Show child attributes

items.items.shipTo.altPickupPerson.name

object

Name of pickup person

Show child attributes

items.items.shipTo.altPickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

items.items.shipTo.altPickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

items.items.shipTo.altPickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

items.items.shipTo.altPickupPerson.phone

object

Number of pickup person

Show child attributes

items.items.shipTo.altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

items.items.shipTo.altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

items.items.shipTo.altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

items.items.shipTo.pickupPerson

object

Designated pickup person

Show child attributes

items.items.shipTo.pickupPerson.name

object

Name of pickup person

Show child attributes

items.items.shipTo.pickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

items.items.shipTo.pickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

items.items.shipTo.pickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

items.items.shipTo.pickupPerson.phone

object

Number of pickup person

Show child attributes

items.items.shipTo.pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

items.items.shipTo.pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

items.items.shipTo.pickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

items.items.shipTo.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

items.items.shipTo.storeId

string | null

Store ID

Example:

"ABC-123"

items.items.fulfillment

object

Item details for order fulfillment

Show child attributes

items.items.fulfillment.type

string | null

Type of order fulfillment

Example:

"WEB_SHIP"

items.items.fulfillment.networkCode

string | null

Specifies the network of inventory for item

Example:

"ShipToCNC"

items.items.fulfillment.channelId

string | null

Specifies the channel of inventory for item

Example:

"12"

items.items.fulfillment.inventoryType

string | null

Specifies the type of inventory for item

Example:

"availablePreorder"

items.items.fulfillment.inventory

object

Inventory details of the cart item Inventory details of the cart item

Show child attributes

items.items.fulfillment.inventory.virtualCounters

object

View quantity of inventory, based on pre configured value. For example, 'availableToPurchase' can be a custom attribute configured by merchants.

Example:

{ "availableToPurchase": 10 }

items.items.fulfillment.inventory.id

string

Inventory ID

Example:

"62272e917b12209e68751d94"

items.items.fulfillment.inventory.sku

string

SKU of the item

Example:

"SKU00025"

items.items.fulfillment.inventory.itemId

integer<int64>

Item ID for which inventory is updated

Example:

4225678911

items.items.fulfillment.inventory.locationNum

integer<int32>

Location number is used to identify the warehouse or location where the inventory is kept

Example:

473746

items.items.fulfillment.inventory.channelId

string

Sales channel ID. This field is used to identify where the business operations are being held.

Example:

12

items.items.fulfillment.inventory.vendorId

string

Vendor ID

Example:

"vendor123"

items.items.fulfillment.inventory.leadTime

string

The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse

Example:

1234

items.items.fulfillment.inventory.inventoryType

string

Type of inventory

Example:

"Safety stock"

items.items.fulfillment.inventory.infiniteInventory

boolean

Infinite inventory flag.
true indicates that the inventory can be consumed any number of times as per need
false indicates that the inventory cannot be used infinitely, and has a limit to be consumed

Example:

true

items.items.fulfillment.inventory.counters

object

Inventory counter (also known as inventory position) configured by the merchant

Example:

{ "on-hand": 10 }

items.items.fulfillment.inventory.attributes

object

Custom inventory attributes configured by the merchant

Example:

{
  "buy online, pick up in-store (bopis)": true
}

items.items.fulfillment.inventory.backOrderDate

string<date-time>

Inventory restock date

Example:

"2022-08-08T00:00:00.000Z"

items.items.fulfillment.inventory.preOrderDate

string<date-time>

First ship date of inventory

Example:

"2022-08-08T00:00:00.000Z"

items.items.fulfillment.inventory.backOrderLimit

integer<int32>

Maximum restock inventory quantity

Example:

100

items.items.fulfillment.inventory.preOrderLimit

integer<int32>

Maximum quanity of inventory for first-ship

Example:

100

items.items.fulfillment.inventory.safetyStock

integer<int32>

Reserved inventory quantity at the location

Example:

10

items.items.fulfillment.inventory.lowStock

integer<int32>

Inventory quantity to mark as low stock at the location

Example:

10

items.items.fulfillment.inventory.segment

string

Inventory segment

Example:

"Clothing"

items.items.fulfillment.inventory.region

string

Region where inventory is managed

Example:

"US"

items.quantity

integer<int32>

required

Number of items in cart

Example:

1

items.lineItemId

integer<int32> | null

required

Cart item sequence number (starts at 1)

Required range: x >= 1

Example:

1

items.isPickup

boolean

required

true: Item is set for pickup
false: Item is set for delivery

Example:

true

items.cartItemId

string | null

Cart item ID

Example:

"88cded0f-1439-40eb-a7a0-167e8bffdb3b"

items.title

string | null

Item name

Example:

"Varnet Garden Light Kit"

items.attributeTotalPrice

number<double> | null

Total price of attributes

Example:

10

items.createdAt

string<date-time> | null

Item creation time

Example:

"2022-02-18T15:12:40.974580"

items.updatedAt

string<date-time> | null

Last time item was updated

Example:

"2022-02-18T15:12:40.974580"

items.priceListId

string | null

Item price list ID

Example:

"100000"

items.isActive

boolean | null

true = Item is active
false = Item is not active

Example:

true

items.unitPrice

object

Individual item price

Show child attributes

items.unitPrice.currency

string

default:USD

required

Currency type

Example:

"USD"

items.unitPrice.amount

number<double>

required

Price before discount

Example:

100

items.unitPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.unitPrice.discount.price

number<double>

required

Discounted price of the item

Required range: x >= 0

Example:

80

items.unitPrice.discount.promosApplied

object[]

required

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

items.unitPrice.discount.promosApplied.value

string | null

Promotion/coupon code discount value

Example:

"20"

items.unitPrice.discount.promosApplied.unit

string | null

Promotion/coupon code discount unit

Example:

"%OFF"

items.unitPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

Promotion name

Example:

"New Year discount"

items.unitPrice.discount.discounts.quantity

integer<int32> | null

Quantity of this item in the cart

Example:

1

items.unitPrice.discount.discounts.amount

number<double> | null

Total amount of discount applied

Example:

20

items.unitPrice.discount.discounts.value

number<double> | null

Promotion value

Example:

20

items.unitPrice.discount.discounts.groupId

string | null

Promotion group ID

Example:

"new-items"

items.unitPrice.discount.discounts.promotionType

string | null

Promotion type

Example:

"PROMOTION"

items.unitPrice.discount.discounts.priority

integer<int32> | null

Promotion priority

Example:

1

items.unitPrice.discount.discounts.stackable

boolean | null

true = This promotion is stackable with other promotions
false = This promotion cannot be stacked with other promotions

Example:

false

items.unitPrice.discount.discounts.sku

string | null

Item SKU to which promotion is applied

Example:

"16B2GS8LD5FDS"

items.unitPrice.discount.discounts.itemId

string | null

ID of item to which promotion is applied

Example:

"1000000001"

items.unitPrice.discount.discounts.itemKey

string | null

Key of item to which promotion is applied

Example:

"Key1234"

items.unitPrice.discount.discounts.message

string | null

Coupon code description

Example:

"New Year Promotion"

items.unitPrice.discount.discounts.unit

string | null

Discount unit

Example:

"%OFF"

items.unitPrice.discount.discounts.proratedQuantity

integer<int32> | null

Example:

1

items.unitPrice.discount.discounts.proratedAmount

number<double> | null

The prorated discount amount.

Example:

3.33

items.unitPrice.discount.discountAmount

number<double>

Discounted percentage amount of the item

Required range: x >= 0

Example:

20

items.unitPrice.sale

number<double> | null

Price after discount

Example:

80

items.totalPrice

object

Total price for the full quantity of this item

Show child attributes

items.totalPrice.currency

string

default:USD

required

Currency type

Example:

"USD"

items.totalPrice.amount

number<double>

required

Price before discount

Example:

100

items.totalPrice.discount

object

required

Offer discount details. Empty list {} should be passed in case of no discount.

Show child attributes

items.totalPrice.discount.price

number<double>

required

Discounted price of the item

Required range: x >= 0

Example:

80

items.totalPrice.discount.promosApplied

object[]

required

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

items.totalPrice.discount.promosApplied.value

string | null

Promotion/coupon code discount value

Example:

"20"

items.totalPrice.discount.promosApplied.unit

string | null

Promotion/coupon code discount unit

Example:

"%OFF"

items.totalPrice.discount.discounts

object[]

required

List of discounts applied

Show child attributes

Unique promotion/coupon ID

Example:

"fza065tdr787"

General promotion/coupon code

Example:

"coupon123"

Promotion name

Example:

"New Year discount"

items.totalPrice.discount.discounts.quantity

integer<int32> | null

Quantity of this item in the cart

Example:

1

items.totalPrice.discount.discounts.amount

number<double> | null

Total amount of discount applied

Example:

20

items.totalPrice.discount.discounts.value

number<double> | null

Promotion value

Example:

20

items.totalPrice.discount.discounts.groupId

string | null

Promotion group ID

Example:

"new-items"

items.totalPrice.discount.discounts.promotionType

string | null

Promotion type

Example:

"PROMOTION"

items.totalPrice.discount.discounts.priority

integer<int32> | null

Promotion priority

Example:

1

items.totalPrice.discount.discounts.stackable

boolean | null

true = This promotion is stackable with other promotions
false = This promotion cannot be stacked with other promotions

Example:

false

items.totalPrice.discount.discounts.sku

string | null

Item SKU to which promotion is applied

Example:

"16B2GS8LD5FDS"

items.totalPrice.discount.discounts.itemId

string | null

ID of item to which promotion is applied

Example:

"1000000001"

items.totalPrice.discount.discounts.itemKey

string | null

Key of item to which promotion is applied

Example:

"Key1234"

items.totalPrice.discount.discounts.message

string | null

Coupon code description

Example:

"New Year Promotion"

items.totalPrice.discount.discounts.unit

string | null

Discount unit

Example:

"%OFF"

items.totalPrice.discount.discounts.proratedQuantity

integer<int32> | null

Example:

1

items.totalPrice.discount.discounts.proratedAmount

number<double> | null

The prorated discount amount.

Example:

3.33

items.totalPrice.discount.discountAmount

number<double>

Discounted percentage amount of the item

Required range: x >= 0

Example:

20

items.totalPrice.sale

number<double> | null

Price after discount

Example:

80

items.attributes

object[] | null

Additional item options

Show child attributes

items.attributes.attributeId

string

required

Attribute ID

Example:

"60c2a358eb2ec30008ae70a1"

items.attributes.name

string

required

Attribute name

Example:

"gift wrapping (small)"

items.attributes.type

string

required

Attribute type

Example:

"GIFT"

items.attributes.price

number<float>

required

Attribute price

Example:

10

items.attributes.description

string | null

Attribute description

Example:

"Gift wrapping for a small package"

items.attributes.mapping

string | null

ITEM: Item-level attribute
ORDER: Cart-level attribute

Example:

"ITEM"

items.attributes.value

string | null

Attribute applicability

Example:

"true"

items.attributes.level

string | null

Attribute level

Example:

"order"

items.attributes.items

string[] | null

Discount object

items.priceAdjustments

object[] | null

List of price adjustments for the line item

Show child attributes

items.priceAdjustments.id

string

required

Price adjustment ID; it identifies a single price adjustment object from the list of price adjustments.

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

items.priceAdjustments.reason

string

required

Price adjustment reason

Example:

"compensation for delay"

items.priceAdjustments.amount

number<double>

required

Amount by which the line item's total amount or the specified cart's total amount is adjusted

Required range: x >= 0

Example:

20

items.priceAdjustments.attributes

object

Placeholder for additional information

Example:

{ "goldMember": [false] }

items.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

items.shipTo

object

Shipment details

Show child attributes

items.shipTo.shipToId

string | null

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

items.shipTo.cartId

string | null

Cart ID

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

items.shipTo.createdAt

string<date-time> | null

Shipping details creation time

Example:

"2022-02-18T15:12:40.974580"

items.shipTo.updatedAt

string<date-time> | null

Last time shipping details were updated

Example:

"2022-02-18T15:12:40.974580"

items.shipTo.shipMethod

object

Shipping method and details

Show child attributes

items.shipTo.shipMethod.cost

object

Shipping cost

Show child attributes

items.shipTo.shipMethod.cost.amount

number<double>

required

Shipping cost

Example:

10

items.shipTo.shipMethod.cost.currency

string | null

Currency type

Example:

"USD"

items.shipTo.shipMethod.cost.discount

number<double> | null

Shipping discount

Example:

5

items.shipTo.shipMethod.shipMethodId

string

Shipping method ID

Example:

"1234"

items.shipTo.shipMethod.shipmentCarrier

string | null

Shipment carrier

Example:

"FedEx"

items.shipTo.shipMethod.shipmentMethod

string | null

Shipment method type

Example:

"Next Day"

items.shipTo.address

object

Shipping address

Show child attributes

items.shipTo.address.attention

string | null

Address recipient

Example:

"Billing manager"

items.shipTo.address.street1

string | null

Address line 1

Example:

"100 NE 100th St."

items.shipTo.address.street2

string | null

Address line 2

Example:

"Suite 710"

items.shipTo.address.street3

string | null

Address line 3

Example:

"Seventh floor"

items.shipTo.address.street4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

items.shipTo.address.city

string | null

City name

Example:

"Seattle"

items.shipTo.address.state

string | null

State name

Example:

"Washington"

items.shipTo.address.country

string | null

Country name

Example:

"USA"

items.shipTo.address.zipCode

string | null

Zip code

Example:

"98125"

items.shipTo.address.email

string | null

Receiver's email address

Example:

"[email protected]"

items.shipTo.address.kind

string | null

Address type

Example:

"shipping"

items.shipTo.address.name

object

Recipient's name

Show child attributes

items.shipTo.address.name.first

string | null

Individual's first name

Example:

"Pat"

items.shipTo.address.name.middle

string | null

Individual's middle name or initial

Example:

"E"

items.shipTo.address.name.last

string | null

Individual's last name

Example:

"Kake"

items.shipTo.address.phone

object

address details for the shipping

Show child attributes

items.shipTo.address.phone.number

string

required

Phone number

Example:

"123-456-7899"

items.shipTo.address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

items.shipTo.shipToType

string | null

Shipping type

Example:

"SHIP_TO_ADDRESS"

items.shipTo.taxCode

string | null

Shipping tax code

Example:

"FR1000"

items.shipTo.isPickup

boolean

true = Item is set for pickup
false = Item is set for delivery

Example:

true

items.shipTo.altPickupPerson

object

Alternative pickup person

Show child attributes

items.shipTo.altPickupPerson.name

object

Name of pickup person

Show child attributes

items.shipTo.altPickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

items.shipTo.altPickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

items.shipTo.altPickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

items.shipTo.altPickupPerson.phone

object

Number of pickup person

Show child attributes

items.shipTo.altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

items.shipTo.altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

items.shipTo.altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

items.shipTo.pickupPerson

object

Designated pickup person

Show child attributes

items.shipTo.pickupPerson.name

object

Name of pickup person

Show child attributes

items.shipTo.pickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

items.shipTo.pickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

items.shipTo.pickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

items.shipTo.pickupPerson.phone

object

Number of pickup person

Show child attributes

items.shipTo.pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

items.shipTo.pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

items.shipTo.pickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

items.shipTo.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

items.shipTo.storeId

string | null

Store ID

Example:

"ABC-123"

items.channel

number | null

Sales channel

Example:

12

items.group

string[] | null

Group or Category ID to which item belongs

items.fees

object[] | null

Fees associated with a specific cart or an individual line item of a cart

Show child attributes

items.fees.feeId

string

System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.

Example:

"73bc09d0-874a-4c3d-84d0-df1670d03578"

items.fees.name

string | null

Attribute for which fee is applied

Example:

"gift"

items.fees.type

string | null

Fee type

Example:

"gift_wrap"

items.fees.amount

number<double>

default:0

Fee amount

Example:

10.5

items.fees.attributes

object

Placeholder for additional information in key:value pairs

Example:

"{'from': 'sam', 'to': 'david' }"

items.type

string | null

ItemType(WEB_SHIP/WEB_PICKUP/WEB_SDD/INTERNATIONAL/POS/POS_SHIP/POS_PICKUP)

Example:

"WEB_SHIP"

items.subType

string | null

Item sub type. For International type, provide subType as Borderfree.

Example:

"Borderfree"

items.uom

string | null

Unit Of measure

Example:

"ITEM"

items.itemTaxTotal

number<double> | null

Total tax on item

items.taxCode

string | null

Tax code for an item

Example:

"FR1000"

items.taxDetail

object

Item tax details

Show child attributes

items.taxDetail.type

string | null

Tax type

Example:

"state_tax"

items.taxDetail.amount

number<double> | null

Tax amount

Example:

2.5

items.taxDetail.rateType

string | null

Rate type

Example:

"rateType"

items.taxDetail.rate

number<double> | null

Rate

Example:

10

shipInfo

object[]

required

Show child attributes

shipInfo.shipToId

string | null

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

shipInfo.cartId

string | null

Cart ID

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

shipInfo.createdAt

string<date-time> | null

Shipping details creation time

Example:

"2022-02-18T15:12:40.974580"

shipInfo.updatedAt

string<date-time> | null

Last time shipping details were updated

Example:

"2022-02-18T15:12:40.974580"

shipInfo.shipMethod

object

Shipping method and details

Show child attributes

shipInfo.shipMethod.cost

object

Shipping cost

Show child attributes

shipInfo.shipMethod.cost.amount

number<double>

required

Shipping cost

Example:

10

shipInfo.shipMethod.cost.currency

string | null

Currency type

Example:

"USD"

shipInfo.shipMethod.cost.discount

number<double> | null

Shipping discount

Example:

5

shipInfo.shipMethod.shipMethodId

string

Shipping method ID

Example:

"1234"

shipInfo.shipMethod.shipmentCarrier

string | null

Shipment carrier

Example:

"FedEx"

shipInfo.shipMethod.shipmentMethod

string | null

Shipment method type

Example:

"Next Day"

shipInfo.address

object

Shipping address

Show child attributes

shipInfo.address.attention

string | null

Address recipient

Example:

"Billing manager"

shipInfo.address.street1

string | null

Address line 1

Example:

"100 NE 100th St."

shipInfo.address.street2

string | null

Address line 2

Example:

"Suite 710"

shipInfo.address.street3

string | null

Address line 3

Example:

"Seventh floor"

shipInfo.address.street4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

shipInfo.address.city

string | null

City name

Example:

"Seattle"

shipInfo.address.state

string | null

State name

Example:

"Washington"

shipInfo.address.country

string | null

Country name

Example:

"USA"

shipInfo.address.zipCode

string | null

Zip code

Example:

"98125"

shipInfo.address.email

string | null

Receiver's email address

Example:

"[email protected]"

shipInfo.address.kind

string | null

Address type

Example:

"shipping"

shipInfo.address.name

object

Recipient's name

Show child attributes

shipInfo.address.name.first

string | null

Individual's first name

Example:

"Pat"

shipInfo.address.name.middle

string | null

Individual's middle name or initial

Example:

"E"

shipInfo.address.name.last

string | null

Individual's last name

Example:

"Kake"

shipInfo.address.phone

object

address details for the shipping

Show child attributes

shipInfo.address.phone.number

string

required

Phone number

Example:

"123-456-7899"

shipInfo.address.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.shipToType

string | null

Shipping type

Example:

"SHIP_TO_ADDRESS"

shipInfo.taxCode

string | null

Shipping tax code

Example:

"FR1000"

shipInfo.isPickup

boolean

true: Item is set for pickup
false: Item is set for delivery

Example:

true

shipInfo.altPickupPerson

object

Alternative pickup person

Show child attributes

shipInfo.altPickupPerson.name

object

Name of pickup person

Show child attributes

shipInfo.altPickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

shipInfo.altPickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

shipInfo.altPickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

shipInfo.altPickupPerson.phone

object

Number of pickup person

Show child attributes

shipInfo.altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

shipInfo.altPickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.altPickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

shipInfo.pickupPerson

object

Designated pickup person

Show child attributes

shipInfo.pickupPerson.name

object

Name of pickup person

Show child attributes

shipInfo.pickupPerson.name.first

string | null

Individual's first name

Example:

"Pat"

shipInfo.pickupPerson.name.middle

string | null

Individual's middle name or initial

Example:

"E"

shipInfo.pickupPerson.name.last

string | null

Individual's last name

Example:

"Kake"

shipInfo.pickupPerson.phone

object

Number of pickup person

Show child attributes

shipInfo.pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

shipInfo.pickupPerson.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipInfo.pickupPerson.email

string | null

Receiver's email address

Example:

"[email protected]"

shipInfo.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

shipInfo.storeId

string | null

Store ID

Example:

"ABC-123"

shipInfo.estimatedShipDate

string<date-time> | null

Estimated date for shipping

Example:

"2022-02-18T15:12:40.974580"

shipInfo.estimatedDeliveryDate

string<date-time> | null

Estimated date for delivery

Example:

"2022-02-18T15:12:40.974580"

shipInfo.shipmentInstructions

string | null

Store ID

Example:

"Additional user instructions for shipping"

orderNumber

string | null

Order number

Example:

123123123

orderType

string | null

Order type (WEB, CSC, MOBILE_APP, POS)

Example:

"WEB"

orderSubType

string | null

Order sub type (Android/IOS/International)

Example:

"Android"

customer

object

Customer details

Show child attributes

customer.id

string | null

Customer ID

Example:

"8fb78749"

customer.type

string | null

Customer type

Example:

"employee"

customer.segments

string | null

Customer segments

Example:

"{subscription: ['premium']}"

customer.attributes

string | null

Customer attributes

Example:

"{email: [email protected]}"

attributes

object

Cart metadata

Example:

{ "approver": "620d8896058edb0009385311" }

payments

object[] | null

Show child attributes

payments.connectorName

string

required

Payment connector name

Example:

"Authorizenet"

payments.paymentToken

string

required

Payment token identifier

Example:

534234543

payments.amount

number<double> | null

required

Payment amount

Example:

10.5

payments.currency

string

required

Currency code

Example:

"USD"

payments.conversion

number<double>

default:1

required

Currency Conversion (For USD = 1, For Non-USD = conversion ratio to USD)

Example:

0.5

payments.billToAddress

object

required

Billing address details Billing address for the order

Show child attributes

payments.billToAddress.street1

string

required

Address line 1

Example:

"100 NE 100th St."

payments.billToAddress.city

string

required

City name

Example:

"Seattle"

payments.billToAddress.state

string

required

State name

Example:

"Washington"

payments.billToAddress.country

string

required

Country name

Example:

"USA"

payments.billToAddress.postalCode

string

required

Postal code

Example:

"98125"

payments.billToAddress.customerId

string

required

Customer ID created for payment instruction

Example:

98121

payments.billToAddress.name

object

Recipient's name

Show child attributes

payments.billToAddress.name.first

string | null

Individual's first name

Example:

"Pat"

payments.billToAddress.name.middle

string | null

Individual's middle name or initial

Example:

"E"

payments.billToAddress.name.last

string | null

Individual's last name

Example:

"Kake"

payments.billToAddress.phone

object

Recipient's phone number details

Show child attributes

payments.billToAddress.phone.number

string

required

Phone number

Example:

"123-456-7899"

payments.billToAddress.phone.kind

enum<string> | null

Phone number type

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

payments.billToAddress.email

string | null

Receiver's email address

Example:

"[email protected]"

payments.billToAddress.street2

string | null

Address line 2

Example:

"Suite 710"

payments.billToAddress.street3

string | null

Address line 3

Example:

"Seventh floor"

payments.billToAddress.street4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

payments.billToAddress.type

string | null

Address type

Example:

"Residence"

payments.billToAddress.latitude

number | null

Latitude

Example:

35.294952

payments.billToAddress.longitude

number | null

Longitude

Example:

32.294952

payments.paymentMethod

string | null

Payment method

Example:

"card"

payments.paymentMethodType

string | null

Payment method type

Example:

"tamara or tabby"

payments.attributes

object

Payment Attributes

Example:

{ "Attribute1": "620d8896058edb0009385311" }

accountId

string | null

Customer account ID

Example:

"5f689caa4216e7000750d1ef"

totalItems

integer<int32> | null

Total number of items in the cart

Example:

3

totalUniqueItems

integer<int32> | null

Total number of unique line items in the cart

Example:

2

configuration

object

Cart configuration

Show child attributes

configuration.allowAnonymousUser

boolean | null

default:true

true: Allows a cart to be a guest cart.
false: Allows cart only if user is logged in.

Example:

true

configuration.orderNumberSource

enum<string>

Determines how an order number is created

Available options:

CART_ID,

FABRIC,

EXTERNAL,

NONE

configuration.softReserve

boolean | null

default:false

true: Soft reserve is used for an inventory check.
false: Soft reserve is not used for an inventory check.

Example:

false

configuration.addItemBySku

boolean

default:false

true: Item can be added to cart by SKU; itemId is not mandatory to add an item to cart
false: itemId is mandatory to add item to cart

Example:

false

configuration.inventory

object

Show child attributes

configuration.inventory.source

enum<string>

Source of an order number

Available options:

FABRIC,

EXTERNAL,

NONE

configuration.inventory.ttl

integer<int32> | null

Expiry time in seconds

Example:

60

configuration.inventory.newItemBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

configuration.inventory.updateItemBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

configuration.inventory.viewItemBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

configuration.inventory.expiredDataBehaviour

enum<string>

Cart configurations used to determine behavior of cart.

Available options:

BLOCK,

WARN,

DROP,

NONE

fees

object[] | null

Fees associated with a specific cart or an individual line item of a cart

Show child attributes

fees.feeId

string

System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.

Example:

"73bc09d0-874a-4c3d-84d0-df1670d03578"

fees.name

string | null

Attribute for which fee is applied

Example:

"gift"

fees.type

string | null

Fee type

Example:

"gift_wrap"

fees.amount

number<double>

default:0

Fee amount

Example:

10.5

fees.attributes

object

Placeholder for additional information in key:value pairs

Example:

"{'from': 'sam', 'to': 'david' }"

orderTotalFees

number<double> | null

Total fees applied on the order

Example:

60

error

object

Exception details error object

Show child attributes

error.code

enum<string>

required

Error code

Available options:

UNKNOWN_ERROR,

BAD_REQUEST,

INVALID_TOKEN,

ACCOUNT_ID_NOT_CONFIGURED,

ACCOUNT_ID_ALREADY_EXISTS,

DEPLOYMENT_IN_PROGRESS,

INVALID_CART_ID,

CART_NOT_FOUND,

ITEM_NOT_FOUND,

UNABLE_TO_GET_CART,

UNABLE_TO_GET_INVENTORY,

ITEM_OUT_OF_STOCK,

UPDATE_CART_ERROR,

DELETE_CART_ATTRIBUTE_ERROR,

EMPTY_CART_ERROR,

UNABLE_TO_GET_PRICE,

UNABLE_TO_GET_PROMO,

UNABLE_TO_GET_ITEM,

PROMO_ALREADY_APPLIED_ERROR,

CART_ALREADY_SHARED_ERROR,

PROMO_NOT_FOUND_ERROR,

PROMO_NOT_APPLICABLE_ERROR,

USER_NOT_FOUND,

ATTRIBUTE_NOT_FOUND,

INCORRECT_ATTRIBUTE_LEVEL,

INCORRECT_ATTRIBUTE_VALUE,

ITEM_ATTRIBUTE_ALREADY_EXIST,

LINE_ITEM_ID_NOT_FOUND,

ITEM_ID_NOT_APPLICABLE,

CART_STATUS_NOT_FOUND,

CART_STATUS_CANNOT_BE_UPDATED,

GUEST_CART_STATUS_CANNOT_BE_UPDATED,

CART_STATUS_ALREADY_ASSIGNED,

TOKEN_INTROSPECT_ERROR,

MAX_CARTS_LIMIT_REACHED,

UNAUTHORIZED_USER_ERROR,

API_PERMISSION_UNDEFINED,

INVALID_DATE_RANGE,

INVALID_DATE_FORMAT,

INVALID_SEARCH_ATTRIBUTE,

ITEM_SERVICE_NOT_CONFIGURED,

ATTRIBUTE_SERVICE_NOT_CONFIGURED,

SHIP_ID_NOT_FOUND,

NEGATIVE_SHIPPING_COST,

REQUEST_DENIED,

BAD_CONFIGURATION,

SERVICE_NOT_ENABLED

error.detail

string

required

Error detail

Example:

"Item is out of stock"

error.itemId

string | null

ID of item to which exception applies

Example:

"1000000001"

error.sku

string | null

SKU of item to which exception applies

Example:

"16B2GS8LD5FDS"

error.lineItemId

integer<int32>

Cart item sequence number (starts at 1)

Required range: x >= 1

Example:

1

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Create order draft

Headers

Path Parameters

Body

Response