Skip to main content
POST
Search by constraints

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: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Read-only access (GET requests only, plus POST semantic search)
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries

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)
  • All write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Query Parameters

fields
string

Comma-separated top-level keys of data to return, e.g. fields=grand_total,lines.

Body

application/json
query
string

Free text. Matched by meaning where the store has semantic search, and against name, brand, category, SKU and tags.

Maximum string length: 300
price_min
number
Required range: x >= 0
price_max
number
Required range: x >= 0
category
string

A category or subcategory name (case-insensitive).

attributes
object

Attribute name to wanted value, e.g. {"color": "black"}.

in_stock_only
boolean
limit
integer
default:10
Required range: 1 <= x <= 50

Response

Matching products

data
object
required
evidence
object[]
required

Where each figure in data was read from.

computed_at
string<date-time>
required
environment
enum<string>
required
Available options:
production,
sandbox
currency
string | null

ISO 4217 code every amount in data is expressed in.