Entities
Product Variant
ProductVariant base base
Schema
sku
string required
The merchants internal stock keeping unit (SKU) of the product variant.
name
string required
The variant-specific name. Complements the product name.
gtin
string
The external product identifier (GTIN, EAN, etc.) of the product variant.
ProductVariant availability availability
Schema
status
"inStock" | "outOfStock" | "backorder" | "preorder" required
quantity
number required
The current approximate inventory level for the variant.
availabilityDate
Date when the product is available again.
ProductVariant info info
Schema
image
object
ProductVariant options options
Schema
selected
object[] required
List of product options applied to the variant.
swatch
array | array | array | array
A swatch is a visual representation of a product option. E.g. a single color, multiple colors, a gradient or a thumbnail image.
image
__schema0
ProductVariant prices prices
Schema
price
Money required
strikethroughPrice
Money
isOnSale
boolean required
If true, indicates that the product variant is discounted from its original price. See `strikethroughPrice` for the original price and `savingsPercent` for the percentage of discount.
savingsPercent
number
Percentage of discount from the `strikethroughPrice`.
unitPrice
UnitPrice
lowestPriorPrice
Money
ProductVariant quantityPrices quantityPrices
Schema
arrayquantity
number required
The quantity above which the price is applicable.
price
Money required
savingsPercent
number required
The amount of savings compared to the price without quantity discount. In percent.
ProductVariant quantityRule quantityRule
Schema
increment
number required
The quantity increment between min and max. All valid quantities must be divisible by this value. Must be less than or equal to min and max.
max
number
If set, must be lower than or equal to the minimum. Must be a multiple of the increment.
min
number required
Minimum quantity a user has to purchase. Must be a multiple of the increment.
ProductVariant shipping shipping
Schema
rate
Money
required
boolean required
If true, the product variant requires shipping. E.g. it is a physical good.
forecast
object
Forecasted shipping time. Handling time + transit time.