Skip to content

Inventory Item Groups

Inventory item grouping/categorization.

Fields

FieldTypeRequiredVersionDescription
idguidYes1.1.2Unique group identifier
namestringYes1.1.2Group name
customerIdintegerYes1.1.2Reference to Customer
parentGroupIdguidNo1.1.2Parent group (for hierarchy)
activebooleanNo1.1.2Group active status

Example

json
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Seafood",
  "customerId": 12345,
  "parentGroupId": null,
  "active": true
}

Example - Hierarchical Groups

json
[
  {
    "id": "group-proteins-id",
    "name": "Proteins",
    "customerId": 12345,
    "parentGroupId": null,
    "active": true
  },
  {
    "id": "group-seafood-id",
    "name": "Seafood",
    "customerId": 12345,
    "parentGroupId": "group-proteins-id",
    "active": true
  },
  {
    "id": "group-meat-id",
    "name": "Meat",
    "customerId": 12345,
    "parentGroupId": "group-proteins-id",
    "active": true
  },
  {
    "id": "group-produce-id",
    "name": "Produce",
    "customerId": 12345,
    "parentGroupId": null,
    "active": true
  },
  {
    "id": "group-vegetables-id",
    "name": "Vegetables",
    "customerId": 12345,
    "parentGroupId": "group-produce-id",
    "active": true
  },
  {
    "id": "group-beverages-id",
    "name": "Beverages",
    "customerId": 12345,
    "parentGroupId": null,
    "active": true
  }
]
  • Customer - Parent customer/tenant
  • InventoryItem - Items in group

Technical documentation for partners and integrators