Cart
Items and subtotal for the cart identified by X-Cart-Session (or the signed-in customer). No delivery or fees — those are computed at checkout.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/store/cart" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b"{ "data": [ { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "image": "https://media.usequeek.com/uploads/stores/2207/cotton-midi-dress.jpg", "product_p_id": 31501, "variant_p_id": null, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [], "subtotal": "51.00", "discount_total": "0.00", "total_after_discounts": "51.00" } ], "status": "success", "message": "Carts retrieved successfully", "meta": { "total_carts": 1 }}Upserts the whole cart in one call (cart_items[] with item_id, quantity, optional variant_id). Prefer cart/items to add lines one at a time. Items the server rejects come back in rejected_items.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/store/cart" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b" \ -H "Content-Type: application/json" \ -d '{ "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "cart_items": [ { "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "price": 60, "quantity": 1, "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02" }, { "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c43", "title": "Linen Head Scarf", "price": 18, "quantity": 2 } ], "source": "storefront" }'{ "status": "success", "message": "Cart saved successfully", "data": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [], "subtotal": "51.00", "discount_total": "0.00", "total_after_discounts": "51.00" }}Adds one line (product_id, optional variant_id, quantity) without touching other lines. Replies result: "added" with the cart, or result: "customise" with the variant/addon options the product needs — show them and call again with the choice.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/store/cart/items" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b" \ -H "Content-Type: application/json" \ -d '{ "product_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c11", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "quantity": 1 }'{ "status": "success", "message": "Item added to cart", "data": { "result": "added", "cart": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [], "subtotal": "51.00", "discount_total": "0.00", "total_after_discounts": "51.00" } }}Changes a line quantity after rechecking its product, variant, publication and stock. Send the current line item_id, variant_id and properties from the cart read; stale line positions answer 409.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Path Parameters
Zero-based position of the line in the cart, as in the items array you last read.
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/store/cart/items/0" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b" \ -H "Content-Type: application/json" \ -d '{ "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c11", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "properties": null, "quantity": 2 }'{ "status": "success", "message": "Cart line updated", "data": { "cart": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [], "subtotal": "51.00", "discount_total": "0.00", "total_after_discounts": "51.00" } }}Removes the current line at this zero-based position. Send its current item_id, variant_id and properties; stale line positions answer 422.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Path Parameters
Zero-based position of the line in the cart, as in the items array you last read.
Query Parameters
Zero-based position of the line in the cart. It is read from the {line} path segment, so it is never sent in the request itself.
0 <= valueThe item_id (product id) of the line you are changing, as the cart returned it. It guards against a stale position: when the line at that position now holds a different item, variant or properties, nothing changes and the call answers 422 "Cart line changed".
uuidThe variant_id of the line as the cart returned it, or null for a product without variants. Always send it.
uuidThe properties of the line exactly as the cart returned them, or null when the line has none. Always send it.
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/store/cart/items/0?line=0&item_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&variant_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&properties%5B%5D=string" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b"{ "status": "success", "message": "Cart line removed", "data": { "cart": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [], "subtotal": "51.00", "discount_total": "0.00", "total_after_discounts": "51.00" } }}Applies one vendor or platform coupon to the cart. Discount validity and amount follow checkout rules; repeated submissions are idempotent.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/store/cart/discounts" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b" \ -H "Content-Type: application/json" \ -d '{ "code": "NORTH10" }'{ "status": "success", "message": "Coupon applied successfully", "data": { "cart": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [ "NORTH10" ], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [ { "code": "NORTH10", "title": "Welcome to Northwind", "type": "percentage", "amount_applied": "5.10", "status": "applicable", "reason": null } ], "subtotal": "51.00", "discount_total": "5.10", "total_after_discounts": "45.90" } }}Removes the specified code from the cart without changing its lines.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Path Parameters
The discount code to remove, as applied to the cart.
Query Parameters
The discount code to remove. It is read from the {code} path segment, so it is never sent in the request itself.
length <= 50Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/store/cart/discounts/NORTH10?code=string" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b"{ "status": "success", "message": "Coupon removed successfully", "data": { "cart": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [], "subtotal": "51.00", "discount_total": "0.00", "total_after_discounts": "51.00" } }}Re-checks every line against current stock and prices and returns is_valid with validation_errors. Call before sending the shopper to checkout_url.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/store/cart/validate" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b" \ -H "Content-Type: application/json" \ -d '{ "cart_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41" }'{ "status": "success", "message": "Cart is valid", "data": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41", "vendor_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "vendor": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c01", "name": "Northwind Goods", "distance": null, "delivery_info": { "is_free_delivery": true, "delivery_fee": "0.00", "delivery_fee_value": "0.00", "min_order": "1000.00", "min_order_fee": "2000.00", "d_p_value": 1.5, "s_p_value": 1.5, "delivery_time": "45-180 min", "delivery_message": "Open until 21:00", "offers_free_delivery": false, "pickup_enabled": true, "offer_instant_delivery": true }, "notice": [], "slug": "northwind-goods", "service": null, "currency": "USD", "logo": "https://media.usequeek.com/uploads/stores/2207/logo.png", "disable_order": false, "is_closed": false, "temporary_unavailable": false, "preorder_enabled": null, "area": "SoHo", "banner": "https://media.usequeek.com/uploads/stores/2207/banner.png", "support_phone": "+1 202 555 0147", "phone": "+1 202 555 0147", "country_code": "US", "phone_code": "1", "support_email": "[email protected]", "slogan": null, "tags": null, "tag": "fashion", "is_new": false, "rating": 4.7, "rating_count": 486, "short_description": null, "address": "14 Mercer Street, New York, NY 10013", "open_time": "09:00", "close_time": "21:00", "service_type": "fashion", "landmark": "Opposite the public library", "region_id": null, "min_order_price": null }, "currency": "USD", "cart_items": [ { "line": 0, "item_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c42", "title": "Cotton Midi Dress", "variant_id": "019b0c4d-5f10-7a02-8c61-0b2d4e6f8a02", "variant_title": "M", "variant_option_values": { "Size": "M" }, "price": "60.00", "discount_price": "51.00", "discount": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c31", "title": "Spring Season 15% Off", "type": "percentage", "amount": "9.00" }, "quantity": 1, "selectedAddons": [], "requires_slot": false, "properties": null } ], "total_price": "51.00", "source": "storefront", "promo_codes": [], "is_valid": true, "validation_errors": [], "last_validated_at": "2026-09-25T15:40:00+01:00", "created_at": "2026-09-25T15:32:00+01:00", "updated_at": "2026-09-25T15:40:00+01:00", "discounts": [], "subtotal": "51.00", "discount_total": "0.00", "total_after_discounts": "51.00" }, "meta": { "is_valid": true, "validation_errors": [] }}Removes every line from the cart identified by X-Cart-Session (or the signed-in customer).
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Query Parameters
Clear this one cart of the store (UUID; it must belong to the caller; an already-cleared cart succeeds). Omit it to clear the caller's cart on this store.
uuidHeader Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Identifies a signed-out shopper's cart. Required when no customer token is sent — without it the cart answers 422 validation_failed (Missing session token for anonymous cart.); ignored when an Authorization: Bearer customer token is present. Generate any opaque string (a UUID) when the shopper first adds to cart and send it on every cart call. The same value is also accepted as the session_token body field.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/store/cart/clear?cart_id=019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41" \ -H "X-Client-Key: {{clientKey}}" \ -H "X-Cart-Session: a3f1b8e2-4c5d-4e6f-8a9b-0c1d2e3f4a5b"{ "status": "success", "message": "Cart cleared successfully", "data": { "cleared_cart_id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c41" }}