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.
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
API Key for Gateway
"zaCELgL.0imfnc8mVLWwsAawjYr4Rx-Af50DDqtlx"
Authorization token for the user
"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
Path Parameters
ID of cart for which attributes will be added or updated
"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"
Body
Cart attribute information to be added or updated
Cart attribute information
Cart account ID
"61b8e921d0cf2e000882b09f"
Cart approver ID
"620d8896058edb0009385311"
Cart purchase order
"112-2624363-4906652"
Attributes added at the cart level
Name for the cart
"cart-sales"
Description for the cart
"cart for sales team"
Company name for the cart
"fabric Inc"
UserIds that represents the users who share the cart
Extra metadata for the cart
{ "productFamily": "Laptop computers" }
Fees associated with a specific cart or an individual line item of a cart
Response
OK
Cart details
Items in cart
Currency type
"USD"
Metadata for this cart
{ "approver": "620d8896058edb0009385311" }
All promotions or coupons for items in this cart
UserIds of the users who share the cart
Errors in this cart
Cart ID
"d7e78a21-bee3-4448-bf1c-d5b5461dbda2"
Cart creation time
"2022-02-11T14:09:40.836703"
Last time cart was updated
"2022-02-22T22:36:40.194293"
Number of items in the cart
3
Number of unique items in the cart based on line item ID
2
Cart status
ACTIVE
, PENDING
, PENDING_APPROVAL
, APPROVED
, SUBMITTED
, DELETED
, REJECTED
"PENDING"
Merchant ID
"5f689caa4216e7000750d1ef"
Customer account ID
"5f689caa4216e7000750d1ef"
User ID
"61b8e921d0cf2e000882b09f"
Cart configurations
Customer context Customer context of a cart
Total price of cart items after discount including Shipping and Shipping Discount
95
Total price of cart items including Shipping without any discount
120
Total discount applied to cart
25
Total fees applied to cart
25
Additional item options
Fees associated with a specific cart or an individual line item of a cart
List of recommended products that are available for purchase along with the item added to the cart