A ProductVariant represents an individual product variant in your Liftoff account.
See Product for details on the relationship between Products and ProductVariants.
Properties
| Name | Type | Description |
|---|---|---|
| Id | int | The ID of the product variant. |
| AccountId | int | The ID of the Liftoff account that the product variant belongs to. (Note: This account ID will always correspond to the account code you use in your authentication credentials.) |
| Account (via $expand) | Account | The Liftoff account that the product variant belongs to. |
| ProductId | int | The ID of the product that the variant belongs to. |
| Product (via $expand) | Product | The product that the variant belongs to. |
| SKU | string | The SKU for the product variant. Maximum length is 75 characters. SKUs may contain letters, numbers, hyphens, underscores, number signs, and spaces. Each SKU must be distinct across all of your account's products. |
| IsPublished | boolean | Flag that indicates whether the product variant is active in your Liftoff account. |
| VariantName | string | The name of the product variant. Displayed on product landing pages and in users' carts. |
| VariantDescription | string | A brief description of the product variant. Displayed on product landing pages. |
| RestrictQuantities | boolean | If this flag is true, a dropdown containing only the product variant's price breaks will be presented for quantity entry. If false, a free-form text field will be presented for quantity entry. |
| QuantityIncrement | int | If this value is 0, then available quantities will include only the product variant's price breaks. If non-0, then available quantities will be incremented by that value between each price break. |
| MaxQuantity | int | The maximum quantity allowed for ordering. If null, then no maximum will be enforced. |
| UnitCode | string | The unit in which the product variant is sold. Used for calculating pricing and shipping rates. |
| UnitQuantity | int | The number of products in each unit. |
| WeightPerUnit | decimal(18,4) | The weight of each unit of your product, in pounds. IMPORTANT: If this value is null, then your site's first shipping option will be $0, and all other shipping options will be disabled. |
| HandlingFeePerCarton | decimal(18,2) | The handling fee for each shipment, in USD. If provided, this value is added to the shipping charges for the order. |
| ShipUnitsSeparately | boolean | If this flag is true, then each unit of the product will be rated as a separate shipment. For example, an order for a quantity of 10 would result in 10 separately-rated shipments. |
| TemplateId | int | The ID of the template used for product configuration. Set to null for stock products. |
| Template (via $expand) | Template | The template used for product configuration. |
| ProductVariantSKUOptionValues (via $expand) | ProductVariantSKUOptionValue array | The collection of SKU option values for the variant. |
| ProductVariantFields (via $expand) | ProductVariantField array | The collection of fields for the variant. |
| ProductVariantFiles (via $expand) | ProductVariantFile array | The collection of files for the variant. |
| ProductVariantImages (via $expand) | ProductVariantImage array | The collection of images for the variant. |