List bundles
Returns a cursor-paginated list of active bundles.
Bundle stock is not tracked directly; stock belongs to the underlying component items.
https://rest.boxhero-app.com/v1/bundlesAutorisation
Section intitulée « Autorisation »En-tête d’authentification Bearer au format Bearer <token>, où <token> est votre jeton d’API.
Paramètres de requête
Section intitulée « Paramètres de requête »Filter the list to specific bundle ids. Pass repeatedly (?bundle_ids=1&bundle_ids=2) or as a single value.
Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call.
Page size. Accepts 1–100; defaults to 100.
Réponses
Section intitulée « Réponses »200A page of bundles.
Items in this page. Default ordering is by id ascending; see the resource’s list endpoint description for any per-resource overrides.
Afficher les propriétés
Bundle id.
Bundle display name.
Stock Keeping Unit. Unique within the team.
Primary barcode for the bundle. Empty string when not assigned.
Cost per bundle, as a decimal string. Independent from component item costs.
Selling price per bundle, as a decimal string. Independent from component item prices.
URL of the bundle photo. null when no photo is set.
Free-text memo. Empty string when not set.
Number of active component rows in the bundle.
Number of items in this page (items.length).
Page size used to build this response.
Cursor to pass as cursor in the next request. null when has_more is false.
True when another page is available. The cursor is monotonic — pass it as cursor on the next request to advance the page. Direction follows each resource’s ordering (default: id ascending).
401Missing or invalid API token.
Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Valeurs possibles/errors/not-found/errors/invalid-request/errors/invalid-team-mode/errors/tokens/invalid/errors/tokens/required/errors/too-many-requests/errors/core/usage-limit-exceeded/errors/core/forbidden/errors/core/unhandled/errors/unhandled
Human-readable summary of the error, in English.
Request correlation id (rq_ followed by 32 lowercase hex chars, no dashes — e.g. rq_01abf3...). Identical to the X-Correlation-Id response header. Pass an X-Correlation-Id request header to thread your trace through to ours.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. not-available-for-api-token on 403). Use this for fine-grained branching after dispatching on type.
Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.
Afficher les propriétés
429Rate limit exceeded. Check RateLimit, Retry-After, and X-RateLimit-* response headers before retrying.
Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.
Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.
Valeurs possibles/errors/not-found/errors/invalid-request/errors/invalid-team-mode/errors/tokens/invalid/errors/tokens/required/errors/too-many-requests/errors/core/usage-limit-exceeded/errors/core/forbidden/errors/core/unhandled/errors/unhandled
Human-readable summary of the error, in English.
Request correlation id (rq_ followed by 32 lowercase hex chars, no dashes — e.g. rq_01abf3...). Identical to the X-Correlation-Id response header. Pass an X-Correlation-Id request header to thread your trace through to ours.
Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.
Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. not-available-for-api-token on 403). Use this for fine-grained branching after dispatching on type.
Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.
Afficher les propriétés
Requête
curl --request GET \ --url 'https://rest.boxhero-app.com/v1/bundles' \ --header "Authorization: Bearer $BOXHERO_API_TOKEN"const response = await fetch("https://rest.boxhero-app.com/v1/bundles", { method: "GET", headers: { Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://rest.boxhero-app.com/v1/bundles", headers={ "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"], },)data = response.json()GET /v1/bundles HTTP/1.1Host: rest.boxhero-app.comAuthorization: Bearer <token>Réponse
{ "items": [ { "id": 4042, "name": "Starter Kit", "sku": "BUNDLE-STARTER", "barcode": "8801234567890", "cost": "12.50", "price": "29.99", "photo_url": null, "memo": "", "count_of_components": 2 } ], "count": 1, "limit": 100, "cursor": 4042, "has_more": false}{ "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a", "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2", "type": "/errors/tokens/required", "title": "Missing API token. Provide a Bearer token in the Authorization header.", "example": "Bearer wqnot0dlysdg5vymubzi4kiv"}{ "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a", "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2", "type": "/errors/too-many-requests", "title": "Too many requests.", "instance": "/bundles", "retryAfter": 60}