Orders API

List Orders

GET /api/v1/orders

Query Parameters

Parameter	Type	Default	Description
limit	integer	50	Items per page (1-200)
cursor	string	—	ISO timestamp for pagination
status	string	—	Filter by status
source	string	—	Filter by source (pos or online)
since	string	—	Only orders created after this ISO date

Response

{
  "data": [
    {
      "id": "order-uuid-1",
      "source": "online",
      "status": "pending",
      "payment_status": "paid",
      "payment_method": "card",
      "customer_name": "Ahmed Mohamed",
      "customer_phone": "+218912345678",
      "subtotal": 75.00,
      "discount": 5.00,
      "delivery_fee": 10.00,
      "total": 80.00,
      "items": [
        {
          "product_name": "Premium Arabic Coffee",
          "variant_name": "250g",
          "quantity": 3,
          "unit_price": 25.00,
          "total": 75.00
        }
      ],
      "last_modified": "2026-04-20T14:35:00Z"
    }
  ]
}

Get Single Order

GET /api/v1/orders/:id

Bulk Export

GET /api/v1/orders/export

Same NDJSON format as products export.

Order Statuses

Status	Description
pending	New order awaiting processing
processing	Being prepared
preparing	Restaurant/food: being cooked
ready	Ready for pickup/delivery
shipped	Shipped to customer
delivered	Delivery confirmed
completed	Fully completed
cancelled	Cancelled
refunded	Refunded

Payment Statuses

Status	Description
pending	Awaiting payment
paid	Payment confirmed
failed	Payment failed
expired	Payment window expired