Get a bundle

Returns a single active bundle with its component items.

Components may reference deleted items, which are marked with deleted: true.

GEThttps://rest.boxhero-app.com/v1/bundles/{bundle_id}

授權

Authorizationstring必填

Bearer <token> 格式的 Bearer 驗證標頭，其中 <token> 為您的 API 權杖。

路徑參數

bundle_idintegerminimum 0, maximum 2147483647必填

回應

200The requested bundle.

itemBundle必填

A bundle with its component items. Bundles have no stock of their own; inventory is tracked at the component-item level.

顯示屬性

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.

componentsarray of BundleComponent必填

Component list. Bundles cannot contain other bundles.

顯示屬性

itemExtendedItemEntity必填

Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

顯示屬性

idintegerminimum 0, maximum 2147483647必填

Item or bundle id.

namestring必填

Display name.

skustring必填

SKU. Empty string when unset.

barcodestring必填

Barcode. Empty string when unset.

deletedboolean必填

Whether the underlying item or bundle is deleted.

quantitynumber必填

Quantity of this item required per bundle.

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必填

404No bundle with the given id was found in this team.

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必填

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/{bundle_id}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"

const response = await fetch("https://rest.boxhero-app.com/v1/bundles/{bundle_id}", {
  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/{bundle_id}",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()

GET /v1/bundles/{bundle_id} HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>

回應

{
  "item": {
    "id": 4042,
    "name": "Starter Kit",
    "sku": "BUNDLE-STARTER",
    "barcode": "8801234567890",
    "cost": "12.50",
    "price": "29.99",
    "photo_url": null,
    "memo": "",
    "count_of_components": 2,
    "components": [
      {
        "item": {
          "id": 14290445,
          "name": "Finish Setting Powder",
          "sku": "SKU-12345678",
          "barcode": "2097678335587",
          "deleted": false
        },
        "quantity": 1
      },
      {
        "item": {
          "id": 14290446,
          "name": "Hydrating Face Toner",
          "sku": "SKU-12345679",
          "barcode": "2097678335588",
          "deleted": false
        },
        "quantity": 2
      }
    ]
  }
}

{
  "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/not-found",
  "title": "No bundle with the given id was found in this team.",
  "instance": "/bundles/12345"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/bundles/12345",
  "retryAfter": 60
}