BizKitHub
DocsAPI ReferenceWarehouse Production/bff/warehouse/production/order/detail

/bff/warehouse/production/order/detail

Movements of the order: GET /bff/warehouse/movement/list?productionOrderId=…

Warehouse productiongetBffWarehouseProductionOrderDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

Production order id.

Exampleexample_id

Response schema

1 status code documented

200Success
idnumberRequired
numberstringRequired
ExampleVP-2026-0001
status"planned" | "in_progress" | "completed" | "cancelled"Required
productobjectRequired
productIdnumberRequired
productVariantIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
productCodestringRequired
variantCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
labelstringRequired
stockUnitstring | nullRequired

Stock unit ("m", "ks", …). NULL = pieces.

One of 2:
Variant 1
string
Variant 2
null
trackLotsbooleanRequired
costnumber | nullRequired

Catalogue cost (variant.cost ?? product.cost).

One of 2:
Variant 1
number
Variant 2
null
productionYieldnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
quantitynumberRequired
sourceWarehouseIdnumberRequired
sourceWarehouseNamestringRequired
targetWarehouseIdnumberRequired
targetWarehouseNamestringRequired
targetLocationIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
targetLocationCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
targetLotCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
notestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
materialCostnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
labourCostnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
unitCostnumber | nullRequired

Cost per produced unit (FIFO material + labour), set on completion.

One of 2:
Variant 1
number
Variant 2
null
costCurrencystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
createdByMemberNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
startedDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
completedDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
cancelledDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
insertedDatestringRequired
itemsobject[]Required
Each array item:
idnumberRequired
kind"material" | "labour"Required
positionnumberRequired
quantitynumberRequired

Material: units for the whole order. Labour: hours.

componentobject | nullRequired
One of 2:
Variant 1
productIdnumberRequired
productVariantIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
productCodestringRequired
variantCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
labelstringRequired
stockUnitstring | nullRequired

Stock unit ("m", "ks", …). NULL = pieces.

One of 2:
Variant 1
string
Variant 2
null
trackLotsbooleanRequired
costnumber | nullRequired

Catalogue cost (variant.cost ?? product.cost).

One of 2:
Variant 1
number
Variant 2
null
productionYieldnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
Variant 2
null
labourTypeIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
labourNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
hourlyRatenumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
sourceLocationIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
sourceLocationCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lotCodestring | nullRequired

Pinned lot; NULL = automatic, oldest first.

One of 2:
Variant 1
string
Variant 2
null
totalCostnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
reservedQuantitynumberRequired
shortagesobject[]Required

Material missing right now to start (planned) or complete (in progress). Empty = OK.

Each array item:
productIdnumberRequired
productVariantIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
labelstringRequired
stockUnitstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lotCodestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
requirednumberRequired
availablenumberRequired
missingnumberRequired

Response example

application/json
{
  "id": 0,
  "number": "VP-2026-0001",
  "product": {
    "productId": 0,
    "productCode": "example_productCode",
    "label": "example_label",
    "trackLots": false
  },
  "quantity": 0,
  "sourceWarehouseId": 0,
  "sourceWarehouseName": "example_sourceWarehouseName",
  "targetWarehouseId": 0,
  "targetWarehouseName": "example_targetWarehouseName",
  "insertedDate": "example_insertedDate",
  "items": [
    {
      "id": 0,
      "position": 0,
      "quantity": 0,
      "reservedQuantity": 0
    }
  ],
  "shortages": [
    {
      "productId": 0,
      "label": "example_label",
      "required": 0,
      "available": 0,
      "missing": 0
    }
  ]
}

Request example

GET /bff/warehouse/production/order/detail

get
curl -X GET "https://api.bizkithub.com/bff/warehouse/production/order/detail?id=example_id" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key