Get a checkout intent
The intent’s status and frozen quote. An intent past its expiry reads as expired and its stock hold
is released.
The shopper’s personal data — customer_id and the quote’s shipping_address — is returned to a secret
key, and to a publishable key that also sends a shopper credential (x-auth-token, x-external-auth or
x-idp-token) for the intent’s own customer. A publishable key alone, a guest intent read with a
publishable key, or another shopper’s credential receives the intent without those two fields; its
status, lines and totals are unchanged. A credential that is sent and cannot be verified is answered
with its own error rather than the reduced view.
With a marketplace operator key only that marketplace’s intents are found; sellers and order_group_id
carry the per-seller lines and, once confirmed, the marketplace order. A publishable key does not see the
shipping address; a secret key does.
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/checkout-intents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/agent/checkout-intents/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "a3a10e58-c5e2-406d-b054-0b8d782e9300",
"status": "pending_confirmation",
"confirmation_mode": "token",
"expires_at": "2026-10-01T11:02:09.366+00:00",
"order_id": null,
"total": 63,
"currency": "EUR",
"items": [
{
"quantity": 1,
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a"
}
],
"quote": {
"tax": {
"amount": 8.69,
"source": "fallback",
"status": "quoted",
"prices_include_tax": true
},
"lines": [
{
"sku": "FEED-HOODIE-GRY-M",
"name": "Galactic Zip Hoodie",
"stock": 25,
"quantity": 1,
"available": true,
"line_total": 48,
"list_price": 48,
"product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
"unit_price": 48,
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"variant_name": "Grey / M",
"category_name": "Wearables",
"unavailable_reason": null
}
],
"currency": "EUR",
"discount": {
"amount": 0,
"promotion": null
},
"shipping": {
"amount": 15,
"status": "quoted",
"is_free": false,
"description": "USA",
"free_threshold": 100
},
"subtotal": 48,
"grand_total": 63,
"total_is_final": true,
"unavailable_count": 0
},
"created_at": "2026-10-01T10:32:09.391151+00:00",
"confirmed_at": null,
"cancelled_at": null
},
"evidence": [
{
"source": "agent",
"id": "a3a10e58-c5e2-406d-b054-0b8d782e9300",
"field": "checkout_intent"
}
],
"computed_at": "2026-10-01T10:32:10.900Z",
"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
Query Parameters
Response
The intent
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/checkout-intents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/agent/checkout-intents/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/agent/checkout-intents/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/checkout-intents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "a3a10e58-c5e2-406d-b054-0b8d782e9300",
"status": "pending_confirmation",
"confirmation_mode": "token",
"expires_at": "2026-10-01T11:02:09.366+00:00",
"order_id": null,
"total": 63,
"currency": "EUR",
"items": [
{
"quantity": 1,
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a"
}
],
"quote": {
"tax": {
"amount": 8.69,
"source": "fallback",
"status": "quoted",
"prices_include_tax": true
},
"lines": [
{
"sku": "FEED-HOODIE-GRY-M",
"name": "Galactic Zip Hoodie",
"stock": 25,
"quantity": 1,
"available": true,
"line_total": 48,
"list_price": 48,
"product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
"unit_price": 48,
"variant_id": "fbe89cdf-90a3-4050-a43b-e4c42302484a",
"variant_name": "Grey / M",
"category_name": "Wearables",
"unavailable_reason": null
}
],
"currency": "EUR",
"discount": {
"amount": 0,
"promotion": null
},
"shipping": {
"amount": 15,
"status": "quoted",
"is_free": false,
"description": "USA",
"free_threshold": 100
},
"subtotal": 48,
"grand_total": 63,
"total_is_final": true,
"unavailable_count": 0
},
"created_at": "2026-10-01T10:32:09.391151+00:00",
"confirmed_at": null,
"cancelled_at": null
},
"evidence": [
{
"source": "agent",
"id": "a3a10e58-c5e2-406d-b054-0b8d782e9300",
"field": "checkout_intent"
}
],
"computed_at": "2026-10-01T10:32:10.900Z",
"currency": "EUR",
"environment": "sandbox"
}
