Sign in
InventoryCategories

Create an Inventory Category

This endpoint creates an inventory category for the given organisation.

post/inventory/categories

Request body

site_idstring uuid required

Identifier of the site that owns this inventory category. Categories are scoped per site so each site can maintain its own taxonomy. Must belong to organisation_id.

organisation_idstring uuid required

Identifier of the organisation this category sits under. Used for cross-site reporting and authorisation; the supplied site_id must belong to this organisation.

namestring required

Human-readable name for the inventory category, used to group related inventory products in the admin UI and on reports. Trimmed; 1-120 characters.

Example request

{
  "name": "Massage oils"
}

Response

The inventory category was successfully retrieved

Example response

{
  "data": {
    "name": "Massage oils"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.