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"=>"<string>", "title"=>"<string>", "description"=>"<string>", "url"=>"<string>", "integration_type"=>"$custom", "price"=>"<number>", "catalog_type"=>"$default", "image_full_url"=>"<string>", "image_thumbnail_url"=>"<string>", "images"=>["<string>", "<string>"], "published"=>true}, "relationships"=>{"categories"=>{"data"=>[{"type"=>"catalog-category", "id"=>"<string>"}, {"type"=>"catalog-category", "id"=>"<string>"}]}}}}

HEADERS

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

RESPONSES

status: Created

{&quot;data&quot;:{&quot;type&quot;:&quot;catalog-item&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;attributes&quot;:{&quot;external_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;price&quot;:&quot;\u003cnumber\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;,&quot;image_full_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;image_thumbnail_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;images&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;custom_metadata&quot;:{},&quot;published&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updated&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;},&quot;relationships&quot;:{&quot;variants&quot;:{&quot;data&quot;:[{&quot;type&quot;:&quot;catalog-variant&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;catalog-variant&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;,&quot;related&quot;:&quot;\u003curi\u003e&quot;}}}}}