Docs
Management API
Abandoned carts

Abandoned carts

Use /abandoned-carts/{token} on headless storefronts to retrieve the cart_id using the abandoned cart token passed to the storefront when a shopper clicks an abandoned cart email link. Once the cart ID has been retrieved, your application can use it to fetch and display information about the cart to the shopper using the REST Storefront API, the REST Management API, or the GraphQL Storefront API.

Get an abandoned cart

GET /abandoned-carts/{token}

Request

Return the cart_id corresponding to the abandoned cart {token} passed in.

Usage Notes:

  • {token} is the token in the query string of the abandoned cart link found in abandoned cart email notifications to shoppers

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • token in path - string
    required

    Unique cart UUID.

    Unique cart UUID token that is generated for abandoned cart emails.

  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/abandoned-carts/[token]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Returned on GET requests to /abandoned_carts.

Body

object | application/json

  • data    object

  • meta    object

    Response metadata

example

{
"data": {
"cart_id": "string"
},
"meta": {}
}

Get global abandoned cart settings

GET /abandoned-carts/settings

Request

Return the global abandoned cart settings of a store.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • pagination in query - integer
    How many pages to return

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/abandoned-carts/settings' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json
The response object of abandoned cart settings at the global level

  • data    object

    Represents all settings related to the abandoned cart functionality of a store

  • meta    object

    Response metadata

example

{
"data": {
"enable_notification": true,
"email_customer_until_cart_is_recovered": true,
"marketing_emails_require_customer_consent": true,
"email_merchant_when_cart_is_converted": true,
"email_merchant_when_cart_is_abandoned": true,
"merchant_email_address": "user@example.com",
"merchant_abandoned_cart_email_frequency_type": "digest",
"merchant_abandoned_cart_digest_email_frequency": 2
},
"meta": {}
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
OverviewGet an abandoned cart