Create a cart

Create a cart with items.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Body

application/json

Request body for creating and adding items to the cart

Line items (with details) to add to cart

name

string | null

Cart name

Example:

"cart_it"

description

string | null

Cart description

Example:

"IT department cart"

lineItems

object[] | null

Line items to add to cart

Line items to add to cart

Show child attributes

lineItems.itemId

any

required

lineItems.quantity

integer

required

Number of line items in cart

Example:

1

lineItems.sku

string | null

Item SKU

Example:

"16B2GS8LD5FDS"

lineItems.priceListId

integer | null

Item price list ID

Example:

100000

lineItems.attributes

object | null

Additional data passed by the caller

Show child attributes

lineItems.attributes.{key}

Example:

{ "productFamily": "Laptop computers" }

lineItems.fulfillment

object | null

Fulfillment request details

Show child attributes

lineItems.fulfillment.type

string | null

Fulfillment type

Example:

"WEB_SDD"

lineItems.fulfillment.networkCode

string | null

Inventory network code

Example:

"ShipToHome"

lineItems.fulfillment.channelId

string

Sales channel

Example:

"12"

lineItems.fulfillment.inventoryType

string

default:

availableToPurchase

Inventory type - a classifier attribute that provides flexibility to define inventory types

Example:

"availableToPurchase"

lineItems.fees

object[] | null

Show child attributes

lineItems.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"

lineItems.fees.name

string | null

Attribute for which fee is applied

Example:

"gift"

lineItems.fees.type

string | null

Fee type

Example:

"gift_wrap"

lineItems.fees.amount

number

default:

0

Fee amount

Example:

10.5

lineItems.fees.attributes

object | null

Placeholder for additional information in key:value pairs

Show child attributes

lineItems.fees.attributes.{key}

Example:

{ "from": "sam" }

configuration

object

Cart configurations

Show child attributes

configuration.allowAnonymousUser

boolean

default:

true

true: Cart can be a guest cart, allowing users to configure a cart without logging in <br/> false: User must log in to configure a cart

configuration.orderNumberSource

enum<string>

default:

CART_ID

Determines the order number <br/> CART_ID - Use cartId as orderNumber <br/> FABRIC - Represents the option of allowing the merchant to configure the order number by adding a prefix, sequenceKey, or other identifier to the fabric-generated order number. <br/> EXTERNAL - Represents the option of allowing the tenant or customer to provide a custom order number, which can align with their own internal systems or processes <br/> NONE - order number isn't required for checkout

Available options:

CART_ID,

FABRIC,

EXTERNAL,

NONE

configuration.isSoftReservationEnabled

boolean

default:

false

true: Soft reservation is enabled. When shoppers add items to cart, fabric reserves the items in inventory. <br/> false: fabric doesn't reserve the items when added to cart.

configuration.orderSequence

object

Show child attributes

configuration.orderSequence.sequenceName

string

required

Order Sequence module name

Example:

"ORDER_NUMBER"

configuration.orderSequence.sequenceKey

string | null

Order sequence format or variant

Example:

"LOCATE"

configuration.orderNumberGeneration

enum<string>

default:

NONE

Determines the order number generation enum <br/> AUTO - Fabric will automatically generate an order number and use it during checkout <br/> MANUAL - order number is required to be passed in to the cart journey using addOrderNumber endpoint <br/> NONE - order number isn't required for checkout.

Available options:

AUTO,

MANUAL,

NONE

customerContext

object

Customer context

Show child attributes

customerContext.id

string | null

Identifies a customer

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

customerContext.type

string | null

Customer type

Example:

"EMPLOYEE"

customerContext.attributes

object | null

Customer attributes

Show child attributes

customerContext.attributes.{key}

Example:

{ "isAdmin": false }

customerContext.segments

object[] | null

The segments to which the shopper or customer belong.

The segments to which the user belong.

Show child attributes

customerContext.segments.name

string

The segment name.

Example:

"category"

customerContext.segments.value

string[]

The segment values.

Response

201

application/json

Created

id

string | null

Unique cart identifier

Example:

"c695af14-5e33-402c-9d8d-71edcf4856a8"

createdAt

string

Time cart was created

Example:

"2022-09-06T14:07:17.000Z"

updatedAt

string

Time cart was last updated

Example:

"2022-09-06T14:07:17.000Z"

