Promotions
List promotions
Get active promotions, optionally filtered by cart total
GET
/
v1
/
promotions
List promotions
curl --request GET \
--url https://api.tybritelabs.com/v1/promotions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/promotions"
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/promotions', 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/promotions",
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/promotions"
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/promotions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/promotions")
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{
"promotions": [
{
"type": "discount",
"display_type": "Percentage Discount",
"name": "Spring Sale — 15% Off",
"value": "15",
"min_purchase": 50,
"start_date": "2026-06-19",
"end_date": "2026-07-20",
"status": "active",
"conditions": "Minimum spend $50",
"created_at": "2026-06-20T11:12:09.860326+00:00",
"updated_at": "2026-06-20T13:44:36.764884+00:00",
"has_time_restrictions": false,
"start_time": null,
"end_time": null,
"time_zone": "America/New_York",
"apply_to_days": null,
"id": "df290d89-0400-4b2c-aa56-11fcc486150c",
"image": "https://cdn.example.com/promotions/spring-sale.jpg",
"image_mobile": "https://cdn.example.com/promotions/spring-sale-mobile.jpg",
"video": null
},
{
"type": "fixed",
"display_type": "Fixed amount off",
"name": "$20 Off Orders Over $200",
"value": "20",
"min_purchase": 200,
"start_date": "2026-06-19",
"end_date": "2026-07-20",
"status": "active",
"conditions": "Minimum spend $200",
"created_at": "2026-06-20T11:12:09.860326+00:00",
"updated_at": "2026-06-20T13:44:36.764884+00:00",
"has_time_restrictions": false,
"start_time": null,
"end_time": null,
"time_zone": "America/New_York",
"apply_to_days": null,
"id": "b43fd2cc-622a-454a-965f-18323d11c346"
},
{
"type": "bundle",
"display_type": "Bundle promotion",
"name": "Audio + Wearable Bundle",
"value": "0",
"min_purchase": 0,
"start_date": "2026-06-19",
"end_date": "2026-07-20",
"status": "active",
"conditions": null,
"created_at": "2026-06-20T11:12:09.860326+00:00",
"updated_at": "2026-06-20T13:44:36.764884+00:00",
"has_time_restrictions": false,
"start_time": null,
"end_time": null,
"time_zone": "America/New_York",
"apply_to_days": null,
"id": "46e746e2-6ef3-4091-ae4e-6bc8d405a1a2",
"bundle_products": [
{
"quantity": 1,
"productId": "7d425c0a-50e7-4e39-af79-6f7945f9dfa8",
"discountedPrice": 299.99
},
{
"quantity": 1,
"productId": "0186665f-f0a1-4c79-976a-919b5b1c2daa",
"discountedPrice": 249
}
]
}
],
"pagination": {
"limit": 50,
"next_cursor": null,
"has_more": false
}
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}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/*): Secret key required - 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.
Query Parameters
Only live promotions are returned. active is the default; any other value returns an empty list.
Available options:
active, inactive, scheduled, expired Filter promotions by minimum cart total requirement (numeric string)
Required range:
1 <= x <= 200Cursor for pagination (base64-encoded)
Comma-separated list of fields to include in the response.
Allowed Fields:
id,name,type,display_type,value,min_purchasestart_date,end_date,status,conditions,image,image_mobile,videobundle_products,bogo_required_products,bogo_free_products,free_productshas_time_restrictions,start_time,end_time,time_zone,apply_to_dayscreated_at,updated_at
⌘I
List promotions
curl --request GET \
--url https://api.tybritelabs.com/v1/promotions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/promotions"
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/promotions', 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/promotions",
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/promotions"
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/promotions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/promotions")
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{
"promotions": [
{
"type": "discount",
"display_type": "Percentage Discount",
"name": "Spring Sale — 15% Off",
"value": "15",
"min_purchase": 50,
"start_date": "2026-06-19",
"end_date": "2026-07-20",
"status": "active",
"conditions": "Minimum spend $50",
"created_at": "2026-06-20T11:12:09.860326+00:00",
"updated_at": "2026-06-20T13:44:36.764884+00:00",
"has_time_restrictions": false,
"start_time": null,
"end_time": null,
"time_zone": "America/New_York",
"apply_to_days": null,
"id": "df290d89-0400-4b2c-aa56-11fcc486150c",
"image": "https://cdn.example.com/promotions/spring-sale.jpg",
"image_mobile": "https://cdn.example.com/promotions/spring-sale-mobile.jpg",
"video": null
},
{
"type": "fixed",
"display_type": "Fixed amount off",
"name": "$20 Off Orders Over $200",
"value": "20",
"min_purchase": 200,
"start_date": "2026-06-19",
"end_date": "2026-07-20",
"status": "active",
"conditions": "Minimum spend $200",
"created_at": "2026-06-20T11:12:09.860326+00:00",
"updated_at": "2026-06-20T13:44:36.764884+00:00",
"has_time_restrictions": false,
"start_time": null,
"end_time": null,
"time_zone": "America/New_York",
"apply_to_days": null,
"id": "b43fd2cc-622a-454a-965f-18323d11c346"
},
{
"type": "bundle",
"display_type": "Bundle promotion",
"name": "Audio + Wearable Bundle",
"value": "0",
"min_purchase": 0,
"start_date": "2026-06-19",
"end_date": "2026-07-20",
"status": "active",
"conditions": null,
"created_at": "2026-06-20T11:12:09.860326+00:00",
"updated_at": "2026-06-20T13:44:36.764884+00:00",
"has_time_restrictions": false,
"start_time": null,
"end_time": null,
"time_zone": "America/New_York",
"apply_to_days": null,
"id": "46e746e2-6ef3-4091-ae4e-6bc8d405a1a2",
"bundle_products": [
{
"quantity": 1,
"productId": "7d425c0a-50e7-4e39-af79-6f7945f9dfa8",
"discountedPrice": 299.99
},
{
"quantity": 1,
"productId": "0186665f-f0a1-4c79-976a-919b5b1c2daa",
"discountedPrice": 249
}
]
}
],
"pagination": {
"limit": 50,
"next_cursor": null,
"has_more": false
}
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}
