BizKitHub
DocsAPI ReferenceWarehouse Production/bff/warehouse/production/bom

/bff/warehouse/production/bom

Bill of materials (kusovník) of a product

Warehouse productiongetBffWarehouseProductionBom

Parameters

2 query

Query parameters

· 2
productCodestringRequired

Product code.

Exampleexample_productCode
productVariantCodestringOptional

Variant code; a variant without its own BOM inherits the product BOM.

Exampleexample_productVariantCode

Response schema

1 status code documented

200Success
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
yieldPerRunnumberRequired

Units one BOM run produces.

linesobject[]Required
Each array item:
idnumberRequired
kind"material" | "labour"Required
positionnumberRequired
quantitynumberRequired

Per run: units of the component, or labour hours.

notestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
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
labourTypeobject | nullRequired
One of 2:
Variant 1
idnumberRequired
codestringRequired
namestringRequired
hourlyRatenumberRequired

Per hour, organisation default currency.

notestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
estimatedUnitCostnumberRequired

Estimate per produced unit from catalogue costs + labour rates.

estimateIncompletebooleanRequired

Some material has no catalogue cost; the estimate is too low.

Response example

application/json
{
  "product": {
    "productId": 0,
    "productCode": "example_productCode",
    "label": "example_label",
    "trackLots": false
  },
  "yieldPerRun": 0,
  "lines": [
    {
      "id": 0,
      "position": 0,
      "quantity": 0
    }
  ],
  "estimatedUnitCost": 0,
  "estimateIncomplete": false
}

Request example

GET /bff/warehouse/production/bom

get
curl -X GET "https://api.bizkithub.com/bff/warehouse/production/bom?productCode=example_productCode&productVariantCode=example_productVariantCode" \
  -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