Orders API

Orders API

Scope required

Read endpoints require the orders:read scope. Create, update, and delete require orders:write.

List Orders

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

Returns a paginated list of live orders scoped to your organisation. Supported query params: status (DRAFT | CONFIRMED | IN_PROGRESS | COMPLETED | DISPATCHED | CANCELLED), page (0-indexed, default 0), size (default 20, max 100).

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": 0, "size": 50, "total": 142, "totalPages": 3 }
  }
}

Get Single Order

http
GET /api/v2/orders/{id}

Returns full order detail including all order widths. The response includes a orderWidths array with width, paper type, GSM, weight, and completion status per width.

Update Order

http
PATCH /api/v2/orders/{id}

Supports partial updates. Only deliveryDate and notes can be updated after creation. Orders allocated to an active production run cannot be modified.

Delete Order

http
DELETE /api/v2/orders/{id}

Soft-deletes the order. It remains visible in history but is removed from the active order queue. Orders allocated to a run cannot be deleted.

Previous

Authentication

Next

Runs API

Was this page helpful?

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

Give Feedback