Update a variant
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/products/1/variants/1';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"seller_sku":"example","external_id":"example","price":1,"inventory":1,"min_stock_alert":1,"weight":1,"dimensions":{"length":1,"width":1,"height":1,"unit":"example"},"status":"active","is_default":true,"track_inventory":true,"inventory_policy":"deny","cost_per_item":125000,"images":[{"id":"b1f0…","url":"https://cdn.ecomweb.app/stores/1/red.jpg"}],"combinations":[{"option_id":1,"option_value_id":5}],"updated_at":"2023-12-01T10:00:00Z"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://apibase.ecomweb.app/api/v1/stores/example/products/1/variants/1 \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "seller_sku": "example", "external_id": "example", "price": 1, "inventory": 1, "min_stock_alert": 1, "weight": 1, "dimensions": { "length": 1, "width": 1, "height": 1, "unit": "example" }, "status": "active", "is_default": true, "track_inventory": true, "inventory_policy": "deny", "cost_per_item": 125000, "images": [ { "id": "b1f0…", "url": "https://cdn.ecomweb.app/stores/1/red.jpg" } ], "combinations": [ { "option_id": 1, "option_value_id": 5 } ], "updated_at": "2023-12-01T10:00:00Z" }'Writes only the keys present in the body; an omitted key leaves its column unchanged, and an explicit null clears a nullable column. This works like the PATCH route except that a combinations array, when sent, replaces the variant’s whole combination set. A change to inventory is recorded as a stock adjustment. Variant cost_per_item is returned only when the key holds the read:inventory scope.
Required scopes: write:products
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product ID.
The variant ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Seller SKU
External integration id
Price
Absolute inventory count
Low-stock alert threshold
Weight
object
Length in specified unit
Width in specified unit
Height in specified unit
Unit of measurement
Whether this variant is the product’s default
Track stock for this variant. An untracked variant is never reserved and never blocked at checkout.
Example
trueDeny: checkout rejects an order this variant cannot cover. continue: keep selling past zero.
Example
denyWhat the store pays per unit. null clears it. Never returned to storefront callers.
Example
125000object
Asset id
Example
b1f0…Public asset URL
Example
https://cdn.ecomweb.app/stores/1/red.jpgCombinations for this variant. When present, replaces the whole set.
object
Variant option ID
Example
1Variant option value ID
Example
5Updated timestamp (auto-generated if not provided)
Example
2023-12-01T10:00:00ZResponses
Section titled “Responses”object
deny rejects checkout when stock is short; continue lets stock go negative.
Package dimensions, or null.
object
Images for this variant.
object
Asset ID of the image. Omit it to have the asset looked up from url, which must then be a URL of an asset uploaded to this store.
Image URL: the asset’s public_url or cdn_url
Canva design ID
Canva design edit URL
Canva asset ID
Image alt text
Image caption
Sort order for image display
Whether this is the primary image
Attribute values that define this variant. Present only when combinations are requested.
object
The attribute (axis), or null when it no longer exists.
object
Attribute ID.
Attribute name, such as “Color”.
URL-safe identifier of the attribute, unique within the store.
How values are chosen, such as select.
How the values are ordered, such as manual.
Position of the attribute among the store’s attributes.
When the attribute was created, as an ISO 8601 timestamp.
When the attribute was last updated, as an ISO 8601 timestamp.
Code of the global taxonomy attribute this one maps to, or null for a local attribute.
The chosen value, or null when it no longer exists.
object
Attribute value ID.
ID of the attribute this value belongs to.
Stored value, such as “red”.
Value as shown to shoppers, such as “Red”.
Swatch kind: none, color or image.
Swatch content: a color code or an image URL. Empty when there is no swatch.
Position of the value within its attribute.
When the value was created, as an ISO 8601 timestamp.
When the value was last updated, as an ISO 8601 timestamp.
Code of the global taxonomy value this one maps to, or null.
Active promotions on this variant. Present only when promotions are requested on a single product.
object
Promotion ID.
Promotion name.
Promotion description.
How the promotion is applied, such as automatic or code.
Discount code, for code promotions.
Promotion type.
What the promotion targets, such as product or variant.
How the discount is computed, such as PERCENTAGE or FIXED_AMOUNT.
Discount amount or percentage.
Upper bound on the discount amount.
Fixed price the item is sold at, for fixed-price promotions.
Minimum order amount for the promotion to apply.
Minimum quantity for the promotion to apply.
When the promotion starts, as an ISO 8601 timestamp.
When the promotion ends, as an ISO 8601 timestamp.
Price after the promotion.
Price before the promotion.
Amount taken off the original price.
The promotion giving the lowest price, or null. Present only when promotions are requested on a single product.
object
Promotion ID.
Promotion name.
Promotion description.
How the promotion is applied, such as automatic or code.
Discount code, for code promotions.
Promotion type.
What the promotion targets, such as product or variant.
How the discount is computed, such as PERCENTAGE or FIXED_AMOUNT.
Discount amount or percentage.
Upper bound on the discount amount.
Fixed price the item is sold at, for fixed-price promotions.
Minimum order amount for the promotion to apply.
Minimum quantity for the promotion to apply.
When the promotion starts, as an ISO 8601 timestamp.
When the promotion ends, as an ISO 8601 timestamp.
Price after the promotion.
Price before the promotion.
Amount taken off the original price.
Variant ID.
ID of the product this variant belongs to.
Store-wide numeric SKU identifier, assigned automatically.
Merchant-assigned SKU, or null.
The variant’s ID in an external system, or null.
Selling price in the store’s currency.
Units available across all locations.
Counter that increases on every stock change.
Stock level at or below which the variant counts as low stock.
Whether stock is tracked. When false the variant never runs out.
Unit cost to the store. Present only when the key holds the read:inventory scope.
Null when no cost is recorded.
Weight, in the store’s weight unit, or null.
Whether this is the product’s default variant.
Variant status, such as active or inactive.
When the variant was created, as an ISO 8601 timestamp.
When the variant was last updated, as an ISO 8601 timestamp.
Price after the best active promotion. Present only when promotions are requested; null when none applies.
Example
{ "inventory_policy": "deny", "images": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "url": "https://example.com/image.jpg", "design_id": "DABCdefg123", "design_edit_url": "https://canva.com/design/edit/123", "canva_asset_id": "asset123", "alt": "Product image", "caption": "Main product view", "sort_order": 1, "is_primary": true } ]}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The request conflicts with the resource’s current state.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}