Open a support request for the store
Opens a support request with the merchant’s support team on the merchant’s behalf, for something the app cannot resolve itself. The request appears in the merchant’s Support list marked with the app’s name, the merchant is told by email and in the app, and the support team’s replies go to the merchant, not to the app.
Send an idempotency key (idempotency_key in the body or the Idempotency-Key header). Repeating
a request with the same key returns the request already opened with 200 and notifies no one; a new
key opens a new request with 201.
An app can open 5 requests an hour and 20 a day per store. Beyond that the call returns 429 with
Retry-After. A sandbox connection records the request and returns it but reaches no support team
and no merchant.
Authentication: the connection’s secret key (tybrite_sk_*). The connection must have been
granted the support_tickets:write scope at consent; otherwise 403 insufficient_scope is
returned. A publishable key is refused with 403 forbidden.
Rate limit: 30 requests/hour per API key.
curl --request POST \
--url https://api.tybritelabs.com/v1/storefront/tickets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": "Checkout button does nothing on the cart page",
"body": "Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.",
"support_type": "integrations_sync",
"idempotency_key": "pay-button-2026-11-04"
}
'import requests
url = "https://api.tybritelabs.com/v1/storefront/tickets"
payload = {
"subject": "Checkout button does nothing on the cart page",
"body": "Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.",
"support_type": "integrations_sync",
"idempotency_key": "pay-button-2026-11-04"
}
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({
subject: 'Checkout button does nothing on the cart page',
body: JSON.stringify('Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.'),
support_type: 'integrations_sync',
idempotency_key: 'pay-button-2026-11-04'
})
};
fetch('https://api.tybritelabs.com/v1/storefront/tickets', 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/storefront/tickets",
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([
'subject' => 'Checkout button does nothing on the cart page',
'body' => 'Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.',
'support_type' => 'integrations_sync',
'idempotency_key' => 'pay-button-2026-11-04'
]),
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/storefront/tickets"
payload := strings.NewReader("{\n \"subject\": \"Checkout button does nothing on the cart page\",\n \"body\": \"Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.\",\n \"support_type\": \"integrations_sync\",\n \"idempotency_key\": \"pay-button-2026-11-04\"\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/storefront/tickets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"Checkout button does nothing on the cart page\",\n \"body\": \"Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.\",\n \"support_type\": \"integrations_sync\",\n \"idempotency_key\": \"pay-button-2026-11-04\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/storefront/tickets")
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 \"subject\": \"Checkout button does nothing on the cart page\",\n \"body\": \"Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.\",\n \"support_type\": \"integrations_sync\",\n \"idempotency_key\": \"pay-button-2026-11-04\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3f1c6a0e-8f6b-4a53-9d0a-5b5f7e2c1a11",
"subject": "Checkout button does nothing on the cart page",
"status": "Open",
"support_type": "integrations_sync",
"last_reply_at": null,
"resolved_at": null,
"created_at": "2026-11-04T10:15:00Z",
"updated_at": "2026-11-04T10:15:00Z"
}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 request this key already opened
curl --request POST \
--url https://api.tybritelabs.com/v1/storefront/tickets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject": "Checkout button does nothing on the cart page",
"body": "Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.",
"support_type": "integrations_sync",
"idempotency_key": "pay-button-2026-11-04"
}
'import requests
url = "https://api.tybritelabs.com/v1/storefront/tickets"
payload = {
"subject": "Checkout button does nothing on the cart page",
"body": "Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.",
"support_type": "integrations_sync",
"idempotency_key": "pay-button-2026-11-04"
}
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({
subject: 'Checkout button does nothing on the cart page',
body: JSON.stringify('Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.'),
support_type: 'integrations_sync',
idempotency_key: 'pay-button-2026-11-04'
})
};
fetch('https://api.tybritelabs.com/v1/storefront/tickets', 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/storefront/tickets",
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([
'subject' => 'Checkout button does nothing on the cart page',
'body' => 'Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.',
'support_type' => 'integrations_sync',
'idempotency_key' => 'pay-button-2026-11-04'
]),
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/storefront/tickets"
payload := strings.NewReader("{\n \"subject\": \"Checkout button does nothing on the cart page\",\n \"body\": \"Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.\",\n \"support_type\": \"integrations_sync\",\n \"idempotency_key\": \"pay-button-2026-11-04\"\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/storefront/tickets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subject\": \"Checkout button does nothing on the cart page\",\n \"body\": \"Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.\",\n \"support_type\": \"integrations_sync\",\n \"idempotency_key\": \"pay-button-2026-11-04\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/storefront/tickets")
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 \"subject\": \"Checkout button does nothing on the cart page\",\n \"body\": \"Shoppers who press Pay on the cart page see no response. It started after the 3 November publish.\",\n \"support_type\": \"integrations_sync\",\n \"idempotency_key\": \"pay-button-2026-11-04\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3f1c6a0e-8f6b-4a53-9d0a-5b5f7e2c1a11",
"subject": "Checkout button does nothing on the cart page",
"status": "Open",
"support_type": "integrations_sync",
"last_reply_at": null,
"resolved_at": null,
"created_at": "2026-11-04T10:15:00Z",
"updated_at": "2026-11-04T10:15:00Z"
}
