GET
/
api
/
orders
List all orders
curl --request GET \
  --url http://localhost:3000/api/orders \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "_id": "<string>",
      "orderNumber": "ORD-0001",
      "request": "<string>",
      "priority": 123,
      "customer": "<string>",
      "material": "<string>",
      "quantity": 2,
      "stations": [
        "<string>"
      ],
      "currentStationIndex": 1,
      "stationHistory": [
        {
          "station": "<string>",
          "enteredAt": "2023-11-07T05:31:56Z",
          "exitedAt": "2023-11-07T05:31:56Z",
          "completedBy": "<string>"
        }
      ],
      "stationData": {},
      "paneCount": 0,
      "panesCompleted": 0,
      "progressPercent": 0,
      "stationBreakdown": {},
      "notes": "<string>",
      "claim": "<string>",
      "withdrawal": "<string>",
      "assignedTo": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "totalPages": 3
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

stationId
string

Filter orders that include this station in their route

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
limit
integer
default:20

Items per page (clamped to 1–100)

Required range: 1 <= x <= 100
sort
string
default:-createdAt

Sort field. Prefix with - for descending (e.g. -createdAt, name)

Response

List of orders

success
boolean
Example:

true

message
string
data
object[]
pagination
object