Items

Items — the smallest unit of inventory tracked by BoxHero.

Each item carries an SKU, barcode, cost, price, and any custom attributes you have defined.

O objeto Item

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 2147483647obrigatório

Item id.

namestringobrigatório

Item display name.

skustringobrigatório

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

barcodestringobrigatório

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

photo_urlstringnullableobrigatório

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

attrsarray of ItemAttrobrigatório

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

Mostrar propriedades

idintegerminimum 0, maximum 2147483647obrigatório

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

typestringobrigatório

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

Valores possíveistextdatenumberbarcode

namestringobrigatório

Attribute display name.

valuestring | numberobrigatório

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

coststringobrigatório

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

pricestringobrigatório

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

quantitynumberobrigatório

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

quantitiesarray of objectobrigatório

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.

Mostrar propriedades

location_idintegerminimum 0, maximum 2147483647obrigatório

Location id where this stock breakdown applies.

quantitynumberobrigatório

On-hand quantity of this item at the location.

Exemplo

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

Endpoints

List items GET /v1/items
Create an item POST /v1/items
Get an item GET /v1/items/{item_id}
Update an item PUT /v1/items/{item_id}
Delete an item DELETE /v1/items/{item_id}
Get an item by SKU GET /v1/items/by-sku/{sku}
Update an item by SKU PUT /v1/items/by-sku/{sku}
Delete an item by SKU DELETE /v1/items/by-sku/{sku}