Get Bundle Potential
GET/api/v2/products/:product/bundle-potential
Get bundle assembly potential — how many units of a bundle or kit can be assembled from current component availability.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Only stock that sits together counts: each warehouse is assessed on its own (warehouses[], sorted by max_assemblable descending, each with its per-component detail and bottleneck flags), and the overall max_assemblable is the sum of the warehouse figures — never the minimum of company-wide component totals, which would count units split across warehouses.
Per component in components[]:
available_inventory— total available stock across all warehouses (shown as stock, not as buildable sets).max_assemblable— how many sets this component alone could cover, summed over the warehouses that hold it.is_bottleneck— true when the component limits assembly in at least one warehouse (or no warehouse holds it).
Returns an empty result for products that are not bundles or kits.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.