Retrieving Bill of Materials
Bill-of-materials lines. Each row is one ingredient product used to make a finished-good SKU. variant_id null = the SKU's base BOM; otherwise the line belongs to that BOM variant. Kits use the same lines for their contents. GET /skus/{id} also returns a SKU's full BOM.
Use GET /api/v1/bom-lines to page through every record in your organization, or GET /api/v1/bom-lines/{id} to fetch a single record. The id is a UUID, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
Send each finished good's ingredient list to your ERP so costing and planning use the same recipe.
Compare BOM quantities against stock to make sure you have every ingredient before you start.
Filter by ingredient_product_id to see every product affected when a material changes or runs short.
Multiply each line by its ingredient cost to get a true cost per finished unit.
Required Headers
Every request must include the following:
Requests missing either header will return 401 Unauthorized
Example Request
Response Schema
Filters
Errors
Cloudbox uses standard HTTP status codes to indicate API success or failure:
- 200–299 – Request succeeded
- 400 – Bad request (missing parameters, invalid values)
- 401 – Unauthorized (missing or invalid API keys)
- 404 – Resource not found
- 429 – Too many requests (rate limited)