POST
/
checkout-links
/
{id}
/
cart
curl -X POST \
 /checkout-links/{id}/cart \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "customerId": "ad7f7b7d-7b7d-7b7d-7b7d-7b7d-7b7d7b7d7b7d",
    "metadata": [
        ""
    ]
}'
{
  "cartId": "ad7f7b7d-7b7d-7b7d-7b7d-7b7d7b7d7b7d",
  "customerId": "ad7f7b7d-7b7d-7b7d-7b7d-7b7d7b7d7b7d",
  "url": "https://example.com/cart/123"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

CheckoutLink identifier

Body

The new CheckoutLink resource
​
customerId
string | null

The ID of the customer which should be pre-authenticated for the cart. The receiver of the cart link can see and select the customers payment methods and addresses. If the customer is not provided, the cart will be anonymous.

Example:

"ad7f7b7d-7b7d-7b7d-7b7d-7b7d-7b7d7b7d7b7d"

​
metadata
string[]

A collection of key-value pairs that can be linked to an object. This feature is beneficial for storing extra details regarding the object in an organized manner. To remove all keys, simply submit an empty value to the metadata. The metadata is shown in webhooks and api responses.

Example:
{ "key": "value" }

Response

201
application/json
CheckoutLink resource created
​
cartId
string

The ID of the cart

Example:

"ad7f7b7d-7b7d-7b7d-7b7d-7b7d7b7d7b7d"

​
customerId
string | null

The ID of the customer.

Example:

"ad7f7b7d-7b7d-7b7d-7b7d-7b7d7b7d7b7d"

​
url
string

The public URL to the cart

Example:

"https://example.com/cart/123"

Was this page helpful?

Suggest editsRaise issue