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 /stores/{store_hash}/v3/abandoned-carts/{token}
Request
Returns 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 - required
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
Response
Returned on GET
requests to /abandoned_carts
.
Body
dataobject
metaobject
Response metadata.
example
Get Global Abandoned Cart Settings
GET /stores/{store_hash}/v3/abandoned-carts/settings
Request
Returns the global abandoned cart settings of a store.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string - required
The MIME type of the response body.
example
Response
OK
Body
The response object of abandoned cart settings at the global level
dataobject
Represents all settings related to the abandoned cart functionality of a store
metaobject
Response metadata.