name

string | null

Cart name

Example:

"cart_it"

description

string | null

Cart description

Example:

"IT department cart"

lineItems

object[]

Line item details

Show child attributes

lineItems.id

string | null

Line item ID

Example:

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

lineItems.itemId

any

lineItems.position

integer

Line item position number (starts at 1)

Required range: x >= 1

Example:

1

lineItems.name

string | null

Line item name

Example:

"Varnet Garden Light Kit"

lineItems.sku

string

Line item SKU

Example:

"16B2GS8LD5FDS"

lineItems.productAttributes

object[] | null

Additional line item options

Product attribute as defined within Product Catalog.

Show child attributes

lineItems.productAttributes.name

string

required

Attribute name

Example:

"gift wrapping (small)"

lineItems.productAttributes.value

string | null

required

Attribute value

Example:

"true"

lineItems.productAttributes.attributeId

string

Attribute ID

Example:

"60c2a358eb2ec30008ae70a1"

lineItems.productAttributes.description

string | null

Attribute description

Example:

"Gift wrapping for a small package"

lineItems.productAttributes.mapping

string | null

Attribute mapping

Example:

"ITEM"

lineItems.productAttributes.type

string | null

Attribute type

Example:

"GIFT"

lineItems.productAttributes.price

number | null

Attribute price

Example:

10

lineItems.productAttributes.level

string | null

Attribute level

Example:

"order"

lineItems.createdAt

string

Time line item was created

Example:

"2022-09-06T14:07:17.000Z"

lineItems.updatedAt

string

Time line item was last updated

Example:

"2022-09-06T14:07:17.000Z"

lineItems.quantity

integer

Line item quantity

Example:

15

lineItems.priceListId

integer | null

Line item price list ID

Example:

108674

lineItems.isActive

boolean | null

true: Item is active<br />false: Item is inactive

Example:

true

lineItems.price

any | null

Individual line item price

lineItems.discounts

any[]

Individual line item discount

lineItems.groups

string[] | null

Group or category ID to which line item belongs

lineItems.attributes

object | null

Attributes passed by caller

Show child attributes

lineItems.attributes.{key}

Example:

{ "productFamily": "Laptop computers" }

lineItems.channel

string

Sales channel

Example:

"12"

lineItems.isPickup

boolean

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

Example:

true

lineItems.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

lineItems.shippingDetails

object

Shipping details

Show child attributes

lineItems.shippingDetails.id

string

Shipping details ID

Example:

"fef78121-bee3-4448-bf1c-d5b5461dbda2"

lineItems.shippingDetails.createdAt

string

Time shipping detail was created

Example:

"2022-09-06T14:07:17.000Z"

lineItems.shippingDetails.updatedAt

string

Time shipping detail was last updated

Example:

"2022-09-06T14:07:17.000Z"

lineItems.shippingDetails.address

object

Shipping address

Show child attributes

lineItems.shippingDetails.address.addressLine1

string

required

Address line 1

Example:

"123 Main St."

lineItems.shippingDetails.address.city

string

required

City

Example:

"Seattle"

lineItems.shippingDetails.address.region

string

required

Region or state

Example:

"WA"

lineItems.shippingDetails.address.country

string

required

Country (can be full name, or ISO 3166-1 alpha-2 or alpha-3 code)

Example:

"USA"

lineItems.shippingDetails.address.postalCode

string

required

Postal or ZIP code

Example:

"98121"

lineItems.shippingDetails.address.addressLine2

string | null

Address line 2

Example:

"Suite 100"

lineItems.shippingDetails.address.addressLine3

string | null

Address line 3

Example:

"Seventh floor"

lineItems.shippingDetails.address.addressLine4

string | null

Address line 4

Example:

"Attention: Pat E. Kake"

lineItems.shippingDetails.address.attention

string | null

Address recipient

Example:

"Billing manager"

lineItems.shippingDetails.address.email

string | null

Receiver's email address

Example:

"[e-mail]"

lineItems.shippingDetails.address.type

string | null

Address type

Example:

"shipping"

lineItems.shippingDetails.address.name

string

Recipient's name

Example:

"Pat E Kake"

lineItems.shippingDetails.address.phone

object

Recipient's phone number and type

Show child attributes

lineItems.shippingDetails.address.phone.number

string

required

Phone number

Example:

"123-456-7899"

