List variants

get /rest/api/products/{productId}/variants

Retrieves the collection of Product Variant resources.

Returns the paginated collection of variants belonging to a product. When resolveContext is set, each variant’s resolvedPrice is computed for the given channel, country and timestamp.

Resolving prices

Set resolveContext[channel], resolveContext[country] and resolveContext[at] together to populate resolvedPrice on every returned variant. Omit all three to get the raw variant data.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Path parameters

Name	Type	Required	Description
productId	string	required	ProductResource identifier

Query parameters

Name	Type	Required	Description
resolveContext[channel]	string	-	Channel IRI used to resolve the variant price. Required together with resolveContext[country].
resolveContext[country]	string	-	Country IRI used to resolve the variant price. Required together with resolveContext[channel].
resolveContext[at]	string	-	ISO 8601 UTC timestamp at which the price is resolved. Defaults to the current time when omitted.
expand	string	-	Comma-separated list of relations to embed as full objects instead of IRI strings. Supported values: optionValues, medias, metafields, metaobject. Tokens are independent; unknown values are silently ignored. metaobject only has a visible effect when combined with metafields (it embeds the referenced metaobject on each metafield of type metaobject_reference or list__metaobject_reference).
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
order[createdAt]	string	-
order[updatedAt]	string	-
createdAt[before]	string	-
createdAt[strictly_before]	string	-
createdAt[after]	string	-
createdAt[strictly_after]	string	-
updatedAt[before]	string	-
updatedAt[strictly_before]	string	-
updatedAt[after]	string	-
updatedAt[strictly_after]	string	-

Response

200 - Product Variant collection

Property	Type	Required	Description
hydra:totalItems	integer	-
hydra:search	object	-
Show hydra:search fields Property Type Required Description @type string - hydra:template string - hydra:variableRepresentation string - hydra:mapping object[] - Show hydra:mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
hydra:view	object	-
Show hydra:view fields Property Type Required Description @id string - @type string - hydra:first string - hydra:last string - hydra:previous string - hydra:next string -
hydra:member	Product.Variant[]	required
Show hydra:member fields Property Type Required Description @context object - @id string required @type string required id string - The resource's unique identifier (UUID). barcode string required The barcode, unique UPC, or ISBN number for the product. sku string required A unique identifier for the product variant. measurement EmbeddedMeasurementResource | null - The measurement used to compute per-unit prices for the variant. Show measurement fields Property Type Required Description measuredType "volume" | "weight" | "length" | "area" | "unit" required The kind of physical quantity measured (volume, weight, length, area or unit). quantityUnit "ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit" required The unit the variant's quantity is expressed in. quantityValue integer required The variant's quantity, expressed in the quantity unit. referenceUnit "ml" | "cl" | "l" | "mg" | "g" | "kg" | "mm" | "cm" | "m" | "m2" | "unit" required The unit used as the basis for per-unit price calculations. referenceValue integer required The number of reference units used for per-unit price calculations. product string required The product resource it belongs to. optionValues string[] - A list of Option Value, each one representing an option value associated with the variant. medias string[] - A list of Media, ordered by position. Only media of type "image" can be associated with a variant. Returned as IRI strings by default; pass ?expand=medias to embed full Media objects. resolvedPrice ResolvedPriceResource | null - The price resolved for the current resolveContext (country, channel and instant). Null unless resolveContext[country], resolveContext[channel] and resolveContext[at] are all provided. Show resolvedPrice fields Property Type Required Description price EmbeddedMoneyResource - discountPrice EmbeddedMoneyResource | null - currency string - ISO 4217 currency code (mirrors price.currency for convenience). taxRate number - Tax rate applied, in percent (e.g. 20.0). taxExcludedPrice EmbeddedMoneyResource - discountTaxExcludedPrice EmbeddedMoneyResource | null - countryId string - The Country used to resolve the price. channelId string - The Channel used to resolve the price. at string - The instant used to resolve the price (defaults to request time). saleOfferId string - The SaleOffer that was resolved. lowestPriceLast30Days EmbeddedMoneyResource | null - lowestPriceLast30DaysAt string | null - The instant at which lowestPriceLast30Days was active. Falls back to at when no prior data exists. metafields string[] - Metafields owned by this variant. Serialized as IRI strings by default; pass ?expand=metafields to embed full MetafieldResource objects. createdAt string - The date and time when the resource was created (ISO 8601 format). updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

Errors

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.