Get Update Variants Job
GET {{baseUrl}}/api/catalog-variant-bulk-update-jobs/:job_id/
Get a catalog variate bulk update job with the given job ID.
An include parameter can be provided to get the following related resource data: variants.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
catalogs:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[catalog-variant-bulk-update-job] | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | |
fields[catalog-variant] | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#relationships |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":{"type":"catalog-variant-bulk-update-job","attributes":{"job_id":"\u003cstring\u003e","status":"processing","created_at":"\u003cdateTime\u003e","total_count":"\u003cinteger\u003e","completed_count":"\u003cinteger\u003e","failed_count":"\u003cinteger\u003e","completed_at":"\u003cdateTime\u003e","expires_at":"\u003cdateTime\u003e","errors":[{"id":"\u003cstring\u003e","code":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"pointer":"/data"}},{"id":"\u003cstring\u003e","code":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"pointer":"/data"}}]},"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"}}}},"included":[{"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"}},{"type":"catalog-variant","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","sku":"\u003cstring\u003e","inventory_policy":2,"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"}}]}