lineItems.shippingDetails.address.phone.type

string | null

Phone type

Example:

"MOBILE"

lineItems.shippingDetails.type

string

Shipping type

Example:

"SHIP_TO_ADDRESS"

lineItems.shippingDetails.taxCode

string | null

Shipping tax code

Example:

"FR1000"

lineItems.shippingDetails.isPickup

boolean

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

Example:

true

lineItems.shippingDetails.altPickupPerson

object

Alternative pickup person

Show child attributes

lineItems.shippingDetails.altPickupPerson.name

string

Person's full name

Example:

"Pat E Kake"

lineItems.shippingDetails.altPickupPerson.phone

object

Phone number details

Show child attributes

lineItems.shippingDetails.altPickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

lineItems.shippingDetails.altPickupPerson.phone.type

string | null

Phone type

Example:

"MOBILE"

lineItems.shippingDetails.altPickupPerson.email

string | null

Receiver's email address

Example:

"[e-mail]"

lineItems.shippingDetails.pickupPerson

object

Designated pickup person

Show child attributes

lineItems.shippingDetails.pickupPerson.name

string

Person's full name

Example:

"Pat E Kake"

lineItems.shippingDetails.pickupPerson.phone

object

Phone number details

Show child attributes

lineItems.shippingDetails.pickupPerson.phone.number

string

required

Phone number

Example:

"123-456-7899"

lineItems.shippingDetails.pickupPerson.phone.type

string | null

Phone type

Example:

"MOBILE"

lineItems.shippingDetails.pickupPerson.email

string | null

Receiver's email address

Example:

"[e-mail]"

lineItems.shippingDetails.warehouseId

string | null

Warehouse ID

Example:

"XYZ-1234"

lineItems.shippingDetails.storeId

string | null

Store ID

Example:

"ABC-123"

lineItems.shippingDetails.shippingCost

number

Shipping cost

Example:

150.25

lineItems.shippingDetails.shippingMethodId

string

Shipping method ID

Example:

"dfsae-2d32113-32lpdd"

lineItems.shippingDetails.shippingDiscount

number

Discount amount

Example:

150.25

lineItems.shippingDetails.shippingMethodName

string | null

Shipping method name

Example:

"Express Delivery"

lineItems.fulfillment

object | null

Fulfillment details

Show child attributes

lineItems.fulfillment.type

string | null

Fulfillment type

Example:

"WEB_SDD"

lineItems.fulfillment.networkCode

string | null

Inventory network code

Example:

"ShipToHome"

lineItems.fulfillment.channelId

string

Sales channel

Example:

"12"

lineItems.fulfillment.inventoryType

string

default:

availableToPurchase

Inventory type - a classifier attribute that provides flexibility to define inventory types

Example:

"availableToPurchase"

lineItems.fulfillment.inventory

object | null

The inventory response.

Show child attributes

lineItems.fulfillment.inventory.inventoryId

string

System-generated inventory ID. This ID is generated during inventory creation.

Example:

"723910d81723"

lineItems.fulfillment.inventory.sku

string

Product SKU (Stock Keeping Unit) identifier. It serves as the primary reference key for the inventory and provides uniqueness to the item.

Example:

"SKU1"

lineItems.fulfillment.inventory.itemId

integer

Merchant-defined item ID whose inventory is created or updated. If omitted, fabric Inventory service generates the itemId. If you choose to use the itemId in your environment, you must include it in all inventory Write requests.

Example:

12345

lineItems.fulfillment.inventory.locationNumber

integer

Represents the warehouse or store location where the inventory is stored. It's recommended to link locationNumber to the corresponding value in the fabric Locations service.

Example:

12345

lineItems.fulfillment.inventory.region

string

Region where inventory is managed

Example:

"North America"

lineItems.fulfillment.inventory.channelId

string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.; identifies business operations location.

Example:

"channel_xyz"

lineItems.fulfillment.inventory.vendorId

string

ID of the vendor who will replenish the inventory for the retailer

Example:

"vendor1"

lineItems.fulfillment.inventory.createdAt

string

Time of inventory creation

Example:

"2022-08-01T18:03:28.483971941Z"

lineItems.fulfillment.inventory.updatedAt

string

Time when inventory was last updated

Example:

"2022-08-01T20:03:28.483971941Z"

lineItems.fulfillment.inventory.leadTime

