Create Catalog Variant

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

Create a new variant for a related catalog item.

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

Scopes: catalogs:write

Request Body

{"data"=>{"type"=>"catalog-variant", "attributes"=>{"external_id"=>"<string>", "title"=>"<string>", "description"=>"<string>", "sku"=>"<string>", "inventory_quantity"=>"<number>", "price"=>"<number>", "url"=>"<string>", "catalog_type"=>"$default", "integration_type"=>"$custom", "inventory_policy"=>0, "image_full_url"=>"<string>", "image_thumbnail_url"=>"<string>", "images"=>["<string>", "<string>"], "published"=>true}, "relationships"=>{"item"=>{"data"=>{"type"=>"catalog-item", "id"=>"<string>"}}}}}

HEADERS

RESPONSES

status: Created

{"data":{"type":"catalog-variant","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","sku":"\u003cstring\u003e","inventory_policy":0,"inventory_quantity":"\u003cnumber\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":{"item":{"data":{"type":"catalog-item","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}