Skip to main content
POST
Quote a multi-merchant checkout

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.

Body

application/json
items
object[]
required
Minimum array length: 1
currency
string
Example:

"USD"

customer_name
string

Used as the recipient name on carrier options.

shipping_address
object

Where the order is going (line1, line2, city, state, postal_code, country). Located to price shipping when shipping_destination is omitted, and needed for carrier options.

shipping_destination
object

Where the basket is going, used to price each merchant's delivery rates. Send coordinates, or a place name. When omitted, the shipping_address is located instead.

shipping_selections
object[]
discounts
object[]

The same per-merchant discounts the checkout accepts.

Response

The basket's price, per merchant, including shipping.

What a unified checkout will charge, per merchant, before the shopper pays.

currency
string
Example:

"USD"

subtotal
number

The basket's merchandise before any discount.

Example:

130

discount_total
number
Example:

0

shipping_total
number

Shipping across every merchant.

Example:

15

total_amount
number

What the checkout will charge before any wallet balance: merchandise after discounts plus shipping.

Example:

145

sellers
object[]