string

Time between when an order is placed to replenish inventory and when the order is received at warehouse

Example:

"5 days"

lineItems.fulfillment.inventory.type

string

Inventory type - a classifier attribute that provides flexibility to define inventory types

Example:

"primary"

lineItems.fulfillment.inventory.hasInfiniteInventory

boolean

default:

false

Infinite inventory flag.<br />true: Inventory can be used any number of times and doesn't have any consumption limit.<br />false: Inventory can't be used infinitely, and has a consumption limit.

Example:

false

lineItems.fulfillment.inventory.backorderShipmentAt

string

Time when backorder is shipped

Example:

"2022-08-01T20:03:28.483971941Z"

lineItems.fulfillment.inventory.preorderShipmentAt

string

Time when preorder is shipped

Example:

"2022-08-01T20:03:28.483971941Z"

lineItems.fulfillment.inventory.backorderLimit

integer

Maximum restock inventory quantity

Example:

50

lineItems.fulfillment.inventory.preorderLimit

integer

Maximum first-shipping inventory quantity

Example:

40

lineItems.fulfillment.inventory.safetyStock

integer

Reserved inventory quantity at the location

Example:

10

lineItems.fulfillment.inventory.lowStock

integer

Inventory quantity below which consumer service wants to be alerted as low stock at the location

Example:

10

lineItems.fulfillment.inventory.networkCode

string

Code of the network to which the inventory belongs

Example:

"ShipToHome"

lineItems.fulfillment.inventory.counters

object

Merchant-defined inventory counter (also known as inventory position)

Show child attributes

lineItems.fulfillment.inventory.counters.{key}

integer

Merchant-defined inventory counter (also known as inventory position)

Example:

{
  "onHand": 100,
  "allocated": 10,
  "shipped": 20
}

lineItems.fulfillment.inventory.customAttributes

object

Placeholder for additional info

Show child attributes

lineItems.fulfillment.inventory.customAttributes.{key}

string

Placeholder for additional info

Example:

"{\"isBopis\":true}"

Example:

{ "isBopis": true }

lineItems.fulfillment.inventory.networkCounters

object

Indicates inventory positions at network

Show child attributes

lineItems.fulfillment.inventory.networkCounters.{key}

integer

Indicates inventory positions at network

Example:

{ "softReserve": 10 }

lineItems.fulfillment.inventory.virtualCounters

object

Virtual counters are calculated at run time from counters

Show child attributes

lineItems.fulfillment.inventory.virtualCounters.{key}

integer

Virtual counters are calculated at run time from counters

Example:

{ "availableToPurchase": 60 }

lineItems.fees

object[] | null

Show child attributes

lineItems.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"

lineItems.fees.name

string | null

Attribute for which fee is applied

Example:

"gift"

lineItems.fees.type

string | null

Fee type

Example:

"gift_wrap"

lineItems.fees.amount

number

default:

0

Fee amount

Example:

10.5

lineItems.fees.attributes

object | null

Placeholder for additional information in key:value pairs

Show child attributes

lineItems.fees.attributes.{key}

Example:

{ "from": "sam" }

lineItems.adjustments

object[] | null

Price adjustment details for the specified line item or the specified cart

Show child attributes

lineItems.adjustments.id

string

required

Price adjustment ID; it identifies a single price adjustment object within the price adjustments array.

Example:

"c695af14-5e33-402c-9d8d-71edcf4856a8"

lineItems.adjustments.amount

number

required

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

Example:

60.5

lineItems.adjustments.reason

string

required

Price adjustment reason

Example:

"CSR Adjustment"

lineItems.adjustments.attributes

object | null

Placeholder for additional information

Show child attributes

lineItems.adjustments.attributes.{key}

Example:

{ "productFamily": "Laptop computers" }

lineItems.adjustments.createdAt

string

Time cart was created

Example:

"2022-09-06T14:07:17.000Z"

lineItems.adjustments.updatedAt

string

Time cart was last updated

Example:

"2022-09-06T14:07:17.000Z"

totalItems

integer | null

Number of line items in the cart

Example:

3

totalUniqueItems

integer | null

Number of different (unique) line items in the cart based on line item ID

Example:

2

status

enum<string>

Cart status <br/> PENDING - Cart is in pending state <br/> DELETED - Cart is in deleted state

Available options:

PENDING,

