Error

A valid request URL is required to generate request examples

{
  "order": {
    "uid": "018e1234-0000-7000-a000-000000000100",
    "order_number": "RB-20250115-0043",
    "payment_status": "unpaid",
    "total_amount": "17500.00",
    "created_at": "2025-01-15T10:35:00Z"
  },
  "payment": {
    "payment_link": "https://checkout.paystack.com/7f3k9xp2abc"
  }
}

{
  "detail": {
    "items": [
      "One or more variants do not belong to this store."
    ]
  }
}

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

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

Orders

Create an order

Creates an order and initialises a Paystack payment session.

The response includes:

order — a summary of the created order.
payment.payment_link — the Paystack checkout URL to redirect the customer to.

Delivery modes (fulfilment_method):

Value	Meaning
`pickup`	Customer collects from the store
`delivery`	Manual or ShipBubble delivery

For manual delivery, pass manual_delivery_option (UID of a StoreDeliveryOptions record from GET /delivery-options).

For ShipBubble delivery, pass courier and rate from POST /shipping-quotes.

All item variants must belong to the authenticated store.

POST

orders

Error

A valid request URL is required to generate request examples

{
  "order": {
    "uid": "018e1234-0000-7000-a000-000000000100",
    "order_number": "RB-20250115-0043",
    "payment_status": "unpaid",
    "total_amount": "17500.00",
    "created_at": "2025-01-15T10:35:00Z"
  },
  "payment": {
    "payment_link": "https://checkout.paystack.com/7f3k9xp2abc"
  }
}

{
  "detail": {
    "items": [
      "One or more variants do not belong to this store."
    ]
  }
}

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

{
  "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.

Body

Extends the storefront order serializer for the public API.

The only addition is store-scoped variant validation: every item variant must belong to the authenticated store. All other logic (pricing, stock, delivery, coupon, Paystack init) is inherited unchanged.

customer_name

string

required

write-only

customer_email

string<email>

required

write-only

items

object[]

required

write-only

Show child attributes

payment_source

enum<string>

required

paystack - paystack

Available options:

paystack

customer_phone

string

write-only

delivery_address

string | null

delivery_method

string | null

manual_delivery_option

string<uuid> | null

Manual delivery option for this order

fulfilment_method

string

default:pickup

courier

any

rate

string

Maximum string length: 100

cart

string<uuid> | null

Cart this order came from (one cart, one order)

note

string

Optional note; stored on the order (not as a memo).

coupon_code

string

write-only

Maximum string length: 50

Response

Order created and payment initialised.

order

object

required

Show child attributes

payment

object

required

Show child attributes

Getting Started

APIs

Create an order

Authorizations

Body

Response