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

인증

Authorizationstring필수

Bearer <token> 형식의 Bearer 인증 헤더입니다. <token>에는 API 토큰을 넣습니다.

쿼리 파라미터

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.

응답

200A page of bundles.

itemsarray of SimpleBundle필수

Items in this page. Default ordering is by id ascending; see the resource’s list endpoint description for any per-resource overrides.

하위 속성 보기

idintegerminimum 0, maximum 2147483647필수

Bundle id.

namestring필수

Bundle display name.

skustring필수

Stock Keeping Unit. Unique within the team.

barcodestring필수

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

coststring필수

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

pricestring필수

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

photo_urlstringnullable필수

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

memostring필수

Free-text memo. Empty string when not set.

count_of_componentsintegerminimum 0, maximum 9007199254740991필수

Number of active component rows in the bundle.

countintegerminimum 0, maximum 9007199254740991필수

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

limitintegerminimum 0, maximum 9007199254740991필수

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullable필수

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

has_moreboolean필수

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.

idstring필수

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.

typestring필수

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

가능한 값/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

titlestring필수

Human-readable summary of the error, in English.

correlationIDstring필수

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.

instancestring필수

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

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 /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

하위 속성 보기

patharray of string | number필수

messagestring필수

429Rate limit exceeded. Check RateLimit, Retry-After, and X-RateLimit-* response headers before retrying.

idstring필수

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.

typestring필수

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

titlestring필수

Human-readable summary of the error, in English.

correlationIDstring필수

instancestring필수

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

errorsarray of object

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.

하위 속성 보기

patharray of string | number필수

messagestring필수

요청 예시

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>

응답 예시

{
  "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
}