List orders
Retrieve a paginated list of orders for the store, newest first.
The list view returns order headers without line items for efficiency —
fetch GET /v1/orders/{id} for the full order including its items.
Key Type Support:
- ✅ Secret keys (full access)
- ❌ Publishable keys (forbidden — returns 403)
Supports cursor pagination (limit + cursor) and optional filters by
payment_status, order_status, and customer_id.
Authorizations
API Key Authentication
Use your API key in the Authorization header:
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_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) ortybrite_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
Maximum number of orders to return (1–200, default 50)
1 <= x <= 200Opaque pagination cursor returned as pagination.next_cursor from a prior call
Filter by payment status
pending, paid, failed, refunded Filter by order fulfillment status
pending, processing, shipped, delivered, cancelled Filter to orders for a specific customer
Comma-separated list of fields to include per order. Same allowed fields
as GET /v1/orders/{id} (excluding items, which is not returned in list view).

