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
typeenumRequired
Catalog item type
Allowed values:
categoryenumRequired
Catalog item category code. Must be a valid ProductCategory when type is PRODUCT or ServiceCategory when type is SERVICE.
costdoubleRequired>=0
Catalog item cost
pricedoubleRequired>=0
Catalog item price
tradeGroupenumOptional

High-level trade group for this item. Default is OTHER if not provided.

manufacturerstring or nullOptional
Catalog item manufacturer, required when type is PRODUCT
skustring or nullOptional
Catalog item SKU
codestring or nullOptional
Catalog item code
descriptionstring or nullOptional
Catalog item description

Response

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