Home > @vsf-enterprise/bigcommerce-api > ProductVariant

ProductVariant interface

Product variant model.

Signature:

export interface ProductVariant 

Properties

Property	Type	Description
bin_picking_number	string	Identifies where in a warehouse the variant is located.
calculated_price	number	The price of the variant as seen on the storefront. This price takes into account sale_price and any price adjustment rules that are applicable to this variant.
calculated_weight	number	Product variant calculated weight.
cost_price	number	The cost price of the variant. Not affected by Price List prices.
depth	number | null	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.
fixed_cost_shipping_price	number	A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation.
gtin	string	Global Trade Item Number.
height	number | null	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.
id	number	ID of the variant
image_url	string	Product variant image URL.
inventory_level	number	Inventory level for the variant, which is used when the product's inventory_tracking is set to variant.
inventory_warning_level	number	When the variant hits this inventory level, it is considered low stock.
is_free_shipping	boolean	Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero.
map_price?	unknown	(Optional) Product variant map price. Property returned by API but not described in the docs.
mpn	string	The Manufacturer Part Number (MPN) for the variant.
option_values	ProductVariantOptionValue[]	Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant.
price	number | null	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.
product_id	number	ID of the product
purchasing_disabled_message	string	If purchasing_disabled is true, this message should show on the storefront when the variant is selected.
purchasing_disabled	boolean	If true, this variant will not be purchasable on the storefront.
retail_price	number | null	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.
sale_price	number | null	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.
sku_id	number | null	Read-only reference to v2 API's SKU ID. Null if it is a base variant.
sku	string	User defined product variant code/stock keeping unit (SKU).
upc	string	The UPC code used in feeds for shopping comparison sites and external channel integrations.
weight	number | null	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.
width	number | null	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.