Partially updates an item. Send only the fields you want to change.
All fields are optional — a field left out keeps its current value, so a body of
{} is accepted and is a no-op. The response is just the item’s Id, the same
shape as POST /v1/items and DELETE /v1/items/{itemId} - fetch
GET /v1/items/{itemId} separately to see the updated item.
TypeId can never be changed — present in the body at all, including as
null, is a 400. Which fields are accepted depends on the item’s current type, the
same Product/Bundle split as on create (see POST /v1/items).
Clearing conventions, per field: Name, Number, UnitPrice,
UnitCost and StatusId are not clearable — a supplied blank/invalid value is
a 400, and null or omitting the field leaves it unchanged.
Description, Sku, PartNumber, Manufacturer, Vendor and
ExternalProductId are free text — an empty string clears the field, null or
omitting it leaves it unchanged. CategoryId, SubcategoryId, ClientId,
LocationId and TaxId clear via 0; null or omitting the field
leaves it unchanged. SubItems is bundle-only: an empty array clears the bundle down
to no sub-items, null or omitting it leaves the current sub-items unchanged, and a
non-empty array fully replaces them and recomputes UnitCost.
Re-supplying a value the item already holds is a no-op.
Autorisations
Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.
Paramètres de chemin
Item to update.
Corps
Fields to change.
Partial update of an item. Every field is optional and only the fields present in the body are applied. Per-field clearing conventions: Name, Number, UnitPrice, UnitCost, StatusId — not clearable: a supplied blank/invalid value is a 400, omit or send null to leave unchanged.Description, Sku, PartNumber, Manufacturer, Vendor, ExternalProductId — free text: an empty string clears it, null/omitted leaves it unchanged.CategoryId, SubcategoryId, ClientId, LocationId, TaxId — id fields: 0 clears it, null/omitted leaves it unchanged.SubItems — an empty array clears the bundle's sub-items, null/omitted leaves them unchanged, a non-empty array fully replaces them. TypeId is not accepted at all - present in the body (any value, including null) is a 400.
Rejected (400) if present at all - TypeId cannot be changed once an item is created.
Not clearable. Omit or send null to leave unchanged; a supplied blank is a 400.
Not clearable. Omit or send null to leave unchanged; a supplied blank is a 400.
Free text. Empty string clears it; null/omitted leaves it unchanged.
0 clears it; null/omitted leaves it unchanged.
0 clears it; null/omitted leaves it unchanged. Must belong to the item's (new or existing) CategoryId when non-zero.
0 clears it; null/omitted leaves it unchanged.
0 clears it; null/omitted leaves it unchanged. Must belong to the item's (new or existing) ClientId when non-zero.
Product-only. Free text. Empty string clears it; null/omitted leaves it unchanged.
Product-only. Free text. Empty string clears it; null/omitted leaves it unchanged.
Product-only. Free text. Empty string clears it; null/omitted leaves it unchanged.
Free text. Empty string clears it; null/omitted leaves it unchanged.
Product-only. Rejected (400) if sent while the item is a bundle. Not clearable - omit or send null to leave unchanged; a supplied negative value is a 400.
Not clearable. Omit or send null to leave unchanged. May be negative, for a discount or credit line.
0 clears it; null/omitted leaves it unchanged.
Free text. Empty string clears it; null/omitted leaves it unchanged.
Not clearable. 1 (Active) or 2 (Archived); omit or send null to leave unchanged.
Bundle-only. Rejected (400) if sent while the item is a product. An empty array clears the bundle down to no sub-items; null/omitted leaves the current sub-items unchanged; a non-empty array fully replaces them (and recomputes UnitCost - the whole bundle's cost depends on the whole list, so a partial patch of the list is not offered).
Bundle-only. Rejected (400) if sent while the item is a product.
Bundle-only. Rejected (400) if sent while the item is a product.
Réponse
OK
100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511 null