Dev Center
Dev Center
API Docs
API Reference
Theme Docs
Tools
Library
Blog
Changelog
My Apps
Create Account
No results found.
Storefront APIs
Customer Login SSO
GraphQL Storefront API
graphql
Management APIs
Abandoned Carts
Catalog
Provider APIs

Abandoned Carts

  • Host: api.bigcommerce.com/stores/store_hash/v3
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json
More Info

Use /abandoned-carts/{token} on headless storefronts to retrieve the cart_id via the abandoned cart token passed in to headless storefront via an abandoned cart email link clicked on by a shopper. Once the cart_id has been retrieved, it can be used to fetch and display information about the cart to the shopper via the storefront cart and/or server-to-server cart APIs.

OAuth Scopes

UI Name Permission Parameter
Carts modify store_cart
Carts read-only store_cart_read_only

For more information on OAuth Scopes, see: Authentication.

Authentication

Requests can be authenticated by sending an access_token via X-Auth-Token HTTP header:

GET /stores/store_hash/v3/catalog/summary
host: api.bigcommerce.com
Accept: application/json
X-Auth-Token: {access_token}
Header Parameter Description
X-Auth-Token access_token Obtained by creating an API account or installing an app in a BigCommerce control panel.

For more information on Authenticating BigCommerce APIs, see: Authentication.