Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
- Overview
- PATCHUpdate items in specific cart
- GETGet all carts
- POSTSearch for carts
- DELRemove an item from the cart
- POSTSplit the cart item by quantity
- GETGet specific cart
- DELRemove an individual promotion from all items in a specific cart
- POSTCreate an empty cart
- PUTReplaces customer context in cart
- DELDelete cart items
- PATCHUpdate status of specific cart
- PATCHMerge carts
- POSTSoft reserve cart items
- DELDelete items from specific cart
- POSTAdd items to cart
- POSTApply a specific promotion to all items in a specific cart
- PUTMerge Carts
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Replaces customer context in cart
Create or replace customer context in the cart.
Headers
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.
API Key for Gateway
Authorization token for the user
Path Parameters
Cart ID
Body
Customer context of a cart
Customer attributes
Identifies a customer
Customer segments
Customer type
Response
All promotions or coupons for items in this cart
Currency type
Errors in this cart
Inventory exception details
Error code
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
ID of item to which exception applies
Cart item sequence number (starts at 1)
x > 1SKU of item to which exception applies
Offers
Offer channel
Item or discount price details
Item's base price
Item's full price
Currency type
Discount amount
Price after the increments have been added over base
Price type
Item's sale price
Price for all units of this item, including discounts
List of discounts
Unique promotion/coupon ID
Total amount of discount applied
Promotion group ID
ID of item to which promotion is applied
Key of item to which promotion is applied
Coupon code description
Promotion priority
General promotion/coupon code
Promotion type
Promotion name
The prorated discount amount.
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.
Quantity of this item in the cart
Item SKU to which promotion is applied
true = This promotion is stackable with other promotions<br />false = This promotion cannot be stacked with other promotions
Discount unit
Promotion value
Offer type
Cart item sequence number (starts at 1)
x > 1Promo exception details
Error code
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
ID of item to which exception applies
Cart item sequence number (starts at 1)
x > 1SKU of item to which exception applies
Items in cart
true: Item is set for pickup<br />false: Item is set for delivery
Cart item details
total quantity of the line item
Item SKU
Additional item options
Attribute ID
Attribute name
Attribute price
Attribute type
Attribute description
Attribute level
ITEM: Item-level attribute<br />ORDER: Cart-level attribute
Attribute applicability
Total price of item attributes
Cart item ID
Sales channel
Item creation time
Extra metadata passed by caller
Item details for order fulfillment
Specifies the channel of inventory for item
Inventory details of the cart item
Custom inventory attributes configured by the merchant
Inventory restock date
Maximum restock inventory quantity
Sales channel ID. This field is used to identify where the business operations are being held.
Inventory counter (also known as inventory position) configured by the merchant
Inventory ID
Infinite inventory flag.<br /> true indicates that the inventory can be consumed any number of times as per need<br />false indicates that the inventory cannot be used infinitely, and has a limit to be consumed
Type of inventory
Item ID for which inventory is updated
The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse
Location number is used to identify the warehouse or location where the inventory is kept
Inventory quantity to mark as low stock at the location
First ship date of inventory
Maximum quanity of inventory for first-ship
Region where inventory is managed
Reserved inventory quantity at the location
Inventory segment
SKU of the item
Vendor ID
View quantity of inventory, based on pre configured value. For example, 'availableToPurchase' can be a custom attribute configured by merchants.
Specifies the type of inventory for item
Specifies the network of inventory for item
Type of order fulfillment
true = Item is active<br />false = Item is not active
true: Item is set for pickup<br />false: Item is set for delivery
Item ID
Cart item sequence number (starts at 1)
x > 1Item price list ID
Shipment details
Shipping address
Address recipient
City name
Country name
Receiver's email address
Address type
Recipient's name
address details for the shipping
State name
Address line 1
Address line 2
Address line 3
Address line 4
Zip code
Cart ID
Shipping details creation time
true = Item is set for pickup<br />false = Item is set for delivery
Shipping method and details
Shipping details ID
Shipping type
Store ID
Shipping tax code
Last time shipping details were updated
Warehouse ID
Shipping ID
ItemSubType(For International type, provide subType as Border-free)
Item name
Total price for the full quantity of this item
Price before discount
Currency type
Offer discount details. Empty list {} should be passed in case of no discount.
List of discounts applied
Discounted price of the item
x > 0Discounted percentage amount of the item
x > 0Price after discount
ItemType(WEB_SHIP/WEB_PICKUP/WEB_SDD/INTERNATIONAL/POS/POS_SHIP/POS_PICKUP)
Individual item price
Price before discount
Currency type
Offer discount details. Empty list {} should be passed in case of no discount.
List of discounts applied
Discounted price of the item
x > 0Discounted percentage amount of the item
x > 0Price after discount
Last time item was updated
Warehouse ID
Number of items in cart
Item SKU
Additional item options
Attribute ID
Attribute name
Attribute price
Attribute type
Attribute description
Attribute level
ITEM: Item-level attribute<br />ORDER: Cart-level attribute
Attribute applicability
Total price of attributes
Cart item ID
Sales channel
Item creation time
Fees associated with a specific cart or an individual line item of a cart
Fee amount
Placeholder for additional information in key:value pairs
System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.
Attribute for which fee is applied
Fee type
true = Item is active<br />false = Item is not active
Item ID
Cart item sequence number (starts at 1)
x > 1List of price adjustments for the line item
Amount by which the line item's total amount or the specified cart's total amount is adjusted
x > 0Price adjustment ID; it identifies a single price adjustment object from the list of price adjustments.
Price adjustment reason
Placeholder for additional information
Item price list ID
Shipment details
Shipping address
Address recipient
City name
Country name
Receiver's email address
Address type
State name
Address line 1
Address line 2
Address line 3
Address line 4
Zip code
Alternative pickup person
Receiver's email address
Cart ID
Shipping details creation time
true = Item is set for pickup<br />false = Item is set for delivery
Designated pickup person
Receiver's email address
Shipping method and details
Shipment carrier
Shipment method type
Shipping method ID
Shipping details ID
Shipping type
Store ID
Shipping tax code
Last time shipping details were updated
Warehouse ID
Item name
Total price for the full quantity of this item
Price before discount
Currency type
Offer discount details. Empty list {} should be passed in case of no discount.
List of discounts applied
Unique promotion/coupon ID
Total amount of discount applied
Promotion group ID
ID of item to which promotion is applied
Key of item to which promotion is applied
Coupon code description
Promotion priority
General promotion/coupon code
Promotion type
Promotion name
The prorated discount amount.
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.
Quantity of this item in the cart
Item SKU to which promotion is applied
true = This promotion is stackable with other promotions<br />false = This promotion cannot be stacked with other promotions
Discount unit
Promotion value
Discounted price of the item
x > 0Unique promotion/coupon ID
General promotion/coupon code
Promotion/coupon code discount unit
Promotion/coupon code discount value
Discounted percentage amount of the item
x > 0Price after discount
Individual item price
Price before discount
Currency type
Offer discount details. Empty list {} should be passed in case of no discount.
List of discounts applied
Unique promotion/coupon ID
Total amount of discount applied
Promotion group ID
ID of item to which promotion is applied
Key of item to which promotion is applied
Coupon code description
Promotion priority
General promotion/coupon code
Promotion type
Promotion name
The prorated discount amount.
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.
Quantity of this item in the cart
Item SKU to which promotion is applied
true = This promotion is stackable with other promotions<br />false = This promotion cannot be stacked with other promotions
Discount unit
Promotion value
Discounted price of the item
x > 0Unique promotion/coupon ID
General promotion/coupon code
Promotion/coupon code discount unit
Promotion/coupon code discount value
Discounted percentage amount of the item
x > 0Price after discount
Last time item was updated
Warehouse ID
Metadata for this cart
Customer account ID
Additional item options
Attribute ID
Attribute name
Attribute price
Attribute type
Attribute description
Attribute level
ITEM: Item-level attribute<br />ORDER: Cart-level attribute
Attribute applicability
Cart ID
Cart status
ACTIVE, PENDING, PENDING_APPROVAL, APPROVED, SUBMITTED, DELETED, REJECTED Cart configurations
true: Item can be added to a cart by SKU; itemId is not mandatory to add an item to a cart.<br />false: itemId is mandatory to add an item to a cart
true: Allows a cart to be guest cart. Shoppers can modify the cart without logging in.<br/> false: Allows cart modification only if the shopper is logged in.
Specifies how an order number is created. The options are:<br/>1. CART_ID: Cart ID is used as the order number. In this case, fabric's Cart service uses the specified cart ID and assigns it as the order numebr.<br/>2. EXTERNAL: Merchant provides the order number during chekout.<br/>3. FABRIC: fabric generates the order number based on cart configuration details, and assigns it to the cart.<br/>4. NONE: Merchants have the flexibility to not provide an order number during the creation of an order draft. Instead, they can provide the order number when generating final orders based on the previously created order draft.
CART_ID, EXTERNAL, FABRIC, NONE Specifies whether items in cart should be soft reserved. The options are:<br />true: Soft reservation is enabled; the items added to cart are reserved in the inventory.<br />false: Soft reservation is disabled; the items added to cart are not reserved in the inventory.
Cart creation time
Fees associated with a specific cart or an individual line item of a cart
Fee amount
Placeholder for additional information in key:value pairs
System-generated fee ID, in UUID format. While creating a cart or line item with fee, fabric generates this ID for the specified fee.
Attribute for which fee is applied
Fee type
Total price of cart items including Shipping without any discount
List of recommended products that are available for purchase along with the item added to the cart
Discount amount
Discount type, such as %OFF, AMOUNT_OFF, and FIXED_PRICE
Price lists to which the promotion is applicable
Indicates if the suggested item is a free item. The options are:<br />true: The suggested item is provided for free.<br />false: The suggested item is not offered for free.
Suggested item ID
IDs of the items for which this promotion is applicable
Promotion ID
Maximum quantity of items allowed as part of the promotion
x > 1Promotion title
Suggested quantity of items
x > 1Merchant ID
Total price of cart items after discount including Shipping and Shipping Discount
Total discount applied to cart
Total fees applied to cart
Number of items in the cart
Number of unique items in the cart based on line item ID
Last time cart was updated
User ID
Was this page helpful?