Get a bundle by SKU

Looks up a bundle by SKU (case-sensitive) and returns the same payload as GET /bundles/{bundle_id}.

URL-encode special characters in the SKU.

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

認証

Authorizationstring必須

Bearer <token> 形式の Bearer 認証ヘッダーです。<token> には APIトークンを指定します。

パスパラメータ

skustringmin length 1, max length 255必須

Bundle SKU (case-sensitive). URL-encode special characters such as #, %, /, or spaces.

レスポンス

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.

400Team is not in LOCATION mode.

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. 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.

プロパティを表示

patharray of string | number必須

messagestring必須

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).

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. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

プロパティを表示

patharray of string | number必須

messagestring必須

404No bundle with the given SKU 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. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

プロパティを表示

patharray of string | number必須

messagestring必須

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.

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. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

プロパティを表示

patharray of string | number必須

messagestring必須

リクエスト

curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/bundles/by-sku/{sku}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"

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

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

レスポンス

{
  "item": {
    "id": 4042,
    "name": "Starter Kit",
    "sku": "BUNDLE-STARTER",
    "barcode": "8801234567890",
    "cost": "12.5",
    "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_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/by-sku/SKU-123"
}

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

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/not-found",
  "title": "No bundle with the given SKU was found in this team.",
  "instance": "/bundles/by-sku/SKU-123"
}

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