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.
typeenumRequired
Catalog item type
Allowed values:
namestringOptional
Catalog item name
codestringOptional
Catalog item code
descriptionstring or nullOptional
Catalog item description
costdoubleOptional>=0
Catalog item cost
pricedoubleOptional>=0
Catalog item price
imageIdintegerOptional
Catalog item image identifier
categoryIdintegerOptional
Catalog item category identifier
isArchivedbooleanOptional
Whether the catalog item is archived
manufacturerstring or nullOptional
Catalog item manufacturer
skustring or nullOptional
Catalog item SKU

Response

Catalog item updated successfully
idinteger or null
Catalog item identifier
namestring or null
Catalog item name
manufacturerstring or null
Catalog item manufacturer
skustring or null
Catalog item SKU
codestring or null
Catalog item code
costdouble or null>=0
Catalog item cost
pricedouble or null>=0
Catalog item price
descriptionstring or null
Catalog item description
imageobject or null
categoryIdinteger or null
Catalog item category identifier
typeenum or null
Catalog item type
Allowed values:
isArchivedboolean or null
Whether the catalog item is archived
createdAtstring or nullformat: "date-time"
updatedAtstring or nullformat: "date-time"

Errors