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:

1. Extract the X-Signature header from the response
2. Compute HMAC-SHA256 of the response body using your API secret key
3. Compare the computed signature with the header value

Example verification (Node.js):

const crypto = require('crypto');
const signature = response.headers['x-signature'];
const computed = crypto.createHmac('sha256', apiSecretKey)
  .update(JSON.stringify(response.data))
  .digest('hex');
const isValid = signature === computed;

GET /v1/orders/{id}

Get order details

cURL

curl --request GET \
  --url https://api.tybritelabs.com/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "880e8400-e29b-41d4-a716-446655440003",
  "customer_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "confirmed",
  "total_amount": 2049.97,
  "items": [
    {
      "product_name": "iPhone 15 Pro",
      "quantity": 2,
      "unit_price": 999.99
    }
  ],
  "created_at": "2026-02-03T10:30:00Z",
  "updated_at": "2026-02-03T10:35:00Z"
}

Authorizations

Authorization · string · header · required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

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.

Path Parameters

id · string<uuid> · default: 880e8400-e29b-41d4-a716-446655440003 · required

Order UUID

Query Parameters

fields · string

Comma-separated list of fields to include in the response.

Allowed Fields:

• id, order_number, customer_id, customer_email, customer_phone, customer_name
• billing_address, shipping_address
• subtotal, tax_amount, shipping_amount, discount_amount, total_amount
• payment_method, payment_status, order_status, payment_reference
• notes, tracking_number, estimated_delivery
• shipped_at, delivered_at
• created_at, updated_at
• shipping_metadata
• items

Response

200

application/json

Successfully retrieved order

id · string<uuid>

order_number · string

Example:

"ORD-2026-001234"

customer_id · string<uuid>

customer_email · string<email>

customer_phone · string

customer_name · string

order_status · enum<string>

Available options: pending, processing, shipped, delivered, cancelled

Example:

"pending"

payment_status · enum<string>

Available options: pending, paid, failed, refunded

Example:

"pending"

payment_method · enum<string>

Method used for payment

Available options: stripe, paystack, mpesa, airtel, cash, bank_transfer

Example:

"stripe"

payment_reference · string

subtotal · number<float>

Example:

1999.98

tax_amount · number<float>

Example:

159.99

shipping_amount · number<float>

Example:

15

discount_amount · number<float>

Example:

0

total_amount · number<float>

Example:

2174.97

billing_address · object

Show child attributes

shipping_address · object

Show child attributes

items · object[]

Show child attributes

notes · string

tracking_number · string

estimated_delivery · string<date-time>

shipped_at · string<date-time>

delivered_at · string<date-time>

created_at · string<date-time>

updated_at · string<date-time>

shipping_metadata · object

Complete shipping calculation details for audit trail

Show child attributes