Add a variant to the cart (optional)

For headless or cross-domain installs: proxies a Shopify Storefront cart mutation and returns checkoutUrl…

POST /api/cart/add

cURL

curl --request POST \
  --url 'https://api.example.com/api/cart/add' \
  --header 'x-widget-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "variantId": "string",
  "quantity": 2,
  "sessionId": "string"
}'

200

{
  "checkoutUrl": "string"
}

For headless or cross-domain installs: proxies a Shopify Storefront cart mutation and returns checkoutUrl. Not needed when cartMode: 'shopify_ajax' lets the widget call Shopify’s /cart/add.js directly.

Request body

CartAdd

variantId · string · required

e.g. gid://shopify/ProductVariant/123

quantity · number · required

sessionId · string

Response

CartAddResponse

checkoutUrl · string

Status codes

Code	Meaning
200	OK
400	Error
401	Error

cURL

curl --request POST \
  --url 'https://api.example.com/api/cart/add' \
  --header 'x-widget-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "variantId": "string",
  "quantity": 2,
  "sessionId": "string"
}'

200

{
  "checkoutUrl": "string"
}