Inventory items

These routes read the stock items of the business that connected your app, with the quantity on hand across its locations.

Access

• A token from the authorization-code grant. A client-credentials token answers 403 0010010000406.
• The business must keep a valid payment card on file; without one, 403 0010010000407.
• Scope inventory:read, declared by your app and granted by the business on the consent page — see Business resources.

List and get

GET /api/inventory/v1/items?sku=LEASH-BLU-M&page=1&pageSize=20
GET /api/inventory/v1/items/{id}

The list holds active items, ordered by SKU. sku is an exact match (no prefix search). A get also answers an item the business deactivated, with isActive: false. An item of another business answers 404.

{
  "id": "d9a3f6c2-0e71-4b5d-9c48-7f2e1a6b3d05",
  "sku": "FOOD-SALMON-2KG",
  "name": "Salmon kibble, loose",
  "quantityOnHand": 2.5,
  "unit": "g",
  "isActive": true
}

Field	Meaning
quantityOnHand	A decimal, in unit. Stock is counted in base units, so measured goods can be fractional. It includes reserved, allocated and quarantined stock: it is not the quantity available to sell.
unit	each, g, ml or mm.

Errors

Status	platformResponseCode	Cause
400	0010010000400	page or pageSize out of range.
404	Inventory_InventoryStock_GT_Resource_FL	No such item for this business.

Everything else follows Errors.