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 в формате Bearer <token>, где <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.

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

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/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.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 SKU was found in this team.",
  "instance": "/bundles/by-sku/SKU-123"
}

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