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