Get an item

Returns a single item by id.

The response includes a quantities per-location breakdown alongside the rolled-up quantity; pass location_ids to scope the breakdown to specific locations.

GEThttps://rest.boxhero-app.com/v1/items/{item_id}

認証

Authorizationstring必須

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

パスパラメータ

item_idintegerminimum 0, maximum 2147483647必須

クエリパラメータ

location_idsinteger | array of integer

Scope the quantities breakdown (and the quantity total) to specific locations. Only requested locations with nonzero stock appear in quantities. When omitted, quantities covers every active location where the item has nonzero stock.

レスポンス

200The requested item.

itemItem必須

An item — the smallest unit of inventory tracked by BoxHero. Each item carries an SKU, barcode, cost, selling price, on-hand quantity, and any custom attributes you have defined.

プロパティを表示

idintegerminimum 0, maximum 2147483647必須

Item id.

namestring必須

Item display name.

skustring必須

Stock Keeping Unit. Unique within the team. Every item has one; a random SKU-XXXXXXXX is generated when none is given on creation.

barcodestring必須

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

photo_urlstringnullable必須

URL of the item's photo. null when no photo is set.

attrsarray of ItemAttr必須

Custom attribute values attached to the item. Manage the underlying attribute specs via /item-attrs.

プロパティを表示

idintegerminimum 0, maximum 2147483647必須

Attribute spec id (see GET /item-attrs).

typestring必須

Value type of this attribute (text, date, number, or barcode). File-type attributes are app-only and are never returned here.

指定可能な値textdatenumberbarcode

namestring必須

Attribute display name.

valuestring | number必須

Attribute value. text/date/barcode are returned as strings (date as YYYY-MM-DD); number is returned as a number.

coststring必須

Cost per unit, as a decimal string (range ±999,999,999.999, up to 3 decimal places). Defaults to "0" when not assigned.

pricestring必須

Selling price per unit, as a decimal string (range ±999,999,999.999, up to 3 decimal places). Defaults to "0" when not assigned.

quantitynumber必須

Total on-hand quantity for this item, summed across all locations. When location_ids is passed, summed over those locations only.

quantitiesarray of object必須

Per-location stock breakdown. Always present. Only locations that are not deleted and where this item has nonzero stock appear. With location_ids set, only the requested locations are considered. Empty array when the item has no stock at any considered location.

プロパティを表示

location_idintegerminimum 0, maximum 2147483647必須

Location id where this stock breakdown applies.

quantitynumber必須

On-hand quantity of this item at the location.

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

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

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

レスポンス

{
  "item": {
    "id": 14290445,
    "name": "Finish Setting Powder",
    "sku": "SKU-12345678",
    "barcode": "2097678335587",
    "photo_url": "https://your.image-server.com/item_image.png",
    "attrs": [
      {
        "id": 485697,
        "type": "text",
        "name": "Brand",
        "value": "Acme Beauty"
      },
      {
        "id": 413101,
        "type": "date",
        "name": "Expiration Date",
        "value": "2026-12-31"
      },
      {
        "id": 485086,
        "type": "number",
        "name": "Minimum Stock",
        "value": 20
      }
    ],
    "cost": "8.5",
    "price": "19.99",
    "quantity": 152,
    "quantities": [
      {
        "location_id": 47041,
        "quantity": 120
      },
      {
        "location_id": 47043,
        "quantity": 32
      }
    ]
  }
}

{
  "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": "/items/12345"
}

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

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/not-found",
  "title": "No item with the given id was found in this team.",
  "instance": "/items/12345"
}

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