List items

Returns a cursor-paginated list of items in the team.

Each item carries a quantities per-location breakdown; pass location_ids to scope that breakdown to specific locations.

GEThttps://rest.boxhero-app.com/v1/items

Autorización

Authorizationstringobligatorio

Encabezado de autenticación Bearer con el formato Bearer <token>, donde <token> es tu token de API.

Parámetros de consulta

item_idsinteger | array of integer

Filter the list to specific item ids. Pass repeatedly (?item_ids=1&item_ids=2) or as a single value.

location_idsinteger | array of integer

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

cursorintegerminimum 0, maximum 2147483647

Page cursor. Pass the cursor field from the previous response to fetch the next page. Omit on the first call.

limitintegerminimum 1, maximum 100

Page size. Accepts 1–100; defaults to 100.

Respuestas

200A page of items.

itemsarray of Itemobligatorio

Items in this page. Default ordering is by id ascending; see the resource’s list endpoint description for any per-resource overrides.

Mostrar propiedades

idintegerminimum 0, maximum 2147483647obligatorio

Item id.

namestringobligatorio

Item display name.

skustringobligatorio

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

barcodestringobligatorio

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

photo_urlstringnullableobligatorio

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

attrsarray of ItemAttrobligatorio

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

Mostrar propiedades

idintegerminimum 0, maximum 2147483647obligatorio

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

typestringobligatorio

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

Valores posiblestextdatenumberbarcode

namestringobligatorio

Attribute display name.

valuestring | numberobligatorio

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

coststringobligatorio

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

pricestringobligatorio

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

quantitynumberobligatorio

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

quantitiesarray of objectobligatorio

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

Mostrar propiedades

location_idintegerminimum 0, maximum 2147483647obligatorio

Location id where this stock breakdown applies.

quantitynumberobligatorio

On-hand quantity of this item at the location.

countintegerminimum 0, maximum 9007199254740991obligatorio

Number of items in this page (items.length).

limitintegerminimum 0, maximum 9007199254740991obligatorio

Page size used to build this response.

cursorintegerminimum 0, maximum 2147483647, nullableobligatorio

Cursor to pass as cursor in the next request. null when has_more is false.

has_morebooleanobligatorio

True when another page is available. The cursor is monotonic — pass it as cursor on the next request to advance the page. Direction follows each resource’s ordering (default: id ascending).

400Team is not in LOCATION mode.

idstringobligatorio

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.

typestringobligatorio

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

Valores posibles/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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

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.

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

401Missing or invalid API token.

idstringobligatorio

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.

typestringobligatorio

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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

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

idstringobligatorio

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.

typestringobligatorio

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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

Solicitud

curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/items' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"

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

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

Respuesta

{
  "items": [
    {
      "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": 14290446,
      "name": "Hydrating Face Toner",
      "sku": "SKU-12345679",
      "barcode": "2097678335588",
      "photo_url": null,
      "attrs": [
        {
          "id": 485697,
          "type": "text",
          "name": "Brand",
          "value": "Acme Beauty"
        },
        {
          "id": 485086,
          "type": "number",
          "name": "Minimum Stock",
          "value": 15
        }
      ],
      "cost": "5.25",
      "price": "12.50",
      "quantity": 318,
      "quantities": [
        {
          "location_id": 47041,
          "quantity": 300
        },
        {
          "location_id": 47042,
          "quantity": 18
        }
      ]
    }
  ],
  "count": 2,
  "limit": 100,
  "cursor": 14290446,
  "has_more": false
}

{
  "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"
}

{
  "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/too-many-requests",
  "title": "Too many requests.",
  "instance": "/items",
  "retryAfter": 60
}