POST /carts/{cartId}/redirect_urls

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.

Servers

Name	Type	Required	Description
`cartId`	String	Yes	The identifier of a specific cart.

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	Yes	The MIME type of the response body. Default value: "application/json"
`Content-Type`	String	Yes	Default value: "application/json"

Accept

String

Yes

The MIME type of the response body.

Default value: "application/json"

Content-Type

String

Yes

Default value: "application/json"

Name	Type	Required
`query_params`	Object	No
`query_params.key`	String	No
`query_params.value`	String	No

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.