Orders & Customers

Scope

These endpoints need orders:read or customers:read. The API is read-only — orders and customers are created in the web app.

List Orders

http

GET /api/v2/orders?page=1&size=50&status=CONFIRMED

Query params: page (1-indexed, default 1), size (default 20, max 100), status (DRAFT · CONFIRMED · IN_PROGRESS · COMPLETED · DISPATCHED · CANCELLED). Newest first.

json

{
  "success": true,
  "data": {
    "data": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "externalOrderNumber": "PO-2026-001",
        "status": "CONFIRMED",
        "orderDate": "2026-06-01",
        "deliveryDate": "2026-06-15",
        "customerId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "customerName": "Balaji Packaging",
        "totalWeightMT": 12.5,
        "createdAt": "2026-06-06T08:30:00"
      }
    ],
    "meta": { "page": 1, "size": 50, "total": 142, "totalPages": 3 }
  }
}

Get an Order

http

GET /api/v2/orders/{id}

The summary fields above plus notes and an orderWidths array — each with widthMm, weightMT, completedMT, status, paperTypeName and gsmValue.

Customers

http

GET /api/v2/customers?page=1&size=50
GET /api/v2/customers/{id}

Returns customer id, name and short identifier. Tax fields are not exposed by the API.

Authentication

Runs, Patterns & Master Data

Was this page helpful?

Something unclear or missing? Reach out and we'll update this page.

Give Feedback