Orders API

Phase 2

This documentation is a preview. The API is currently in development.

Endpoints

GET /v1/orders

Query parameters:

Parameter	Type	Description
`status`	string	Filter by status (pending, processing, delivered, etc.)
`delivery_method`	string	Filter by method (local_delivery, pickup, shipping)
`date_from`	string	Start date (ISO 8601)
`date_to`	string	End date (ISO 8601)
`page`	integer	Page number (default: 1)
`per_page`	integer	Results per page (default: 50, max: 200)

GET /v1/orders/{order_id}

PATCH /v1/orders/{order_id}/status

Request body:

{
  "status": "out_for_delivery",
  "note": "Driver en route"
}

PATCH /v1/orders/{order_id}

Request body:

{
  "delivery_method": "pickup",
  "scheduled_date": "2026-03-15",
  "time_slot": "14:00-16:00"
}

All responses follow a standard envelope:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 234
  }
}

{
  "success": false,
  "error": {
    "code": "ORDER_NOT_FOUND",
    "message": "Order with ID se-99999 not found"
  }
}