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.
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.
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.
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.
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.
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.
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.
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.
Name to give the duplicated inventory product. Typically
the source product's name with a "(copy)" suffix. Trimmed;
1-120 characters and must not contain HTML.
Identifier of the stock location the adjustment is recorded
against. For positive adjustments stock is added at this
location; for negative adjustments stock is removed from it.
Pass null if the site uses a single, default location.
Responses
201
The inventory product adjustment was successfully retrieved
Returns the paginated list of suppliers associated with a single
inventory product. Each entry describes the supplier-side ID
(e.g. their SKU), the default order quantity, and the unit
price.
Associates a supplier with a product, capturing the supplier's
SKU, default order quantity, and unit price. Multiple suppliers
can be associated with the same product.
Supplier to attach to the product. Suppliers belong to
the same inventory brand as the product; cross-brand
links are rejected with 422. A product can be linked
to multiple suppliers, each with their own pricing.
Updates the supplier-product association — typically to adjust
the supplier's SKU or default order quantity. The supplier
itself cannot be reassigned; delete and recreate the
association if you need to switch suppliers.
Returns the status and output of an inventory background job
that was previously kicked off via a queue-issuing endpoint
(e.g. stock-on-hand or stock-adjustment exports, stock-take
posting). Poll this endpoint until status transitions to
complete or failed; output then contains the per-job
result envelope.