DELETED

Example:

"PENDING"

accountId

string | null

Customer account ID

Example:

"5f689caa4216e7000750d1ef"

configuration

object

Cart configurations

Show child attributes

configuration.allowAnonymousUser

boolean

default:

true

true: Cart can be a guest cart, allowing users to configure a cart without logging in <br/> false: User must log in to configure a cart

configuration.orderNumberSource

enum<string>

default:

CART_ID

Determines the order number <br/> CART_ID - Use cartId as orderNumber <br/> FABRIC - Represents the option of allowing the merchant to configure the order number by adding a prefix, sequenceKey, or other identifier to the fabric-generated order number. <br/> EXTERNAL - Represents the option of allowing the tenant or customer to provide a custom order number, which can align with their own internal systems or processes <br/> NONE - order number isn't required for checkout

Available options:

CART_ID,

FABRIC,

EXTERNAL,

NONE

configuration.isSoftReservationEnabled

boolean

default:

false

true: Soft reservation is enabled. When shoppers add items to cart, fabric reserves the items in inventory. <br/> false: fabric doesn't reserve the items when added to cart.

configuration.orderSequence

object

Show child attributes

configuration.orderSequence.sequenceName

string

required

Order Sequence module name

Example:

"ORDER_NUMBER"

configuration.orderSequence.sequenceKey

string | null

Order sequence format or variant

Example:

"LOCATE"

configuration.orderNumberGeneration

enum<string>

default:

NONE

Determines the order number generation enum <br/> AUTO - Fabric will automatically generate an order number and use it during checkout <br/> MANUAL - order number is required to be passed in to the cart journey using addOrderNumber endpoint <br/> NONE - order number isn't required for checkout.

Available options:

AUTO,

MANUAL,

NONE

customerContext

object

Customer context

Show child attributes

customerContext.id

string | null

Identifies a customer

Example:

"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"

customerContext.type

string | null

Customer type

Example:

"EMPLOYEE"

customerContext.attributes

object | null

Customer attributes

Show child attributes

customerContext.attributes.{key}

Example:

{ "isAdmin": false }

customerContext.segments

object[] | null

The segments to which the shopper or customer belong.

The segments to which the user belong.

Show child attributes

customerContext.segments.name

string

The segment name.

Example:

"category"

customerContext.segments.value

string[]

The segment values.

totalAmount

number | null

Total price of line items after discount, including shipping and shipping discount

Example:

10

totalDiscount

number | null

Total discount applied to cart

Example:

10

totalFees

number | null

Total fees applied to cart

Example:

10

subTotal

number | null

Total price of line items, including shipping, without discount

Example:

10

currency

string

default:

USD

Currency type

Example:

"USD"

attributes

object

Cart attributes

Show child attributes

attributes.{key}

Example:

{ "approver": "620d8896058edb0009385311" }

appliedDiscounts

object[]

Applied discounts

Discount details

Show child attributes

appliedDiscounts.promotionId

string | null

Promotion ID

Example:

"6197ec46e836ff000952c664"

appliedDiscounts.couponCode

string | null

Coupon code

Example:

"SUPERCOUPON20"

appliedDiscounts.promotionName

string | null

Promotion name

Example:

"20% off"

appliedDiscounts.type

string | null

Promotion type

Example:

"COUPON"

appliedDiscounts.amount

number | null

Discount amount

Example:

10.15

fees

object[] | null

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

default:

0

Fee amount

Example:

10.5

fees.attributes

object | null

Placeholder for additional information in key:value pairs

Show child attributes

fees.attributes.{key}

Example:

{ "from": "sam" }

suggestedProducts

object[] | null

Suggested free products

Complimentary or free products offered to shoppers in the context of BuyGet and SpendGet promotions.

Show child attributes

suggestedProducts.promotionId

string | null

The promotion ID

Example:

"6197ec46e836ff000952c665"

suggestedProducts.promotionName

string | null

The promotion name

Example:

"Buy shoes get socks for free"

suggestedProducts.itemId

integer | null

The item ID of the free product

Example:

234343

suggestedProducts.itemIds

integer[]

The suggested item IDs from which shoppers can choose one or more items based on the configuration of BuyGet promotion. Even if an item ID is already in the cart, they appear in the list of potential item IDs. This ensures visibility and enables shoppers to make informed decisions during the checkout process.

