Abandoned Carts

  • Version: V3
  • Host: api.bigcommerce.com/stores/{$$.env.store_hash}/v3
  • Protocols: https
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 a client_id and access_token via X-Auth-Client and X-Auth-Token HTTP headers:

GET /stores/{$$.env.store_hash}/v3/catalog/summary
host: api.bigcommerce.com
Accept: application/json
X-Auth-Client: {client_id}
X-Auth-Token: {access_token}
Header Parameter Description
X-Auth-Client client_id Obtained by creating an API account or installing an app in a BigCommerce control panel.
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.

Available Endpoints

Resource / Endpoint Description
/abandoned-carts/{token} Get acart_id by passing in an abandoned cart link token param