Create Catalog Item

POST {{baseUrl}}/api/catalog-items/

Create a new catalog item.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes: Catalogs Write

Request Body

{"data"=>{"type"=>"catalog-item", "attributes"=>{"external_id"=>"culpa elit Ut", "title"=>"in voluptate dolore", "description"=>"qui labore ex nostrud aliqua", "url"=>"eiusmod aute", "integration_type"=>"$custom", "catalog_type"=>"$default", "image_full_url"=>"aute labore", "image_thumbnail_url"=>"Lorem qui", "images"=>["aute occaecat cillum ea non", "consectetur nostrud"], "published"=>true}, "relationships"=>{"categories"=>{"data"=>[{"type"=>"catalog-category", "id"=>"Ut magna"}, {"type"=>"catalog-category", "id"=>"culpa elit dolore"}]}}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"data":{"type":"catalog-item","id":"voluptate consectetur amet","attributes":{"external_id":"labore Excepteur nostrud commodo","title":"deserunt","description":"adipisicing minim consectetur voluptate irure","url":"et aliquip dolor Ut Lorem","image_full_url":"consequat veniam in","image_thumbnail_url":"ad","images":["sed amet nulla ad","nulla offic"],"custom_metadata":{},"published":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://VUVedF.wwuFuIdBWIx9iu9cXaf0.OfTSFWqcIJ8v3N1YDEZ9Bp+RBo"}}}