Variants
Quick start
Supported variant actions
- Updating variant fields, e.g. inventory, price, purchasability, etc.
- Create a product with variants
- Updating an option label
- Adding a variant option (and related variants)
- Adding a variant option value (and related variants)
- Updating variant option type
- Updating variant option value
- Deleting a variant option (and related variants)
- Deleting a variant option value (and related variants)
- Updating the default variant or options
Import & export columns
Basic columns
Fields
|
Description
|
Product ID
|
This is the unique identifier provided by BigCommerce for existing products. It's unique per BigCommerce store.
This field is required.
|
Product Name
|
The associated product's name.
🔒 This field is read-only. |
Product SKU
|
The associated product's SKU.
🔒 This field is read-only. |
Variant ID
|
BigCommerce's unique identifier for the variant.
This field is required to update existing variants. |
Variant Label
|
This is a combination of all of the option labels and can be used to help identify variants.
🔒 This field is read-only. |
Variant SKU
|
The variant's SKU. This cannot currently be used to identify products on import. Only the Variant ID can be used to identify existing variants. |
Price
|
The price of the variant. This might include or exclude tax, depending on your tax settings.
|
Calculated Price
|
This is the price that will be used for this variant. It considers the product and variant's price and sale price. 🔒 This field is read-only. |
Cost Price
|
The cost price of the product. This is used for internal reporting only.
|
Retail Price
|
The recommended retail product of the product (MSRP). Displayed on the storefront.
|
Sale Price
|
When provided, this price will be used for calculating the variant's price instead of the Price field.
|
Map Price
|
The minimum advertised price
|
Bin Picking Number
|
The BIN picking number for this variant.
|
Calculated Weight
|
The weight to be used for this variant. It considers the product weight if no weight is set on the variant.
|
Depth
|
The depth of the variant. The unit is defined in Physical and Dimensional Settings. |
Fixed Cost Shipping Price
|
Set a specific shipping price for this variant.
|
GTIN
|
The Global Trade Item Number for the variant
|
Height
|
The height of the variant. The unit is defined in Physical and Dimensional Settings. |
Image URL
|
The URL of the image for this variant. Displayed on the storefront when this variant's options are seleced. ❌ Variant images cannot be imported due to an open BigCommerce issue. |
Inventory Level
|
The available stock for this variant. This is used when the product's Inventory Tracking is set to variant . The inventory level only returns to the stock available on the default location.
|
Inventory Warning Level
|
When the available stock for a variant is at the warning level, or lower, it is considered low stock.
|
Free Shipping
|
When a product has free shipping, the shipping costs will be zero.
|
MPN
|
The Manufacturer Part Number for the variant.
|
Purchasing Disabled
|
When enabled, this variant will not be available to purchasable on the storefront.
|
Purchasing Disabled Message
|
The message to show on the storefront when this variant is set to Purchasing Disabled.
|
SKU ID
|
🔒 This field is read-only.
|
UPC
|
The UPC code used in feeds for this variant
|
Weight
|
The weight of the variant. The unit is defined in Physical and Dimensional Settings. |
Variant options columns
Fields
|
Description
|
Option 1 Name
|
The name of the first option on the first variant, e.g. Colour, Size.
🔒 This field is read-only.
|
Option 1 Value
|
The value of the first
🔒 This field is read-only. |
Metafield columns
Fields
|
Description
|
{namespace}.{key}
|
You can create and update variant metafields by adding a column named after the metafield namespace and metafield key separated by a
. If the metafield already exists for the product, it will be updated, otherwise, it will be created.
The metafield namespace and key each must be fewer than 65 characters
Metafield values can be up to 65,535 characters long. An empty string or a string with only whitespace is not a valid metafield value.
All metafields will be created with write and storefront access permissions so they can be queried via the storefront GraphQL API.
|
Export filters
- Product ID Range
- Brands
- Categories
- Purchasability
- Condition
- Date updated
- Visibility
- Keyword
- Name
An accurate estimate for variants cannot be provided so only an indication is given.