Compare products
Two to five products side by side: price and price range, stock, rating, and the store’s return
window, with spec_rows aligning every published specification across them. A specification a product
does not publish is null in its column.
With a marketplace operator key the products may come from different sellers of that marketplace; each
carries merchant_store_id and merchant_name, prices are in the marketplace’s currency, the return
window is the seller’s own, and rating is null. A product not sold on that marketplace answers 404.
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/compare \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"product_ids": [
"289533e8-f5b6-4d4f-bb23-2127875feb70",
"3afdb59a-7f7f-4abb-baa1-2e37709c1128"
]
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/compare"
payload = { "product_ids": ["289533e8-f5b6-4d4f-bb23-2127875feb70", "3afdb59a-7f7f-4abb-baa1-2e37709c1128"] }
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({
product_ids: ['289533e8-f5b6-4d4f-bb23-2127875feb70', '3afdb59a-7f7f-4abb-baa1-2e37709c1128']
})
};
fetch('https://api.tybritelabs.com/v1/agent/compare', 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/compare",
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([
'product_ids' => [
'289533e8-f5b6-4d4f-bb23-2127875feb70',
'3afdb59a-7f7f-4abb-baa1-2e37709c1128'
]
]),
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/compare"
payload := strings.NewReader("{\n \"product_ids\": [\n \"289533e8-f5b6-4d4f-bb23-2127875feb70\",\n \"3afdb59a-7f7f-4abb-baa1-2e37709c1128\"\n ]\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/compare")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"product_ids\": [\n \"289533e8-f5b6-4d4f-bb23-2127875feb70\",\n \"3afdb59a-7f7f-4abb-baa1-2e37709c1128\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/compare")
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 \"product_ids\": [\n \"289533e8-f5b6-4d4f-bb23-2127875feb70\",\n \"3afdb59a-7f7f-4abb-baa1-2e37709c1128\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"products": [
{
"product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
"name": "Galactic Zip Hoodie",
"brand": "Galactic",
"category": "Wearables",
"price": 48,
"price_range": {
"min": 48,
"max": 50
},
"in_stock": true,
"total_stock": 60,
"rating": {
"average": null,
"count": 0
},
"return_window_days": 10,
"returns_accepted": true
},
{
"product_id": "3afdb59a-7f7f-4abb-baa1-2e37709c1128",
"name": "Selling Plans Ski Wax",
"brand": "GC-Test",
"category": "General",
"price": 9.95,
"price_range": {
"min": 9.95,
"max": 49.95
},
"in_stock": true,
"total_stock": 30,
"rating": {
"average": null,
"count": 0
},
"return_window_days": 10,
"returns_accepted": true
}
],
"spec_rows": []
},
"evidence": [
{
"source": "pricing",
"operation": "GET /v1/prices/products/{id}",
"field": "resolved_price"
},
{
"source": "products",
"operation": "GET /v1/product-specifications",
"field": "specification_data"
},
{
"source": "reviews",
"operation": "GET /v1/reviews",
"field": "summary"
},
{
"source": "store",
"field": "returns_window_days"
}
],
"computed_at": "2026-09-28T21:53:29.740Z",
"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.
Query Parameters
Response
The comparison
curl --request POST \
--url https://api.tybritelabs.com/v1/agent/compare \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"product_ids": [
"289533e8-f5b6-4d4f-bb23-2127875feb70",
"3afdb59a-7f7f-4abb-baa1-2e37709c1128"
]
}
'import requests
url = "https://api.tybritelabs.com/v1/agent/compare"
payload = { "product_ids": ["289533e8-f5b6-4d4f-bb23-2127875feb70", "3afdb59a-7f7f-4abb-baa1-2e37709c1128"] }
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({
product_ids: ['289533e8-f5b6-4d4f-bb23-2127875feb70', '3afdb59a-7f7f-4abb-baa1-2e37709c1128']
})
};
fetch('https://api.tybritelabs.com/v1/agent/compare', 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/compare",
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([
'product_ids' => [
'289533e8-f5b6-4d4f-bb23-2127875feb70',
'3afdb59a-7f7f-4abb-baa1-2e37709c1128'
]
]),
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/compare"
payload := strings.NewReader("{\n \"product_ids\": [\n \"289533e8-f5b6-4d4f-bb23-2127875feb70\",\n \"3afdb59a-7f7f-4abb-baa1-2e37709c1128\"\n ]\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/compare")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"product_ids\": [\n \"289533e8-f5b6-4d4f-bb23-2127875feb70\",\n \"3afdb59a-7f7f-4abb-baa1-2e37709c1128\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/compare")
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 \"product_ids\": [\n \"289533e8-f5b6-4d4f-bb23-2127875feb70\",\n \"3afdb59a-7f7f-4abb-baa1-2e37709c1128\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"products": [
{
"product_id": "289533e8-f5b6-4d4f-bb23-2127875feb70",
"name": "Galactic Zip Hoodie",
"brand": "Galactic",
"category": "Wearables",
"price": 48,
"price_range": {
"min": 48,
"max": 50
},
"in_stock": true,
"total_stock": 60,
"rating": {
"average": null,
"count": 0
},
"return_window_days": 10,
"returns_accepted": true
},
{
"product_id": "3afdb59a-7f7f-4abb-baa1-2e37709c1128",
"name": "Selling Plans Ski Wax",
"brand": "GC-Test",
"category": "General",
"price": 9.95,
"price_range": {
"min": 9.95,
"max": 49.95
},
"in_stock": true,
"total_stock": 30,
"rating": {
"average": null,
"count": 0
},
"return_window_days": 10,
"returns_accepted": true
}
],
"spec_rows": []
},
"evidence": [
{
"source": "pricing",
"operation": "GET /v1/prices/products/{id}",
"field": "resolved_price"
},
{
"source": "products",
"operation": "GET /v1/product-specifications",
"field": "specification_data"
},
{
"source": "reviews",
"operation": "GET /v1/reviews",
"field": "summary"
},
{
"source": "store",
"field": "returns_window_days"
}
],
"computed_at": "2026-09-28T21:53:29.740Z",
"currency": "EUR",
"environment": "sandbox"
}
