Get order detail

Error

A valid request URL is required to generate request examples

{
  "uid": "018e1234-0000-7000-a000-000000000100",
  "order_number": "RB-20250115-0042",
  "source": "storefront",
  "store": "018e1234-0000-7000-a000-000000000001",
  "store_name": "Remi's Boutique",
  "store_email": "hello@remisboutique.com",
  "store_phone": "+2348012345678",
  "logo": "https://cdn.leyyow.com/stores/remis-boutique/logo.png",
  "location": "018e1234-0000-7000-a000-000000000200",
  "location_name": "Lagos HQ",
  "customer": "018e1234-0000-7000-a000-000000000300",
  "customer_name": "John Doe",
  "customer_phone": "+2348011111111",
  "customer_email": "john@example.com",
  "customer_address": "5 Test Street, Victoria Island, Lagos",
  "total_amount": "17500.00",
  "subtotal": "15000.00",
  "discount_amount": "0.00",
  "tax_amount": "1125.00",
  "tax_rate_used": "7.50",
  "total_paid": "0.00",
  "outstanding_balance": "17500.00",
  "payment_status": "unpaid",
  "payment_status_display": "Unpaid",
  "fulfilment_status": "pending",
  "fulfilment_status_display": "Pending",
  "fulfilment_method": "delivery",
  "delivery_fee": "1375.00",
  "manual_delivery_type": null,
  "tracking_number": null,
  "order_date": "2025-01-15",
  "has_shipping": false,
  "created_at": "2025-01-15T10:30:00Z",
  "shipping_details": null,
  "items": [
    {
      "uid": "018e1234-0000-7000-a000-000000000400",
      "variant": "018e1234-0000-7000-a000-000000000020",
      "variant_name": "Classic Ankara Dress — Small / Blue",
      "sku": "RB-ANKD-S-BLU",
      "quantity": "1.00",
      "unit_price": "15000.00",
      "total_price": "15000.00"
    }
  ]
}

{
  "detail": "Invalid or revoked API key.",
  "error_code": "AUTHENTICATION_FAILED"
}

{
  "detail": "Not found."
}

{
  "detail": "Rate limit exceeded. Please retry in 120 seconds.",
  "error_code": "ENDPOINT_THROTTLED"
}

GET

orders

{order_number}

Error

A valid request URL is required to generate request examples

{
  "uid": "018e1234-0000-7000-a000-000000000100",
  "order_number": "RB-20250115-0042",
  "source": "storefront",
  "store": "018e1234-0000-7000-a000-000000000001",
  "store_name": "Remi's Boutique",
  "store_email": "hello@remisboutique.com",
  "store_phone": "+2348012345678",
  "logo": "https://cdn.leyyow.com/stores/remis-boutique/logo.png",
  "location": "018e1234-0000-7000-a000-000000000200",
  "location_name": "Lagos HQ",
  "customer": "018e1234-0000-7000-a000-000000000300",
  "customer_name": "John Doe",
  "customer_phone": "+2348011111111",
  "customer_email": "john@example.com",
  "customer_address": "5 Test Street, Victoria Island, Lagos",
  "total_amount": "17500.00",
  "subtotal": "15000.00",
  "discount_amount": "0.00",
  "tax_amount": "1125.00",
  "tax_rate_used": "7.50",
  "total_paid": "0.00",
  "outstanding_balance": "17500.00",
  "payment_status": "unpaid",
  "payment_status_display": "Unpaid",
  "fulfilment_status": "pending",
  "fulfilment_status_display": "Pending",
  "fulfilment_method": "delivery",
  "delivery_fee": "1375.00",
  "manual_delivery_type": null,
  "tracking_number": null,
  "order_date": "2025-01-15",
  "has_shipping": false,
  "created_at": "2025-01-15T10:30:00Z",
  "shipping_details": null,
  "items": [
    {
      "uid": "018e1234-0000-7000-a000-000000000400",
      "variant": "018e1234-0000-7000-a000-000000000020",
      "variant_name": "Classic Ankara Dress — Small / Blue",
      "sku": "RB-ANKD-S-BLU",
      "quantity": "1.00",
      "unit_price": "15000.00",
      "total_price": "15000.00"
    }
  ]
}

{
  "detail": "Invalid or revoked API key.",
  "error_code": "AUTHENTICATION_FAILED"
}

{
  "detail": "Not found."
}

{
  "detail": "Rate limit exceeded. Please retry in 120 seconds.",
  "error_code": "ENDPOINT_THROTTLED"
}

Authorizations

Authorization

string

header

required

Authenticate using a Leyyow merchant API key.

Include the key in every request as a Bearer token:

Authorization: Bearer lyw_<your-secret-key>

Keys are scoped to a single store. All endpoints return data belonging to the store that issued the key — there is no X-Store-Id override.

Keys are created in the Leyyow merchant dashboard under Settings → Developer → API Keys.

Path Parameters

order_number

string

required

Response

Order detail.

Serializer for public order details

uid

string<uuid>

required

read-only

order_number

string

required

Unique order number

Maximum string length: 50

store

string<uuid>

required

Store where this order was placed

store_name

string

required

read-only

store_email

string<email>

required

read-only

store_phone

string

required

read-only

logo

string

required

read-only

location_name

string

required

read-only

customer_name

string

required

read-only

customer_phone

string

required

read-only

customer_email

string<email>

required

read-only

customer_address

string

required

read-only

total_paid

string

required

read-only

outstanding_balance

string

required

read-only

payment_status_display

string

required

read-only

fulfilment_status_display

string

required

read-only

manual_delivery_type

string

required

read-only

has_shipping

boolean

required

read-only

created_at

string<date-time>

required

read-only

shipping_details

string

required

read-only

items

object[]

required

read-only

Show child attributes

source

enum<string>

How the order was created

internal - Internal
storefront - Storefront
popup_storefront - Popup Storefront
popup_internal - Popup Internal

Available options:

internal,

storefront,

popup_storefront,

popup_internal

location

string<uuid> | null

Location where this order was placed

customer

string<uuid> | null

Customer who placed this order

total_amount

string<decimal> | null

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

subtotal

string<decimal>

Order total before discount and delivery fee

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

discount_amount

string<decimal>

Total discount amount applied

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

tax_amount

string<decimal>

Tax amount applied to this order

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

tax_rate_used

string<decimal> | null

Tax rate used when this order was created (e.g. 0.075 for 7.5%)

Pattern: ^-?\d{0,1}(?:\.\d{0,4})?$

payment_status

enum<string>

unpaid - Unpaid
partially_paid - Partially Paid
paid - Paid
refunded - Refunded

Available options:

unpaid,

partially_paid,

paid,

refunded

fulfilment_status

enum<string>

unfulfilled - Unfulfilled
fulfilled - Fulfilled
returned - Returned
partially_fulfilled - Partially Fulfilled
voided - Voided
cancelled - Cancelled

Available options:

unfulfilled,

fulfilled,

returned,

partially_fulfilled,

voided,

cancelled

fulfilment_method

enum<string>

How the order will be fulfilled

pickup - Pickup
delivery - Delivery

Available options:

pickup,

delivery

delivery_fee

string<decimal>

Delivery fee for this order

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

tracking_number

string

Maximum string length: 100

order_date

string<date> | null

Date when the order was placed (for recording past orders). Defaults to current date if not provided.

Getting Started

APIs

Authorizations

Path Parameters

Response