Skip to main content

Variants template

Create and update BigCommerce variants using Shift.

tip

Check out our step-by-step guides for how to import & export.

Quick start

The best way to get started is to run an export and use the file as a guide to the format required.

You can also download the variants template.

Supported variant actions

Shift supports:

  • Updating variant fields, e.g. inventory, price, purchasability, etc.

Shift does not currently support:

  • 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

FieldsDescription
Product IDThis is the unique identifier provided by BigCommerce for existing products. It's unique per BigCommerce store.
🔑 This field is required.
Product NameThe associated product's name.
🔒 This field is read-only.
Product SKUThe associated product's SKU.
🔒 This field is read-only.
Variant IDBigCommerce's unique identifier for the variant.
This field is required to update existing variants.
Variant LabelThis is a combination of all of the option labels and can be used to help identify variants.
🔒 This field is read-only.
Variant SKUThe variant's SKU.
This cannot currently be used to identify products on import. Only the Variant ID can be used to identify existing variants.
PriceThe price of the variant. This might include or exclude tax, depending on your tax settings.
Calculated PriceThis 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 PriceThe cost price of the product. This is used for internal reporting only.
Retail PriceThe recommended retail product of the product (MSRP). Displayed on the storefront.
Sale PriceWhen provided, this price will be used for calculating the variant's price instead of the Price field.
Map PriceThe minimum advertised price
Bin Picking NumberThe BIN picking number for this variant.
Calculated WeightThe weight to be used for this variant. It considers the product weight if no weight is set on the variant.
DepthThe depth of the variant. The unit is defined in Physical and Dimensional Settings.
Fixed Cost Shipping PriceSet a specific shipping price for this variant.
GTINThe Global Trade Item Number for the variant
HeightThe height of the variant. The unit is defined in Physical and Dimensional Settings
Image URLThe URL of the image for this variant. Displayed on the storefront when this variant's options are selected.
❌ Variant images cannot be imported due to an open BigCommerce issue.
Inventory LevelThe 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 LevelWhen the available stock for a variant is at the warning level, or lower, it is considered low stock.
Free ShippingWhen a product has free shipping, the shipping costs will be zero.
MPNThe Manufacturer Part Number for the variant.
Purchasing DisabledWhen enabled, this variant will not be available to purchasable on the storefront.
Purchasing Disabled MessageThe message to show on the storefront when this variant is set to Purchasing Disabled.
SKU ID🔒 This field is read-only.
UPCThe UPC code used in feeds for this variant
WeightThe weight of the variant. The unit is defined in Physical and Dimensional Settings.

Variant options columns

A variant will have one or more options. These are the selections that are made on a product page that identify the variant to add to cart.

FieldsDescription
Option 1 NameThe name of the first option on the first variant, e.g. Colour, Size.
🔒 This field is read-only.
Option 1 ValueThe value of the first
🔒 This field is read-only.

Metafield columns

FieldsDescription
{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.
info

As we don't know the names of metafields in advance, you can only select all metafields when exporting.

Export filters

You can filter variants that are exported, by choosing to export variants for products that match one of the following filters:

  • Product ID Range
  • Brands
  • Categories
  • Purchasability
  • Condition
  • Date updated
  • Visibility
  • Keyword
  • Name

Available filters when exporting variants

tip

As you reduce the number of items in your export, or change what data should be included, the estimate of the number of records and duration of the export will be updated.

info

An accurate estimate for variants cannot be provided so only an indication is given.