Skip to content

Inventory Items ​

Contains data on inventory items - products, ingredients, and materials tracked in the inventory system.

Storage Location ​

{customer_id}-inventory.json

Fields ​

FieldTypeRequiredDescription
idstringYesv1.3. Item id (stringified number).
customer_idnumberYesv1.3. Customer id.
namestringYesv1.3. Item name.
base_unitstringNov1.3. Base unit name, lowercase (e.g. g, kg, l, stk).
supplierstringNov1.3. Supplier name (denormalized from supplier_id).
supplier_idnumberNov1.3. Supplier id.
item_groupstringNov1.3. Item group name (denormalized from item_group_id).
item_group_idnumberNov1.3. Item group id.
count_frequencynumberNov1.3. Inventory count frequency.
purchase_unitstringNov1.3. Purchase unit.
supplier_unitstringNov1.3. Supplier unit.
ean13stringNov1.3. EAN-13 barcode.
epd_numstringNov1.3. EPD number.
min_levelnumberNov1.3. Minimum stock level.
ideal_levelnumberNov1.3. Ideal stock level.
default_waste_pctnumberNov1.3. Default waste percentage.
cost_per_base_unitnumberNov1.3. Cost per base unit.
statusstringYesv1.3. active, inactive, deleted or unknown.

Example ​

json
[
  {
    "id": "45201",
    "customer_id": 10352,
    "name": "Fresh Salmon Fillet",
    "base_unit": "kg",
    "supplier": "Nordic Fish Supply",
    "supplier_id": 1023,
    "item_group": "Seafood",
    "item_group_id": 506,
    "count_frequency": 14,
    "purchase_unit": "box",
    "supplier_unit": "kg",
    "ean13": "5700123456789",
    "epd_num": "EPD-123456",
    "min_level": 10,
    "ideal_level": 50,
    "default_waste_pct": 15,
    "cost_per_base_unit": 125.50,
    "status": "active"
  },
  {
    "id": "45202",
    "customer_id": 10352,
    "name": "Olive Oil Extra Virgin",
    "base_unit": "l",
    "supplier": "Mediterranean Imports",
    "supplier_id": 1024,
    "item_group": "Oils",
    "item_group_id": 507,
    "min_level": 5,
    "ideal_level": 20,
    "cost_per_base_unit": 89.00,
    "status": "active"
  },
  {
    "id": "45203",
    "customer_id": 10352,
    "name": "Flour All Purpose",
    "base_unit": "kg",
    "supplier": "Grain Mills Co",
    "supplier_id": 1025,
    "item_group": "Dry Goods",
    "item_group_id": 508,
    "status": "inactive"
  }
]

Technical documentation for partners and integrators