API ReferenceCatalog Items

Update Catalog Item

Update an existing catalog item.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

catalogItemIdintegerRequired
Catalog item identifier

Request

This endpoint expects an object.
typeenumOptional
Catalog item type
Allowed values:
namestringOptional
Catalog item name
categoryenumOptional
Catalog item category code. Must be a valid ProductCategory or ServiceCategory value.
codestringOptional
Catalog item code
descriptionstring or nullOptional
Catalog item description
costdoubleOptional>=0
Catalog item cost
pricedoubleOptional>=0
Catalog item price
tradeGroupenumOptional

High-level trade group for this item.

Response

Catalog item updated successfully
idinteger
Catalog item identifier
namestring
Catalog item name
catalogenum or null

High-level trade group for this item.

typeenum
Catalog item type
Allowed values:
categoryenum

Catalog item category code (ProductCategory or ServiceCategory)

costdouble or null>=0
Catalog item cost
pricedouble or null>=0
Catalog item price
manufacturerstring or null
Catalog item manufacturer
skustring or null
Catalog item SKU
codestring or null
Catalog item code
descriptionstring or null
Catalog item description
imageobject or null
isArchivedboolean or null
Whether the catalog item is archived
createdByIdinteger or null
Identifier of the user who created the catalog item
createdAtstring or nullformat: "date-time"
updatedAtstring or nullformat: "date-time"

Errors