Skip to content

variant_collection object

A variant_collection object contains the properties that define a collection of product variants.

Variant Collection objects are managed by the /variant_collections endpoint.

variant_collection properties

The following are the properties of a variant_collection object.

name

Propertyname
Data typestring
DescriptionThe name of this variant collection
Example"Shoes"

product_ids

Propertyproduct_ids
Data typearray of product_ids
DescriptionThe IDs of all products that are members of this collection
Example 
[
  1234,
  2345,
  3456
]

Example variant_collection object

{
  "name": "Shoes",
  "product_ids": [
    3456,
    4567,
    5678
  ]
}