Skip to main content
POST
Record a guest's contact details at 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: 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/*): 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)
  • 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.

Body

application/json
email
string<email>
required

The guest's email address. Stored lower-cased.

Example:

"john.doe@example.com"

Whether the shopper ticked the box agreeing to hear from the store. Without true no reminder is sent.

Example:

true

recovery_url
string<uri>
required

The storefront page the reminder link opens. Must be on one of the store's own storefront addresses.

Maximum string length: 2048
Example:

"https://shop.example.com/checkout"

name
string

The guest's name, used to greet them in the reminder.

Maximum string length: 120
Example:

"John Doe"

cart_id
string

The cart's session id (the X-Session-Id the storefront uses for cart calls). Its current items are recorded. Send this or lines.

Maximum string length: 128
Example:

"sess_3f9a1c"

lines
object[]

The items being bought, when the storefront holds the cart itself. Send this or cart_id. Variants the store does not sell online are dropped.

Maximum array length: 50

Response

The details are recorded, or were already recorded.

capture_id
string<uuid>
required

Identifies the record. The same for every call for this address and cart.