List bundles

Returns a cursor-paginated list of active bundles.

Bundle stock is not tracked directly; stock belongs to the underlying component items.

GEThttps://rest.boxhero-app.com/v1/bundles

Xác thực

Authorizationstringbắt buộc

Header xác thực Bearer có dạng Bearer <token>, trong đó <token> là token API của bạn.

Tham số truy vấn

bundle_idsinteger | array of integer

Filter the list to specific bundle ids. Pass repeatedly (?bundle_ids=1&bundle_ids=2) or as a single value.

cursorintegerminimum 0, maximum 2147483647

Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call.

limitintegerminimum 1, maximum 100

Page size. Accepts 1–100; defaults to 100.

Phản hồi

200A page of bundles.

itemsarray of SimpleBundlebắt buộc

Items in this page. Most resources are ordered by id ascending; transactions and orders/returns are ordered by time descending (see each list endpoint).

Hiển thị thuộc tính

idintegerminimum 0, maximum 2147483647bắt buộc

Bundle id.

namestringbắt buộc

Bundle display name.

skustringbắt buộc

Stock Keeping Unit. Unique within the team.

barcodestringbắt buộc

Primary barcode for the bundle. Empty string when not assigned.

coststringbắt buộc

Cost per bundle, as a decimal string. Independent from component item costs.

pricestringbắt buộc

Selling price per bundle, as a decimal string. Independent from component item prices.

photo_urlstringnullablebắt buộc

URL of the bundle photo. null when no photo is set.

memostringbắt buộc

Free-text memo. Empty string when not set.

count_of_componentsintegerminimum 0, maximum 9007199254740991bắt buộc

Number of active component rows in the bundle.

countintegerminimum 0, maximum 9007199254740991bắt buộc

Number of items in this page (items.length).

limitintegerminimum 0, maximum 9007199254740991bắt buộc

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullablebắt buộc

Cursor to pass as cursor in the next request. null when has_more is false.

has_morebooleanbắt buộc

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 (most resources: id ascending; transactions and orders/returns: time descending).

400Team is not in LOCATION mode.

idstringbắt buộc

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.

typestringbắt buộc

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

Giá trị có thể có/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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

Request correlation id (rq_ followed by 32 lowercase hex chars, no dashes — e.g. rq_01abf3...). Identical to the X-Correlation-Id response header. A client-supplied X-Correlation-Id request header (at most 128 chars of A-Z a-z 0-9 . _ : / = -) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated rq_… id.

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

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.

errorsarray of object

Field-level error details. Present on request-validation /errors/invalid-request (400) responses. Absent on malformed-JSON 400, 413 body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include 403). Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

401Missing, invalid, or revoked API token. /errors/tokens/required when no Bearer token is sent; /errors/tokens/invalid when the token is unknown or revoked (a revoked token may keep working for up to 60 seconds because validation results are cached).

idstringbắt buộc

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.

typestringbắt buộc

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

429Rate limit exceeded. Limits are per team and shared by all of the team's API tokens: 5 requests per second and 300 requests per minute. The RateLimit and X-RateLimit-* headers reflect the per-minute window; check them and Retry-After before retrying. This status is also returned when the client IP exceeds 30 failed authentication attempts within 60 seconds, even if the token is valid.

idstringbắt buộc

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.

typestringbắt buộc

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

Yêu cầu

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 os
import 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.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>

Phản hồi

{
  "items": [
    {
      "id": 4042,
      "name": "Starter Kit",
      "sku": "BUNDLE-STARTER",
      "barcode": "8801234567890",
      "cost": "12.5",
      "price": "29.99",
      "photo_url": null,
      "memo": "",
      "count_of_components": 2
    }
  ],
  "count": 1,
  "limit": 100,
  "cursor": 4042,
  "has_more": false
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/invalid-team-mode",
  "title": "This API is only available in Location mode. For Basic or Unit mode, please contact support.",
  "instance": "/bundles"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "instance": "/bundles",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/bundles",
  "retryAfter": 60
}