Skip to navigation

Create Catalog Item

Create a catalog item. The product will not be immediately categorized.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Request

Request body for CreateItemRequest
descriptionstringRequired
The description of the item.
image_urlslist of stringsRequired
An array of image URLs of the item.
namestringRequired
The name of the catalog item.
skustringRequired
The SKU of the catalog item.
urlstringRequired
The display page URL for the item.
blocksmap from strings to nullable maps from strings to any or nullOptional

Structured-data blocks keyed by type: meal_nutrition, allergens or attributes. A block replaces the stored block whole, null clears it, and a type left out is untouched. A block may carry if_match, the version last read, to reject the write when the block has changed since.

gtinstring or nullOptional
The GTIN of the catalog item.
metadatastring or nullOptional
Optional metadata string for the catalog item.
product_idstring or nullOptional
The product ID of the product which this catalog item is a variant of.

Response

Successful response
blocksmap from strings to objects or nullOptional

Per-block results, keyed by type. Present when the request sent blocks.

Errors

400
Bad Request Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
500
Internal Server Error
501
Not Implemented Error