Saltar al contingut principal
PATCH
Partially updates an item. Send only the fields you want to change.

Autoritzacions

X-API-Key
string
header
requerit

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.

Paràmetres de ruta

itemId
string<uuid>
requerit

Item to update.

Cos

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.

TypeId
integer<int32> | null

Rejected (400) if present at all - TypeId cannot be changed once an item is created.

Name
string | null

Not clearable. Omit or send null to leave unchanged; a supplied blank is a 400.

Number
string | null

Not clearable. Omit or send null to leave unchanged; a supplied blank is a 400.

Description
string | null

Free text. Empty string clears it; null/omitted leaves it unchanged.

CategoryId
integer<int64> | null

0 clears it; null/omitted leaves it unchanged.

SubcategoryId
integer<int64> | null

0 clears it; null/omitted leaves it unchanged. Must belong to the item's (new or existing) CategoryId when non-zero.

ClientId
integer<int64> | null

0 clears it; null/omitted leaves it unchanged.

LocationId
integer<int64> | null

0 clears it; null/omitted leaves it unchanged. Must belong to the item's (new or existing) ClientId when non-zero.

Sku
string | null

Product-only. Free text. Empty string clears it; null/omitted leaves it unchanged.

PartNumber
string | null

Product-only. Free text. Empty string clears it; null/omitted leaves it unchanged.

Manufacturer
string | null

Product-only. Free text. Empty string clears it; null/omitted leaves it unchanged.

Vendor
string | null

Free text. Empty string clears it; null/omitted leaves it unchanged.

UnitCost
number<double> | null

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.

UnitPrice
number<double> | null

Not clearable. Omit or send null to leave unchanged. May be negative, for a discount or credit line.

TaxId
integer<int64> | null

0 clears it; null/omitted leaves it unchanged.

ExternalProductId
string | null

Free text. Empty string clears it; null/omitted leaves it unchanged.

StatusId
integer<int32> | null

Not clearable. 1 (Active) or 2 (Archived); omit or send null to leave unchanged.

SubItems
object[] | null

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).

ShowSubItemsOnInvoice
boolean | null

Bundle-only. Rejected (400) if sent while the item is a product.

ShowSubItemDescriptionsOnInvoice
boolean | null

Bundle-only. Rejected (400) if sent while the item is a product.

Resposta

OK

StatusCode
enum<integer>
Opcions disponibles:
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
IsSuccess
boolean
Data
object
DataContext
object | null
Exemple:

null

Notifications
object[]