Sign in
InventoryProducts

Create an Inventory Product

This endpoint creates an inventory product for the given site.

post/inventory/products

Request body

namestring required

Display name of the inventory product, shown to staff in the stock admin UI and on purchase orders, stocktake sheets, and reports. Trimmed; 1-120 characters and must not contain HTML.

brand_idstring uuid nullable required

Identifier of the inventory brand this product is sold under. Used for filtering and reporting. Pass null if the product is unbranded; the brand must belong to the same site as site_id.

category_idstring uuid nullable required

Identifier of the inventory category this product is classified under. Used for filtering, reporting, and report grouping. Pass null for uncategorised products; the category must belong to the same site as site_id.

site_idstring uuid required

Identifier of the site that owns this inventory product. Stock levels, suppliers, and adjustments are all scoped per site; the caller's API key must have access to it.

Example request

{
  "name": "Blissful Body Butter"
}

Response

The inventory product was successfully retrieved

Example response

{
  "data": {
    "name": "Blissful Body Butter",
    "description": "A rich, creamy body butter which deeply nourishes the skin, with essential oils.",
    "sku": "BB-001",
    "average_cost": 1000,
    "currency": "gbp",
    "reorder_level": 10,
    "stock_level": 50.5,
    "stock_value": 5000,
    "brand": {
      "name": "L'Oréal"
    },
    "category": {
      "name": "Massage oils"
    }
  }
}

Changes