API ReferenceCatalog Items

Create Catalog Item

Create a new catalog item.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired
Catalog item name
costdoubleRequired>=0
Catalog item cost
pricedoubleRequired>=0
Catalog item price
categoryIdintegerRequired
Catalog item category identifier, one of categoryId or categoryCode is required
categoryCodestringRequired
Catalog item category code, one of categoryId or categoryCode is required
typeenumRequired
Catalog item type
Allowed values:
manufacturerstringOptional
Catalog item manufacturer, required when type is PRODUCT
skustringOptional
Catalog item SKU
codestringOptional
Catalog item code
descriptionstringOptional
Catalog item description

Response

Catalog item created 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