{"command":{"effect":"write","timeoutSeconds":30,"inputSchema":{"type":"object","description":"Create a catalog variant bulk update job to update a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB. The maximum number of jobs in progress at one time is 500.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_variants.json)","properties":{"query":{"type":"object","properties":{"fields[catalog-variant-bulk-update-job]":{"type":"array","items":{"type":"string","enum":["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"]},"description":"For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets"}},"required":[],"additionalProperties":false},"headers":{"type":"object","properties":{"revision":{"type":"string","default":"2026-10-15","enum":["2026-10-15"],"description":"API endpoint revision (format: YYYY-MM-DD[.suffix])"}},"required":["revision"],"additionalProperties":false},"body":{"$ref":"#/definitions/CatalogVariantUpdateJobCreateQuery"}},"required":["headers","body"],"additionalProperties":false,"definitions":{"CatalogVariantUpdateJobCreateQuery":{"type":"object","properties":{"data":{"$ref":"#/definitions/CatalogVariantUpdateJobCreateQueryResourceObject"}},"required":["data"]},"CatalogVariantUpdateJobCreateQueryResourceObject":{"type":"object","properties":{"type":{"$ref":"#/definitions/CatalogVariantBulkUpdateJobEnum"},"attributes":{"type":"object","properties":{"variants":{"description":"Array of catalog variants to update.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/CatalogVariantUpdateQueryResourceObject"}}},"required":["data"]}},"required":["variants"]}},"required":["type","attributes"]},"CatalogVariantBulkUpdateJobEnum":{"type":"string","enum":["catalog-variant-bulk-update-job"]},"CatalogVariantUpdateQueryResourceObject":{"type":"object","properties":{"type":{"$ref":"#/definitions/CatalogVariantEnum"},"id":{"description":"The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.","type":"string","examples":["$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"]},"attributes":{"type":"object","properties":{"title":{"description":"The title of the catalog item variant.","type":["string","null"],"examples":["Ocean Blue Shirt (Sample) Variant Medium"]},"description":{"description":"A description of the catalog item variant.","type":["string","null"],"examples":["Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns."]},"sku":{"description":"The SKU of the catalog item variant.","type":["string","null"],"examples":["OBS-MD"]},"inventory_policy":{"description":"This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.","type":["integer","null"],"enum":[0,1,2],"examples":[2]},"inventory_quantity":{"description":"The quantity of the catalog item variant currently in stock.","type":["number","null"],"examples":[25]},"price":{"description":"This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).","type":["number","null"],"examples":[42]},"url":{"description":"URL pointing to the location of the catalog item variant on your website.","type":["string","null"],"examples":["https://via.placeholder.com/150"]},"image_full_url":{"description":"URL pointing to the location of a full image of the catalog item variant.","type":["string","null"],"examples":["https://via.placeholder.com/300"]},"image_thumbnail_url":{"description":"URL pointing to the location of an image thumbnail of the catalog item variant.","type":["string","null"],"examples":["https://via.placeholder.com/150"]},"images":{"description":"List of URLs pointing to the locations of images of the catalog item variant.","type":["array","null"],"items":{"type":"string"},"examples":[["https://via.placeholder.com/150"]]},"custom_metadata":{"description":"Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.","type":["object","null"],"examples":[{"Top Pick":true}]},"published":{"description":"Boolean value indicating whether the catalog item variant is published.","type":["boolean","null"],"examples":[true]}}}},"required":["type","id","attributes"]},"CatalogVariantEnum":{"type":"string","enum":["catalog-variant"]}}},"name":"Bulk Update Catalog Variants","id":"klaviyo.bulk_update_catalog_variants","example":{"headers":{"revision":"2026-10-15"},"body":{"data":{"type":"catalog-variant-bulk-update-job","attributes":{"variants":{"data":[]}}}}},"maxRequests":1,"summary":false}}