Skip to main content
Base path: /production-output (relative to your instance’s /api/v2). The standard endpoints provide reads and writes, subject to the constraints below. Search columns: identifier

Fields

Declarations and actual production

Supply itemId and exactly one of routeDeliverableId or orderDeliverableId. That owner must be the root route or order, rather than a phase, stage, or step. A route declaration requires a positive producedPerUnit; quantity does not substitute for it. An order declaration may omit quantity when its plan is not known, but an explicit value must be positive. These rows describe planned output. Creating one does not post stock. POST /production/produce records output, and POST /production/consume records input usage. They are separate operations: producing does not automatically consume.
quantityProduced is the run multiplier for ratio declarations, defaulting to 1; it is not necessarily the quantity posted. When outputs is omitted, every configured declaration posts its default (producedPerUnit × quantityProduced, or its remaining planned quantity). With no configured declarations, name items explicitly through outputs or outputItemId; the service creates ad-hoc declarations for them. When declarations already exist, an explicit outputs list may name only those items. An empty outputs array is rejected. For consumption, lines provides per-item quantity overrides for the node’s own BOM lines. Items outside that BOM are ignored. Omit lines to draw the full recipe; an empty array is rejected. Pass fromLocationId, or make sure each stock-drawing item has a default location, so the ledger knows where to draw. Correct a recorded actual with POST /production/adjust-actual: { "stampDeliverableId": "<uuid>", "kind": "consume", "itemId": "<uuid>", "delta": -2 }. kind is consume or produce; the nonzero signed delta adds or reverses usage/output. These actions return { "value": ... } and require item update permission. GET /production/order/{id}/status and GET /production/order/{id}/entries read an order’s production status and trace. Use the order deliverable ID.

Archive and restore

DELETE archives this resource. Restore it with PATCH /production-output/{id} and { "isArchived": false }. See archiving and deleting.