Skip to main content
POST
Open a support request for the store

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_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) or tybrite_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-changing POST calls require a secret key, for store and marketplace keys alike; GET /v1/auth/me accepts 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 403 with the error code out_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 403 with endpoint_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

Idempotency-Key
string

Names this attempt. Required here or as idempotency_key in the body.

Required string length: 1 - 128

Body

application/json
subject
string
required

One line, as the merchant will read it in their Support list.

Required string length: 1 - 200
Example:

"Checkout button does nothing on the cart page"

body
string
required

What happened and what the app already tried. The merchant's support team reads it.

Required string length: 1 - 10000
Example:

"Shoppers who press Pay on the cart page see no response. It started after the 3 November publish."

support_type
enum<string>

What the request is about. Omit it when none fits.

Available options:
payments_billing,
orders_fulfilment,
products_catalogue,
integrations_sync,
account_access,
something_else
idempotency_key
string

Names this attempt, so a retry returns the request already opened instead of opening another. Required, here or in the Idempotency-Key header (the same value if both are sent).

Required string length: 1 - 128
Example:

"pay-button-2026-11-04"

Response

The request this key already opened

id
string<uuid>
required
subject
string
required
status
string
required

Where the request stands with the support team, for example Open, Replied, Resolved or Closed.

Example:

"Open"

created_at
string<date-time>
required
updated_at
string<date-time>
required
support_type
string | null
last_reply_at
string<date-time> | null

When the support team last replied. The reply itself is for the merchant and is not returned.

resolved_at
string<date-time> | null