The item ID of the free product.

suggestedProducts.sku

string

The Stock Keeping Unit (SKU) of the free product.

Example:

"SHOE1234"

suggestedProducts.skus

string[]

The suggested SKUs from which shoppers can choose one or more items based on the configuration of BuyGet promotion. Even if an SKU is already in the cart, they appear in the list of potential SKUs. This ensures visibility and enables shoppers to make informed decisions during the checkout process.

The Stock Keeping Unit (SKU) of the free product.

suggestedProducts.eligiblePriceLists

integer[]

The price list IDs eligible for promotion. When they're not specified, promotion applies to all price lists.

The price list ID.

suggestedProducts.quantity

integer

The number of complimentary items in the promotion.

Example:

2

suggestedProducts.promotionQuantity

integer

The maximum limit of complimentary items available for the BuyGet promotion. For example, consider the promotionQuantity is 10 and promotion condition is Buy 1 pair of shoes and Get 1 pair of socks free. If a shopper purchases up to 10 pairs of shoes, they will get an equivalent number of socks for free. However, even if they buy more than 10 pairs of shoes, the maximum free pairs of socks will remain 10, as defined by the promotionQuantity parameter.

Example:

10

suggestedProducts.isFree

boolean

A flag indicating whether a free item is included as part of promotion. Set to true to indicate a free item is offered as promotion and false to indicate otherwise.

suggestedProducts.discountType

string

The type of discount.

Example:

"PERCENTAGE_OFF"

suggestedProducts.amount

number

The discount amount.

Example:

100.15

orderNumber

string

The order number

Example:

"121213"

error

object

Errors in this cart

Show child attributes

error.prices

object[]

Offers

Offer details

Show child attributes

error.prices.price

object

required

Item or discount price details

Show child attributes

error.prices.price.sale

number | null

Price at which the product is offered for sale

Example:

1000.15

error.prices.price.cost

number

Cost of goods sold, from either producing or purchasing from other vendors

Example:

900.15

error.prices.price.base

number

Starting price of a single item

Example:

2000.15

error.prices.price.unitPriceWithoutDiscounts

number | null

Price of a single item without discount. This price is either the base or sale price. The type used is noted in the type property.

Example:

2000.15

error.prices.price.lineTotalWithoutDiscounts

number | null

Total price of all items without calculating discounts. This is the unitPriceWithoutDiscounts multiplied by the quantity.

Example:

5000.15

error.prices.price.lineTotalWithDiscounts

number | null

Total price of all items after all discounts. This is the unitPriceWithoutDiscounts multiplied by the quantity, less the promotion discounts.

Example:

5000.15

error.prices.price.type

string | null

Price type

Example:

"BASE"

error.prices.price.currency

string

Currency string value

Example:

"USD"

Example:

{
  "sale": 1000.15,
  "cost": 900.15,
  "base": 2000.15,
  "unitPriceWithoutDiscounts": 2000.15,
  "lineTotalWithoutDiscounts": 2000.15,
  "lineTotalWithDiscounts": 2000.15,
  "type": "BASE"
}

error.prices.channel

string

required

Sales channel

Example:

"12"

error.prices.kind

string | null

Offer type

Example:

"PROMOTION"

error.prices.position

integer

Line item position number (starts at 1)

Required range: x >= 1

Example:

1

error.prices.discounts

object[] | null

Discounts

Promotion discount

Show child attributes

error.prices.discounts.amount

number

Actual discount amount

Example:

1000.15

error.prices.discounts.quantity

integer

The number of items eligible for the promotional discount.

Example:

5

error.prices.discounts.proratedAmount

number

The discount amount distributed proportionally among all the selected items. The distribution is determined based on each item's price relative to the total price of all participating items. Typically, proratedAmount matches the amount. However, there might be variations, particularly in the context of Buy-Get promotions.

Example:

1000.15

error.prices.discounts.proratedQuantity

integer

This 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:

5

error.prices.discounts.application

integer | null

An identifier for an instance of the Buy-Get promotion that can be applied repeatedly. For example, consider a promotion - Buy 1 shirt and get 1 pant at a 20% off. If a shopper buys three shirts, 20% discount is individually applied to each shirt-pant pair. Each such discounted pair is assigned a unique application number for tracking purposes.

Example:

1

error.prices.discounts.promotion

object

