Docs
Management API
Carts
Redirects

Redirects

Create Cart Redirect URL

POST /carts/{cartId}/redirect_urls

Request

Creates a Cart redirect URL for redirecting a shopper to an already created cart using the cartId.

Usage Notes

  • To use redirect URLs, first create the cart using the REST Management API or GraphQL Storefront API.
  • Redirect URLs can also be created with Create a Cart requests by appending include=redirect_urls.
  • A Carts redirect URL is valid for 30 days and may only be used once.
  • Redirect URLs point to either a shared checkout domain or a channel-specific domain, depending on the storefront configuration.
  • Once a redirect URL has been visited, it will be invalidated and cannot be used again.
  • If your application requires URLs to be visited more than once, consider generating a fresh one each time you need to restore a cart, and redirecting to the URL from your own application.
  • To restore a cart that was created on the storefront, either by a shopper or a Storefront API, first recreate the cart using the REST Management API.
  • When redirecting the shopper, you can add a set of query_params to the URL. The query_params feature allows passing additional information to the redirect URL.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • cartId in path - string
    required
    The identifier of a specific cart.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required

Body

object | application/json

  • query_params    object

example

{
"query_params": {
"key_1": "value_1",
"key_2": "value_2"
}
}

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example-1

{
"data": {
"cart_url": "https://store.mybigcommerce.com/cart.php?action=load&id=0aa00afa-a000-00a0-00aae-aa0000f000a0&token=00aaaaa0aa0000000000a000a000f0aa0000afa00aa00afa0a000000000aa0a0",
"checkout_url": "https://store.mybigcommerce.com/cart.php?action=loadInCheckout&id=1ea11efe-b111-11d1-11ee-cd1110f111b1&token=00aaaaa0aa0000000000a000a000f0aa0000afa00aa00afa0a000000000aa0a0",
"embedded_checkout_url": "https://store.mybigcommerce.com/cart.php?embedded=1&action=loadInCheckout&id=0aa00afa-a000-00a0-00aae-aa0000f000a0&token=00aaaaa0aa0000000000a000a000f0aa0000afa00aa00afa0a000000000aa0a0"
},
"meta": {
"title": "Response meta",
"type": "object",
"properties": {},
"description": "Response metadata."
}
}
Did you find what you were looking for?
Delete a MetafieldCreate Cart Redirect URL