Get order details
Retrieve detailed information about a specific order including line items and status.
HMAC Signature Verification (Optional)
For enhanced security, you can verify the authenticity of order data using HMAC signatures.
When enabled, the response includes an X-Signature header containing an HMAC-SHA256 signature
of the response body.
To verify:
- Extract the
X-Signatureheader from the response - Compute HMAC-SHA256 of the response body using your API secret key
- Compare the computed signature with the header value
Example verification (Node.js):
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.
Path Parameters
Order UUID
Query Parameters
Comma-separated list of fields to include in the response.
Allowed Fields:
id,order_number,customer_id,customer_email,customer_phone,customer_namebilling_address,shipping_addresssubtotal,tax_amount,shipping_amount,discount_amount,total_amountpayment_method,payment_status,order_status,payment_referencenotes,tracking_number,estimated_deliveryshipped_at,delivered_atcreated_at,updated_atshipping_metadataitems
Response
Successfully retrieved order
"ORD-2026-001234"
pending, processing, shipped, delivered, cancelled "pending"
pending, paid, failed, refunded "pending"
Method used for payment
stripe, paypal, paystack, mpesa, cash, bank_transfer "stripe"
1999.98
159.99
Per-jurisdiction tax detail when tax was calculated automatically for the shipping destination (one entry per taxing jurisdiction). Null when a flat store rate was used.
How the tax figure was produced — automatic (jurisdiction-accurate calculation for the destination), fallback (automatic calculation was unavailable, so the store's configured rate was used), or manual (the store's configured rate).
automatic, fallback, manual, null "automatic"
15
0
2174.97
Whether this order was created in the live or test environment. Sandbox orders are isolated from production data.
production, sandbox "production"
Complete shipping calculation details for audit trail

