Cancel a checkout intent
Cancels a pending intent and releases its stock hold at once. The answer is the cancelled intent, with the
shopper’s personal data returned on the same terms as GET /v1/agent/checkout-intents/{id}.
Who may cancel: a secret key may cancel any intent. An intent prepared for a signed-in shopper, and an
intent created with confirmation_mode hosted, is cancelled with a publishable key only by sending its
confirmation_token in the body or the credential of the shopper it was prepared for; anything else returns
403 forbidden (a wrong token returns 403 invalid_confirmation_token). A guest intent in token mode is cancelled with a
publishable key and its id.
A marketplace intent holds no stock before confirmation, so cancelling it only closes it. A marketplace
key finds only its own marketplace’s intents. A marketplace secret key cancels any of them. A publishable
marketplace key cancels an intent only by sending its confirmation_token in the body: a marketplace intent
is never prepared for a signed-in shopper, so no shopper credential takes the token’s place, and the id
alone returns 403 forbidden (a wrong token returns 403 invalid_confirmation_token).
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"confirmation_token": "<string>"
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel"
payload = { "confirmation_token": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({confirmation_token: '<string>'})
};
fetch('https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'confirmation_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel"
payload := strings.NewReader("{\n \"confirmation_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"confirmation_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"confirmation_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "9ddda3a3-a19d-4176-be35-e697392b564c",
"status": "cancelled",
"confirmation_mode": "token",
"expires_at": "2026-10-01T11:02:16.925+00:00",
"order_id": null,
"total": 39.95,
"currency": "EUR",
"items": [
{
"quantity": 1,
"variant_id": "06cf8d3e-da82-4d6f-896f-d756f80c592f"
}
],
"quote": {
"tax": {
"amount": 5.51,
"source": "fallback",
"status": "quoted",
"prices_include_tax": true
},
"lines": [
{
"sku": "selling-plans-ski-wax-selling-plans-ski-wax",
"name": "Selling Plans Ski Wax",
"stock": 10,
"quantity": 1,
"available": true,
"line_total": 24.95,
"list_price": 24.95,
"product_id": "3afdb59a-7f7f-4abb-baa1-2e37709c1128",
"unit_price": 24.95,
"variant_id": "06cf8d3e-da82-4d6f-896f-d756f80c592f",
"variant_name": "Selling Plans Ski Wax",
"category_name": "General",
"unavailable_reason": null
}
],
"currency": "EUR",
"discount": {
"amount": 0,
"promotion": null
},
"shipping": {
"amount": 15,
"status": "quoted",
"is_free": false,
"description": "USA",
"free_threshold": 100
},
"subtotal": 24.95,
"grand_total": 39.95,
"total_is_final": true,
"unavailable_count": 0
},
"created_at": "2026-10-01T10:32:16.943272+00:00",
"confirmed_at": null,
"cancelled_at": "2026-10-01T10:32:17.767+00:00"
},
"evidence": [
{
"source": "agent",
"id": "9ddda3a3-a19d-4176-be35-e697392b564c",
"field": "status"
},
{
"source": "orders",
"field": "stock hold released"
}
],
"computed_at": "2026-10-01T10:32:18.124Z",
"currency": "EUR",
"environment": "sandbox"
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): state-changingPOSTcalls require a secret key, for store and marketplace keys alike;GET /v1/auth/meaccepts either key - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Limited publishable keys:
A publishable key can be limited to the products that carry one tag (for example starter:jewellery), created from
the store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.
- Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and
subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of
in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice.
A product outside the slice answers
404, as if it did not exist. - A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line,
a review, a promotion calculation, a storefront event) answers
403with the error codeout_of_scope, and nothing is written or reserved. An order is refused as a whole. - A route that carries no slice behaviour is not available to the key: it answers
403withendpoint_not_allowed. - Orders placed through such a key record the tag on the order's attribution as
key_scope. - Secret keys and connected-app keys cannot be limited.
- Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.
Headers
Body
Response
The cancelled intent
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"confirmation_token": "<string>"
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel"
payload = { "confirmation_token": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({confirmation_token: '<string>'})
};
fetch('https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'confirmation_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel"
payload := strings.NewReader("{\n \"confirmation_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"confirmation_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"confirmation_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "9ddda3a3-a19d-4176-be35-e697392b564c",
"status": "cancelled",
"confirmation_mode": "token",
"expires_at": "2026-10-01T11:02:16.925+00:00",
"order_id": null,
"total": 39.95,
"currency": "EUR",
"items": [
{
"quantity": 1,
"variant_id": "06cf8d3e-da82-4d6f-896f-d756f80c592f"
}
],
"quote": {
"tax": {
"amount": 5.51,
"source": "fallback",
"status": "quoted",
"prices_include_tax": true
},
"lines": [
{
"sku": "selling-plans-ski-wax-selling-plans-ski-wax",
"name": "Selling Plans Ski Wax",
"stock": 10,
"quantity": 1,
"available": true,
"line_total": 24.95,
"list_price": 24.95,
"product_id": "3afdb59a-7f7f-4abb-baa1-2e37709c1128",
"unit_price": 24.95,
"variant_id": "06cf8d3e-da82-4d6f-896f-d756f80c592f",
"variant_name": "Selling Plans Ski Wax",
"category_name": "General",
"unavailable_reason": null
}
],
"currency": "EUR",
"discount": {
"amount": 0,
"promotion": null
},
"shipping": {
"amount": 15,
"status": "quoted",
"is_free": false,
"description": "USA",
"free_threshold": 100
},
"subtotal": 24.95,
"grand_total": 39.95,
"total_is_final": true,
"unavailable_count": 0
},
"created_at": "2026-10-01T10:32:16.943272+00:00",
"confirmed_at": null,
"cancelled_at": "2026-10-01T10:32:17.767+00:00"
},
"evidence": [
{
"source": "agent",
"id": "9ddda3a3-a19d-4176-be35-e697392b564c",
"field": "status"
},
{
"source": "orders",
"field": "stock hold released"
}
],
"computed_at": "2026-10-01T10:32:18.124Z",
"currency": "EUR",
"environment": "sandbox"
}
