Runs API

Scope required

All runs endpoints require the runs:read scope.

List Runs

http

GET /api/v2/runs?status=IN_PROGRESS&page=0&size=20

Returns paginated production runs for your organisation. External status values: PENDING (optimised, not yet started), IN_PROGRESS, CLOSED (completed), CANCELLED.

json

{
  "success": true,
  "data": {
    "data": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "IN_PROGRESS",
        "machineId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "machineName": "Winder A",
        "paperType": "Kraft",
        "gsmValue": 80,
        "totalWastePct": 0.38,
        "createdAt": "2026-06-06T05:45:00"
      }
    ],
    "meta": { "page": 0, "size": 20, "total": 7, "totalPages": 1 }
  }
}

Get Single Run

http

GET /api/v2/runs/{id}

Returns full run detail including totalPaperConsumedMT, totalProductMT, and notes. Production runs are created and managed exclusively through the Deckle Plus web application. The external API provides read access only.

Run Status Vocabulary

The external API uses a simplified status set that maps from internal states:

PENDING: run has been optimised and is waiting to start on the floor
IN_PROGRESS: an operator has started the run
CLOSED: all patterns are complete and challans have been generated
CANCELLED: the run was cancelled before completion

Pattern Data

http

GET /api/v2/runs/{id}/patterns

Returns all cutting patterns for the run in execution order. Each pattern includes its waste percentage and the paper cuts (order width allocations) that make up that pattern pass.

json

{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-...",
      "sequenceNumber": 1,
      "wastePct": 0.28,
      "wasteMm": 100,
      "widthUsedMm": 3500,
      "runForMT": 5.0,
      "status": "COMPLETED",
      "paperCuts": [
        { "orderWidthId": "uuid", "widthMm": 900, "stripCount": 3 },
        { "orderWidthId": "uuid", "widthMm": 800, "stripCount": 2 }
      ]
    }
  ]
}

Orders API

Webhooks

Was this page helpful?

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

Give Feedback