Variants are sub elements of products that define different variations a product exist in, ex. different colors, sizes etc. Variants cannot exist on its own as they need to be attached to a product. Variants have defining attributes which defines the attributes variants of a product vary on, ex. color and size, with and length etc.
No more than 5000 variants can be requested at a time. If no limit is provided, the default limit of 1000 will be used. By default, archived variants are not returned
false
1000
OK
Id of variant
Indicate if only uids of referenced to global list values shall be returned instead of the materialized values
false
#Available from v.3.5.0
Id of variant
Uid of enrichment insight to toggle ignore for
Indicate whether to ignore the insight for the given enrichment insight and variant
OK
No content
Id of variant
Update model containing the updates to make on a variant. Note that properties with null values will be ignored and will not cause an update. This means you should only set properties that shall be updated on the variant
Id of product to move variant to
Indicate whether the product shall be archived or un-archived
Reference to the archive reason when archiving variant (if IsArchived is true)
Sort order of variant compared to other variants of the product
Sort order of variant compared to other variants in same variant group
Workflow state to set on the variant
OK
No content
A maximum of 5000 variants can be created in one request
Model for creating a new variant
Id of product to attach variant to
Sort order of variant compared to other variants of the product (when null, variant is placed after existing variants)
Sort order of variant compared to other variants in same variant group
Workflow state to set on the variant
Provide an identifier alias along with an array of identifiers to get the internal entity ids matching those identifiers
The alias of the identifier
Array of identifiers to return internal ids for
OK
No more than 5000 variants can be requested at a time.
Define which categories to fetch data for and what data to fetch
Ids of products to return
Defines which attribute values to return
If IncludeValues is Scopes, define which scopes to return values for here
If IncludeValues is Aliases, define aliases of the attributes to include values for
If IncludeValues is Uids, define uids of the attributes to include values for
Only return values for specific languages
Only return values for specific dimension segments
Indicate if only uids of referenced to global list values shall be returned instead of the materialized values
Get attribute values back in time
OK
Extended search model used for searching products or variants in PIM with support for paging and sorting
Include archived items in result
OK
#Available from v.3.5.0
Uid of enrichment insight to toggle ignore for
Indicate whether to ignore the insight for the given enrichment insight and variants
OK
No content
A maximum of 1000 products can be requested in one request
Request model for getting inheritedAttributes for a list of products
The product ids to get inherited attributes for
The attribute uids to get inherited attributes for
OK