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}

Authorizations

Authorizationstringrequired

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Path parameters

item_idintegerminimum 0, maximum 2147483647required

Query parameters

location_idsinteger | array of integer

Scope the quantities breakdown to specific locations. When present, the response carries one quantities entry per requested location. When omitted, quantities still appears but only for active locations where the item has nonzero stock.

Responses

200The requested item.

itemItemrequired

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.

Show properties

idintegerminimum 0, maximum 2147483647required

Item id.

namestringrequired

Item display name.

skustringrequired

Stock Keeping Unit. Unique within the team when set. Empty string when not assigned.

barcodestringrequired

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

photo_urlstringnullablerequired

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

attrsarray of ItemAttrrequired

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

Show properties

idintegerminimum 0, maximum 2147483647required

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

typestringrequired

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

Possible valuestextdatenumberbarcode

namestringrequired

Attribute display name.

valuestring | numberrequired

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

coststringrequired

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

pricestringrequired

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

quantitynumberrequired

Total on-hand quantity for this item, summed across all locations.

quantitiesarray of objectrequired

Per-location stock breakdown. Always present. With location_ids set, one entry per requested location. Without location_ids, one entry per active location where this item has nonzero stock (empty array when the item is out of stock everywhere).

Show properties

location_idintegerminimum 0, maximum 2147483647required

Location id where this stock breakdown applies.

quantitynumberrequired

On-hand quantity of this item at the location.

400Team is not in LOCATION mode.

idstringrequired

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.

typestringrequired

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

Possible values/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

titlestringrequired

Human-readable summary of the error, in English.

correlationIDstringrequired

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.

instancestringrequired

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.

Show properties

patharray of string | numberrequired

messagestringrequired

401Missing or invalid API token.

idstringrequired

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.

typestringrequired

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

titlestringrequired

Human-readable summary of the error, in English.

correlationIDstringrequired

instancestringrequired

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.

Show properties

patharray of string | numberrequired

messagestringrequired

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

idstringrequired

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.

typestringrequired

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

titlestringrequired

Human-readable summary of the error, in English.

correlationIDstringrequired

instancestringrequired

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.

Show properties

patharray of string | numberrequired

messagestringrequired

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

idstringrequired

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.

typestringrequired

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

titlestringrequired

Human-readable summary of the error, in English.

correlationIDstringrequired

instancestringrequired

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.

Show properties

patharray of string | numberrequired

messagestringrequired

Request

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>

Response

{
  "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.50",
    "price": "19.99",
    "quantity": 152,
    "quantities": [
      {
        "location_id": 47041,
        "quantity": 120
      },
      {
        "location_id": 47043,
        "quantity": 32
      }
    ]
  }
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "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_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 item with the given id was found in this team.",
  "instance": "/items/12345"
}

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