Skip to main content
POST
Find the best promotion for a cart

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

store_id
string<uuid>

The merchant whose promotions to evaluate. Required for marketplace storefronts — pass the merchant_store_id you received with the promotion or collection. Ignored for single-store keys.

Body

application/json
cart
object[]
required

The cart lines to evaluate promotions against. Also accepted under the name items, which behaves identically; send whichever matches your storefront's own cart shape, and cart when both are present.

items
object[]

Alias of cart. Send one or the other, not both.

Response

Success

The single highest-value eligible promotion for a cart — what to auto-apply at checkout.

promotion
object | null

The winning promotion, or null when no promotion applies to the cart.

discount
number

The discount amount for the winning promotion. 0 when none applies.