Update Variants (batch)

Updates a batch of variant objects. Currently the limit is 50 variants however this is subject to change.

Required Fields

To update an existing variant:

id (variant ID)

To create a new variant:

product_id
sku
option_values
- id (option_value ID - Example: 146)
- option_id (Option ID - Example: 151)

Updates a batch of `variant` objects. Currently the limit is 50 variants however this is subject to change. **Required Fields** To update an existing variant: * id (variant ID) To create a new variant: * product_id * sku * option_values - id (option_value ID - Example: 146) - option_id (Option ID - Example: 151)

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Request

This endpoint expects a list of objects.

cost_pricedoubleOptional>=0

The cost price of the variant. It is not affected by Price List prices. This value displays as null in the control panel when cost_price equals zero.

pricedoubleOptional>=0

This variant’s base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s default price (set in the Product resource’s price field) will be used as the base price.

sale_pricedoubleOptional>=0

This variant’s sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s sale price (set in the Product resource’s price field) will be used as the sale price.

retail_pricedoubleOptional>=0

This variant’s retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s retail price (set in the Product resource’s price field) will be used as the retail price.

weightdoubleOptional>=0

This variant’s base weight on the storefront. If this value is null, the product’s default weight (set in the Product resource’s weight field) will be used as the base weight.

widthdoubleOptional>=0

Width of the variant, which can be used when calculating shipping costs. If this value is null, the productʼs default width (set in the Product resourceʼs width field) will be used as the base width.

heightdoubleOptional>=0

Height of the variant, which can be used when calculating shipping costs. If this value is null, the productʼs default height (set in the Product resourceʼs height field) will be used as the base height.

depthdoubleOptional>=0

Depth of the variant, which can be used when calculating shipping costs. If this value is null, the productʼs default depth (set in the Product resourceʼs depth field) will be used as the base depth.

is_free_shippingbooleanOptional

Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.

fixed_cost_shipping_pricedoubleOptional>=0

A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.

purchasing_disabledbooleanOptional

If true, this variant will not be purchasable on the storefront.

purchasing_disabled_messagestringOptional0-255 characters

If purchasing_disabled is true, this message should show on the storefront when the variant is selected.

upcstring or nullOptional0-14 characters

The UPC code used in feeds for shopping comparison sites and external channel integrations.

inventory_levelintegerOptional<=2147483647

Inventory level for the variant, which is used when the product’s inventory_tracking is set to variant. The Catalog API returns the inventory for only the default location.

The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647.

If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit.

The Catalog API handles limits in a different way than the Inventory API. For more information, see Limit handling.

Inventory level for the variant, which is used when the product’s inventory_tracking is set to `variant`. The Catalog API returns the inventory for only the default location. The inventory for a variant cannot exceed 2,147,483,647 in the catalog. The sum of the variant inventories, or the total inventory for a product, cannot exceed 2,147,483,647. If you exceed the limit, the store sets the variant inventory to the limit if no other variant inventories are set. If other variant inventories are set, the store does not save the variant inventory rather than setting the variant inventory to the remaining limit. The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/developer/docs/admin/catalog-and-inventory/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api).

inventory_warning_levelintegerOptional<=2147483647

When the variant hits this inventory level, it is considered low stock.

bin_picking_numberstringOptional0-255 characters

Identifies where in a warehouse the variant is located.

idintegerOptional

Response

datalist of objects

metaobject

Data about the response, including pagination and collection totals.

Errors

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/catalog/variants"
4
5	payload = [{}]
6	headers = {
7	"X-Auth-Token": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.put(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"data": [
3	{
4	"cost_price": 1.1,
5	"price": 1.1,
6	"sale_price": 1.1,
7	"retail_price": 1.1,
8	"weight": 1.1,
9	"width": 1.1,
10	"height": 1.1,
11	"depth": 1.1,
12	"is_free_shipping": true,
13	"fixed_cost_shipping_price": 1.1,
14	"purchasing_disabled": true,
15	"purchasing_disabled_message": "string",
16	"upc": "string",
17	"inventory_level": 1,
18	"inventory_warning_level": 1,
19	"bin_picking_number": "string",
20	"id": 1,
21	"product_id": 1,
22	"sku": "string",
23	"sku_id": 1,
24	"option_values": [
25	{
26	"option_display_name": "Color",
27	"label": "Beige",
28	"id": 1,
29	"option_id": 1
30	}
31	],
32	"calculated_price": 1.1
33	}
34	],
35	"meta": {
36	"pagination": {
37	"total": 36,
38	"count": 36,
39	"per_page": 50,
40	"current_page": 1,
41	"total_pages": 1,
42	"links": {
43	"previous": "string",
44	"current": "?page=1&limit=50",
45	"next": "string"
46	}
47	}
48	}
49	}

Authentication

OAuth scopes

Authentication header

Further reading

Request

Response

Errors

OAuth scopes

Authentication header

Further reading