The promotion details.

Show child attributes

error.prices.discounts.promotion.id

string

A 24-character system-generated Promotion ID.

Example:

"6197ec46e836ff000952c667"

error.prices.discounts.promotion.value

number

The discount in percent or amount.

Example:

2000.15

error.prices.discounts.promotion.groupId

string | null

ID of the group or category this product belongs to

Example:

"61a6354d0d70e30009415f16"

error.prices.discounts.promotion.level

integer | null

The order in which the current promotion is executed.

Example:

1

error.prices.discounts.promotion.isStackable

boolean | null

A flag indicating whether the promotion is stackable. Set to true to combine the given promotion with other promotions. The discount of the current promotion is combined with other promotions, if applicable, to the item. Set to false if the promotion isn't stackable; the given promotion can't be combined with other promotions.

Example:

true

error.prices.discounts.promotion.isAlwaysApplied

boolean | null

A flag indicating whether the promotion is always applied regardless of any exclusive promotions on the same item. Set to true if the promotion is always applied and set to false if the promotion isn't applied on the item by default.

Example:

true

error.prices.discounts.promotion.name

string

The name of the promotion.

Example:

"20% off"

error.prices.discounts.promotion.type

string

The type of the promotion.

Example:

"COUPON"

error.prices.discounts.promotion.discountType

enum<string>

The type of discount.

Available options:

PERCENTAGE_OFF,

AMOUNT_OFF,

FIXED_PRICE

Example:

"PERCENTAGE_OFF"

Example:

{
  "id": "6197ec46e836ff000952c668",
  "value": 2000.15,
  "groupId": "61a6354d0d70e30009415f16",
  "level": 1,
  "isStackable": true,
  "isAlwaysApplied": true,
  "name": "20% OFF",
  "type": "Coupon",
  "discountType": "AMOUNT_OFF"
}

error.promotionErrors

object[]

Promotion exception details

Exception details

Show child attributes

error.promotionErrors.code

enum<string>

required

Error code

Available options:

UNKNOWN_ERROR,

BAD_REQUEST,

INVALID_TOKEN,

INVALID_ACCOUNT_ID,

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,

PRICE_NOT_FOUND,

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,

INVALID_PENDING_COUNT,

ITEM_SERVICE_NOT_CONFIGURED,

ATTRIBUTE_SERVICE_NOT_CONFIGURED,

SHIP_ID_NOT_FOUND,

INVALID_DATE_RANGE,

INVALID_DATE_FORMAT,

INVALID_SEARCH_ATTRIBUTE,

BAD_CONFIGURATION,

SERVICE_NOT_ENABLED

Example:

"UNKNOWN_ERROR"

error.promotionErrors.detail

string

required

Error detail

Example:

"Item is out of stock"

error.promotionErrors.itemId

integer

Item ID obtained from Product Catalog.

Example:

1730902008

error.promotionErrors.sku

string | null

Item SKU to which the exception applies

Example:

"16B2GS8LD5FDS"

error.promotionErrors.position

integer

Line item position number (starts at 1)

Required range: x >= 1

Example:

1

error.inventoryErrors

object[]

Inventory exception details

Exception details

Show child attributes

error.inventoryErrors.code

enum<string>

required

Error code

Available options:

UNKNOWN_ERROR,

BAD_REQUEST,

INVALID_TOKEN,

INVALID_ACCOUNT_ID,

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,

PRICE_NOT_FOUND,

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,

INVALID_PENDING_COUNT,

ITEM_SERVICE_NOT_CONFIGURED,

ATTRIBUTE_SERVICE_NOT_CONFIGURED,

SHIP_ID_NOT_FOUND,

INVALID_DATE_RANGE,

INVALID_DATE_FORMAT,

INVALID_SEARCH_ATTRIBUTE,

BAD_CONFIGURATION,

SERVICE_NOT_ENABLED

Example:

"UNKNOWN_ERROR"

error.inventoryErrors.detail

string

required

Error detail

Example:

"Item is out of stock"

error.inventoryErrors.itemId

integer

Item ID obtained from Product Catalog.

Example:

1730902008

error.inventoryErrors.sku

string | null

Item SKU to which the exception applies

Example:

"16B2GS8LD5FDS"

error.inventoryErrors.position

integer

Line item position number (starts at 1)

Required range: x >= 1

Example:

1