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.

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 2147483647必須

Item id.

namestring必須

Item display name.

skustring必須

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

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.

quantitiesarray of object必須

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

プロパティを表示

location_idintegerminimum 0, maximum 2147483647必須

Location id where this stock breakdown applies.

quantitynumber必須

On-hand quantity of this item at the location.

例

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

エンドポイント

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}