Skip to main content

WorkOrder

A production work order — an instruction to manufacture a specific quantity of a SKU.

idstring

Unique identifier for the work order.

Example: 6073
orderNumberstring

Human-readable work order number displayed in Keychain OS.

Example: WO-2025-0312
skuIdstring

Reference to the SKU being produced.

skuNamestring

Display name of the SKU being produced.

Example: Roasted Garlic Hummus
customerIdstring

Reference to the customer this production run is for. Null if the work order is not linked to a specific customer.

customerNamestring

Display name of the customer.

Example: Sunrise Craft Beverages
quantitynumber

Total quantity to produce across all batches.

Example: 500
unitstring

Unit of measure for the production quantity.

Example: lbs
numberOfBatchesinteger

How many batches this work order is split into. Total quantity equals numberOfBatches x batchVolume.

Example: 1
batchVolumenumber

The quantity produced per batch.

Example: 500
orderDatestring<date>

Date the work order was created (ISO 8601).

Example: 2025-03-01
dueDatestring<date>

Target completion date for the production run (ISO 8601).

Example: 2025-03-15
prioritystring

Production priority. Higher-priority orders are typically scheduled first.

Possible values: [low, medium, high, urgent]

Example: medium
statusstring

Current status of the work order:

  • draft — created but not yet scheduled.
  • scheduled — assigned a production date and production line.
  • in_progress — production has started.
  • completed — production finished and output recorded.
  • cancelled — work order was cancelled before completion.

Possible values: [draft, scheduled, in_progress, completed, cancelled]

Example: completed
salesOrderReferencestring

The sales order number that triggered this work order. Null if the work order was created manually.

Example: SO-2025-0189
notesstring

Free-text notes attached to the work order.

WorkOrder
{
  "id": "6073",
  "orderNumber": "WO-2025-0312",
  "skuId": "string",
  "skuName": "Roasted Garlic Hummus",
  "customerId": "string",
  "customerName": "Sunrise Craft Beverages",
  "quantity": 500,
  "unit": "lbs",
  "numberOfBatches": 1,
  "batchVolume": 500,
  "orderDate": "2025-03-01",
  "dueDate": "2025-03-15",
  "priority": "medium",
  "status": "completed",
  "salesOrderReference": "SO-2025-0189",
  "notes": "string"
}