# Inventory Categories

Inventory Categories are used to group inventory items with similar characteristics for reporting purposes.

# The Inventory Category Object

# Sample

{
  "id": "8d161995",
  "name": "Meals",
  "name_localized": null,
  "reference": "ic-001",
  "created_at": "2019-02-27 09:43:00",
  "updated_at": "2019-02-27 09:43:00",
  "deleted_at": null,
  "inventory_items": [
    {
      "id": "8d869623"
    }
  ]
}

# Attributes

Field	Type	Rule	Description
`id`	`string`		Unique identifier for the inventory item category.
`name*`	`string`	`updatable`	Name of the inventory item category
`name_localized`	`string`	`nullable` `updatable`	Localized inventory item category name if business uses localization.
`reference`	`string`	`nullable` `updatable`	The reference code of the inventory category.
`inventory_items`	`array`		List of Inventory Items attached to the inventory category
`created_at`	`string`	`sortable`	Time at which the inventory item category was created in UTC. `YYYY-MM-DD HH-MM-SS`
`updated_at`	`string`	`sortable`	Time at which the inventory item category was updated in UTC. `YYYY-MM-DD HH-MM-SS`
`deleted_at`	`string`	`nullable`	Time at which the inventory item category was deleted in UTC. `YYYY-MM-DD HH-MM-SS`

# List Inventory Categories

GET /inventory_item_categories

# Scope

inventory.settings.read

# Filters

name
name_localized
id
reference
updated_after
is_deleted
created_on
updated_on
deleted_on

# Response

{
  "data": [
    {
      "id": "8d161995",
      "name": "Meals",
      "name_localized": null,
      "reference": "ic-001",
      "created_at": "2019-02-27 09:43:00",
      "updated_at": "2019-02-27 09:43:00",
      "deleted_at": null,
      "inventory_items": [
        {
          "id": "8d869623"
        }
      ]
    }
  ]
}

# Get Inventory Category

GET /inventory_item_categories/{inventoryCategoryId}

# Scope

inventory.settings.read

# Response

{
  "data": {
    "id": "8d161995",
    "name": "Meals",
    "name_localized": null,
    "reference": "ic-001",
    "created_at": "2019-02-27 09:43:00",
    "updated_at": "2019-02-27 09:43:00",
    "deleted_at": null,
    "inventory_items": [
      {
        "id": "8d869623"
      }
    ]
  }
}

# Create Inventory Category

POST /inventory_item_categories

# Scope

inventory.settings.write

# Request

{
    "name": "Meals",
    "name_localized": null,
    "reference": "ic-001",

}

# Response

{
  "data": {
    "id": "8d161995",
    "name": "Meals",
    "name_localized": null,
    "reference": "ic-001",
    "created_at": "2019-02-27 09:43:00",
    "updated_at": "2019-02-27 09:43:00",
    "deleted_at": null,
    "inventory_items": [
      {
        "id": "8d869623"
      }
    ]
  }
}

# Update Inventory Category

PUT /inventory_item_categories/{inventoryCategoryId}

# Scope

inventory.settings.write

# Request

{
    "name": "Meals",
    "name_localized": null,
    "reference": "ic-001",
}

# Response

{
  "data": {
    "id": "8d161995",
    "name": "Meals",
    "name_localized": null,
    "reference": "ic-001",
    "created_at": "2019-02-27 09:43:00",
    "updated_at": "2019-02-27 09:43:00",
    "deleted_at": null,
    "inventory_items": [
      {
        "id": "8d869623"
      }
    ]
  }
}

# Delete Inventory Category

DELETE /inventory_item_categories/{inventoryCategoryId}

# Scope

inventory.settings.write

The API will respond with 200 indicating that the inentory category has been deleted.

# Restore Inventory Category

PUT /inventory_item_categories/{inventoryCategoryId}/restore

# Scope

admin.restore

The API will respond with 200 indicating that the inentory category has been restored.

← Cost Adjustment Transactions Inventory Counts →