Skip to content

Inventory Items

Inventory item master data.

Fields

FieldTypeRequiredVersionDescription
idguidYes1.1.2Unique item identifier
namestringNo1.1.2Item name
base_unitstringNo1.1.2Base unit of measurement
external_referencestringNo1.1.2External system reference
customerIdintegerYes1.1.2Reference to Customer
groupIdguidNo1.1.2Reference to InventoryItemGroup
supplierIdguidNo1.1.2Default supplier
activebooleanNo1.1.2Item active status

Base Unit Values

UnitDescription
kgKilogram
gGram
lLiter
mlMilliliter
pcsPieces
boxBox
caseCase

Example

json
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Fresh Salmon Fillet",
  "base_unit": "kg",
  "external_reference": "SUP-SALMON-001",
  "customerId": 12345,
  "groupId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "supplierId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "active": true
}

Example - Various Items

json
[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Fresh Salmon Fillet",
    "base_unit": "kg",
    "external_reference": "SUP-SALMON-001",
    "customerId": 12345,
    "groupId": "group-seafood-id",
    "supplierId": "supplier-fish-id",
    "active": true
  },
  {
    "id": "item-olive-oil-id",
    "name": "Extra Virgin Olive Oil",
    "base_unit": "l",
    "external_reference": "SUP-OIL-001",
    "customerId": 12345,
    "groupId": "group-oils-id",
    "supplierId": "supplier-deli-id",
    "active": true
  },
  {
    "id": "item-napkins-id",
    "name": "Paper Napkins",
    "base_unit": "pcs",
    "external_reference": "SUP-NAP-001",
    "customerId": 12345,
    "groupId": "group-supplies-id",
    "supplierId": "supplier-supplies-id",
    "active": true
  }
]
  • Customer - Parent customer/tenant
  • InventoryItemGroup - Item grouping
  • InventorySupplier - Default supplier
  • InventoryTransaction - Stock movements
  • InventoryRecipeItem - Recipe ingredients

Technical documentation for partners and integrators