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
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":{"type":"catalog-item","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","price":"\u003cnumber\u003e","url":"\u003cstring\u003e","image_full_url":"\u003cstring\u003e","image_thumbnail_url":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"custom_metadata":{},"published":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"variants":{"data":[{"type":"catalog-variant","id":"\u003cstring\u003e"},{"type":"catalog-variant","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}