Sign in
InventoryBrands

Create an Inventory Brand

This endpoint creates an inventory brand for the given organisation.

post/inventory/brands

Request body

site_idstring uuid required

Identifier of the site that owns this inventory brand. Brands are scoped per site, so the API key must have access to this site. Must belong to the supplied organisation_id.

organisation_idstring uuid required

Identifier of the organisation this brand sits under. Used for cross-site reporting and to enforce that the referenced site_id belongs to the same organisation.

namestring required

Human-readable name of the inventory brand, shown in the inventory admin UI and on supplier order forms. Trimmed; must be 1-120 characters and not contain HTML.

Example request

{
  "name": "L'Oréal"
}

Response

The inventory brand was successfully retrieved

Example response

{
  "data": {
    "name": "L'Oréal"
  }
}

Changes