Storefront Carts
Manage cart operations and data on BigCommerce-hosted storefronts. To work with headless storefronts, use the GraphQL Storefront API.
The REST Storefront API uses CORS (opens in a new tab) headers for authentication, and therefore has no required scopes. You do not need to send any BigCommerce-specific tokens with your requests to these endpoints.
For info about authenticating BigCommerce APIs, see Authentication and Example Requests.
Get a Cart
GET /carts
Request
Returns a Cart.
Note
- Substitute your storefront domain for
yourstore.example.com. - The Send a Test Request feature is not currently supported for this endpoint.
Parameters
- store_domain in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- include in query - array
To return product options add one of the following include:
lineItems.physicalItems.options: The Cart returns an abbreviated result. Use this to return physical items product options. Can also be used in a /POST to have the extended Cart object return.lineItems.digitalItems.options: The Cart returns an abbreviated result. Use this to return digital items product options. Can also be used in a /POST to have the extended Cart object return.lineItems.digitalItems.options,lineItems.physicalItems.options: The Cart returns an abbreviated result. Use this to return digital and physical options. Can also be used in a /POST to have the extended Cart object return.
example
Response
Body
idstring
Cart ID, provided after creating a cart with a POST.
customerIdinteger
ID of the customer to which the cart belongs.
emailstring
The cart's email. This is the same email that is used in the billing address
currencyobject
This will always be the same between cart and checkout.
isTaxIncludedboolean
Whether this item is taxable.
baseAmountnumber
Cost of cart’s contents, before applying discounts.
discountAmountnumber
Order based discounted amount only - Coupon discounts and product based discounts are excluded.
cartAmountnumber
Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
couponsarray[object]
discountsarray[object]
lineItemsobject
createdTimestring
Time when the cart was created.
updatedTimestring
Time when the cart was last updated.
localestring
Locale of the cart.
Example
Create a Cart
POST /carts
Request
Creates a Cart.
Note
- Substitute your storefront domain for
yourstore.example.com. - The Send a Test Request feature is not currently supported for this endpoint.
Parameters
- store_domain in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
Cart object used in create cart requests.
lineItemsarray[object]
requiredlocalestring
lineItemsarray[object]
requiredlocalestring
With Text Modifier
With Gift Wrapping
Response
Post Carts Response
Body
Cart object used in REST Storefront API cart responses.
idstring
Cart ID, provided after creating a cart with a POST.
customerIdinteger
ID of the customer to which the cart belongs.
emailstring
The cart's email. This is the same email that is used in the billing address
currencyobject
This will always be the same between cart and checkout.
isTaxIncludedboolean
Whether this item is taxable.
baseAmountnumber
Cost of cart’s contents, before applying discounts.
discountAmountnumber
Order based discounted amount only - Coupon discounts and product based discounts are excluded.
cartAmountnumber
Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
couponsarray[object]
discountsarray[object]
lineItemsobject
createdTimestring
Time when the cart was created.
updatedTimestring
Time when the cart was last updated.
localestring
Locale of the cart.
Example
Delete a Cart
DELETE /carts/{cartId}
Request
Deletes a Cart. Once a Cart has been deleted it can not be recovered.
Note
- Substitute your storefront domain for
yourstore.example.com. - The Send a Test Request feature is not currently supported for this endpoint.
Parameters
- store_domain in path - string
- cartId in path - stringrequired
This cartʼs unique ID.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
No Content