Cart Checkout Endpoint

https://{shop_domain}/cart/checkout

https://{shop_domain}/cart/checkout?products=11111111-1111-1111-1111-111111111111:1,22222222-2222-2222-2222-222222222222:2&currency=USD

https://{shop_domain}/cart/checkout?cartId=22222222-2222-2222-2222-222222222222&currency=USD

​

Request

• Method: GET
• Path: /cart/checkout
• Intended use: Browser redirect links (ads, email, social, product feeds, etc.)
• Use the root path (/cart/checkout), not a locale-prefixed path.

​

Query Parameters

​

products Format

products=variantId[:quantity],variantId[:quantity],...

• variantId must be a variant UUID (not product/offer ID).
• quantity is optional; default is 1.
• Invalid quantity values fall back to 1.
• Entries with too many separators (like id:1:extra) are skipped.
• URL-encoded input is supported.
• If any entry has an invalid variant UUID, parsing fails and products becomes empty.

?products=11111111-1111-1111-1111-111111111111
?products=11111111-1111-1111-1111-111111111111:2
?products=11111111-1111-1111-1111-111111111111:1,22222222-2222-2222-2222-222222222222:3

​

Behavior

1. If products contains valid variant entries, the endpoint can create/update a cart from those products.
2. If cartId is provided and valid, checkout uses that cart and ignores products.
3. If both are unavailable (no valid cartId and no valid products), redirect goes to /.
4. On success, a checkout is created/updated and the shopper is redirected to /checkout/{checkoutId}.

1. coupon query param
2. Manually-applied promo already on cart
3. Automatically applied promo code from a shared link

1. currency query param
2. Session currency
3. USD

​

Response

• Success: 303 See Other -> /checkout/{checkoutId}
• Empty/invalid input: 303 See Other -> /
• Exception path: 303 See Other -> /?error_message=...

​

Google Merchant Center Template

https://{shop_domain}/cart/checkout?products={id}:1

​

Example Integration

function redirectToDirectCheckout(shopDomain, variantId, quantity = 1, coupon) {
  const params = new URLSearchParams({
    products: `${variantId}:${quantity}`
  });

  if (coupon) params.set("coupon", coupon);

  window.location.href = `https://${shopDomain}/cart/checkout?${params.toString()}`;
}

function redirectCartToCheckout(shopDomain, cartId, currency = "USD") {
  const params = new URLSearchParams({
    cartId,
    currency
  });

  window.location.href = `https://${shopDomain}/cart/checkout?${params.toString()}`;
}