Sign in
InventoryProducts

Update an Inventory Product

This endpoint updates an inventory product for the given site.

put/inventory/products/{productId}

Request body

namestring

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.

descriptionstring nullable

Long-form description of the inventory product, shown on the product detail screen. Plain text; line breaks are preserved. Pass null to clear an existing description.

skustring nullable

The stock keeping unit (SKU) for the inventory product.

barcodestring nullable

The barcode for the inventory product.

reorder_levelinteger nullable

The quantity of this inventory product which should be reordered.

brand_idstring uuid nullable

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 the product.

category_idstring uuid nullable

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 the product.

Example request

{
  "name": "Blissful Body Butter",
  "description": "A rich, creamy body butter which deeply nourishes the skin, with essential oils.",
  "sku": "BB-001",
  "barcode": "0123456789",
  "reorder_level": 10
}

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

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