Spawn Update Items Job
POST {{baseUrl}}/api/catalog-item-bulk-update-jobs/
Create a catalog item bulk update job to update a batch of catalog items.
Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.
Rate limits:
Burst: 75/s
Steady: 700/m
Scopes:
catalogs:write
Request Body
{"data"=>{"type"=>"catalog-item-bulk-update-job", "attributes"=>{"items"=>{"data"=>[{"type"=>"catalog-item", "id"=>"<string>", "attributes"=>{"title"=>"<string>", "price"=>"<number>", "description"=>"<string>", "url"=>"<string>", "image_full_url"=>"<string>", "image_thumbnail_url"=>"<string>", "images"=>["<string>", "<string>"], "published"=>"<boolean>"}, "relationships"=>{"categories"=>{"data"=>[{"type"=>"catalog-category", "id"=>"<string>"}, {"type"=>"catalog-category", "id"=>"<string>"}]}}}, {"type"=>"catalog-item", "id"=>"<string>", "attributes"=>{"title"=>"<string>", "price"=>"<number>", "description"=>"<string>", "url"=>"<string>", "image_full_url"=>"<string>", "image_thumbnail_url"=>"<string>", "images"=>["<string>", "<string>"], "published"=>"<boolean>"}, "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 |