Retrieving BOM Variants
Named alternate BOMs for a SKU (e.g. "Summer" vs "Winter"). At most one is active; when none is, new MOs use the base BOM.
Use GET /api/v1/bom-variants to page through every record in your organization, or GET /api/v1/bom-variants/{id} to fetch a single record with its related data. The id is a UUID, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
See which alternate BOM (Summer vs. Winter) is active so production builds the right version.
Keep a backup BOM for when a material is out, and check which one MOs will use.
Pull each variant's lines to see which recipe is cheaper to build.
List variants per SKU to track which recipes exist and which one is live.
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)