Get the store's policies
The facts a shopper asks before buying: whether the store accepts returns, its return window and reasons, where it ships and the base fees, the payment methods it accepts, and its currencies. With a live key, only payment methods configured for live payments are listed.
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/store-policies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/store-policies"
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/store-policies', 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/store-policies",
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/store-policies"
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/store-policies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/store-policies")
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": {
"store": {
"name": "Galactic Core Store",
"timezone": "Africa/Nairobi",
"email": "store@example.com",
"website": "https://tybritelabs.com"
},
"currencies": {
"default": "EUR",
"accepted": [
"CNY",
"EUR",
"GBP",
"KES",
"USD"
]
},
"payment_methods": [
{
"provider": "cash",
"display_name": "Cash on Delivery",
"type": "manual"
},
{
"provider": "stripe",
"display_name": "Stripe",
"type": "redirect"
},
{
"provider": "paypal",
"display_name": "PayPal",
"type": "popup"
},
{
"provider": "paystack",
"display_name": "Paystack",
"type": "popup"
}
],
"shipping": {
"currency": "EUR",
"zones": [
{
"name": "USA",
"fee": 15,
"free_threshold": 100
},
{
"name": "United Kingdom",
"fee": 12,
"free_threshold": 100
},
{
"name": "Kenya",
"fee": 25,
"free_threshold": 150
}
],
"distance_tiers": [
{
"name": "Within Nairobi",
"fee": 5,
"max_distance_meters": 50000,
"free_threshold": 100
}
],
"everywhere_else": null
},
"returns": {
"accepted": true,
"window_days": 10,
"reasons": [
{
"code": "damaged",
"label": "Arrived damaged"
},
{
"code": "defective",
"label": "Defective / not working"
},
{
"code": "wrong_item",
"label": "Wrong item received"
},
{
"code": "not_as_described",
"label": "Not as described"
},
{
"code": "wrong_size",
"label": "Wrong size / fit"
},
{
"code": "no_longer_needed",
"label": "No longer needed"
},
{
"code": "arrived_late",
"label": "Arrived too late"
},
{
"code": "other",
"label": "Other (please describe)"
}
]
}
},
"evidence": [
{
"source": "store",
"field": "returns_window_days"
},
{
"source": "store-info",
"operation": "GET /v1/store/info",
"field": "currencies"
},
{
"source": "payments",
"operation": "GET /v1/payments/methods",
"field": "methods"
},
{
"source": "shipping",
"operation": "GET /v1/shipping/zones",
"field": "delivery_zones"
},
{
"source": "returns",
"operation": "GET /v1/returns/reasons",
"field": "data"
}
],
"computed_at": "2026-10-01T10:32:01.009Z",
"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 store's policies
curl --request GET \
--url https://api.tybritelabs.com/v1/agent/store-policies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/agent/store-policies"
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/store-policies', 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/store-policies",
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/store-policies"
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/store-policies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/agent/store-policies")
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": {
"store": {
"name": "Galactic Core Store",
"timezone": "Africa/Nairobi",
"email": "store@example.com",
"website": "https://tybritelabs.com"
},
"currencies": {
"default": "EUR",
"accepted": [
"CNY",
"EUR",
"GBP",
"KES",
"USD"
]
},
"payment_methods": [
{
"provider": "cash",
"display_name": "Cash on Delivery",
"type": "manual"
},
{
"provider": "stripe",
"display_name": "Stripe",
"type": "redirect"
},
{
"provider": "paypal",
"display_name": "PayPal",
"type": "popup"
},
{
"provider": "paystack",
"display_name": "Paystack",
"type": "popup"
}
],
"shipping": {
"currency": "EUR",
"zones": [
{
"name": "USA",
"fee": 15,
"free_threshold": 100
},
{
"name": "United Kingdom",
"fee": 12,
"free_threshold": 100
},
{
"name": "Kenya",
"fee": 25,
"free_threshold": 150
}
],
"distance_tiers": [
{
"name": "Within Nairobi",
"fee": 5,
"max_distance_meters": 50000,
"free_threshold": 100
}
],
"everywhere_else": null
},
"returns": {
"accepted": true,
"window_days": 10,
"reasons": [
{
"code": "damaged",
"label": "Arrived damaged"
},
{
"code": "defective",
"label": "Defective / not working"
},
{
"code": "wrong_item",
"label": "Wrong item received"
},
{
"code": "not_as_described",
"label": "Not as described"
},
{
"code": "wrong_size",
"label": "Wrong size / fit"
},
{
"code": "no_longer_needed",
"label": "No longer needed"
},
{
"code": "arrived_late",
"label": "Arrived too late"
},
{
"code": "other",
"label": "Other (please describe)"
}
]
}
},
"evidence": [
{
"source": "store",
"field": "returns_window_days"
},
{
"source": "store-info",
"operation": "GET /v1/store/info",
"field": "currencies"
},
{
"source": "payments",
"operation": "GET /v1/payments/methods",
"field": "methods"
},
{
"source": "shipping",
"operation": "GET /v1/shipping/zones",
"field": "delivery_zones"
},
{
"source": "returns",
"operation": "GET /v1/returns/reasons",
"field": "data"
}
],
"computed_at": "2026-10-01T10:32:01.009Z",
"currency": "EUR",
"environment": "sandbox"
}
