List items
list_itemsRead-only
Search the product catalog. Each item has itemID, description, SKUs (systemSku, customSku, upc, ean, manufacturerSku), defaultCost, categoryID and its Prices (price levels). Set include_stock to add per-shop quantities (ItemShops; shopID 0 = all shops). Paginate with next_url. GET /Account/{accountID}/Item.json.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ean | No | Exact EAN. | |
| upc | No | Exact UPC. | |
| sort | No | Sort field; prefix "-" for descending. Allowed: itemID, timeStamp, description. | |
| limit | No | Records per page (1-100, default 100). | |
| min_qoh | No | Only items with at least one shop record whose quantity on hand is >= this (loads ItemShops). | |
| archived | No | false (default) = active records only, true = active and archived, only = archived only. | |
| next_url | No | To get the next page: the next_url value from a previous call of this same tool, unchanged. Other filters are ignored when it is set. | |
| item_code | No | Exact match on itemID, UPC or EAN. | |
| vendor_id | No | Only items whose default vendor is this vendorID. | |
| custom_sku | No | Exact custom SKU. | |
| system_sku | No | Exact Lightspeed system SKU (the barcode on labels). | |
| category_id | No | Only items in this category (categoryID). | |
| description | No | Description contains this text (like search). | |
| include_stock | No | Include per-shop stock (ItemShops relation). | |
| modified_since | No | Only items modified at or after this time (item timeStamp, UTC unless an offset is given). | |
| include_category | No | Include the Category record. | |
| manufacturer_sku | No | Exact manufacturer SKU. |