Skip to content

Inventory Locations

Inventory storage location configuration.

Fields

FieldTypeRequiredVersionDescription
idguidYes1.1.2Unique location identifier
namestringYes1.1.2Location name
customerIdintegerYes1.1.2Reference to Customer
businessUnitIdintegerNo1.1.2Reference to BusinessUnit
typestringNo1.1.2Location type
activebooleanNo1.1.2Location active status

Location Types

TypeDescription
storageGeneral storage area
kitchenKitchen storage
barBar storage
coldCold storage/refrigeration
freezerFreezer storage
dryDry goods storage

Example

json
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Main Kitchen",
  "customerId": 12345,
  "businessUnitId": 10,
  "type": "kitchen",
  "active": true
}

Example - Multiple Locations

json
[
  {
    "id": "location-kitchen-id",
    "name": "Main Kitchen",
    "customerId": 12345,
    "businessUnitId": 10,
    "type": "kitchen",
    "active": true
  },
  {
    "id": "location-cold-id",
    "name": "Walk-in Cooler",
    "customerId": 12345,
    "businessUnitId": 10,
    "type": "cold",
    "active": true
  },
  {
    "id": "location-freezer-id",
    "name": "Freezer Room",
    "customerId": 12345,
    "businessUnitId": 10,
    "type": "freezer",
    "active": true
  },
  {
    "id": "location-bar-id",
    "name": "Bar Storage",
    "customerId": 12345,
    "businessUnitId": 10,
    "type": "bar",
    "active": true
  },
  {
    "id": "location-dry-id",
    "name": "Dry Goods Storage",
    "customerId": 12345,
    "businessUnitId": 10,
    "type": "dry",
    "active": true
  }
]
  • Customer - Parent customer/tenant
  • BusinessUnit - Parent business unit
  • InventoryTransaction - Transactions at location
  • InventoryCounting - Counts at location

Technical documentation for partners and integrators