Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Products::Variant

List Variants

List variants for a product

get/products/{product_id}/variants

Path parameters

product_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

idstring

A comma-separated list of variant IDs to filter by.

visibletrue | false

Filter variants by visibility in the online store.

archivedtrue | false

Filter variants by archived state.

fulfillment_requiredtrue | false

Filter variants by fulfillment required state.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

{
  "id": "1,2,3",
  "visible": true,
  "archived": true,
  "fulfillment_required": true
}

Response

OK

idinteger

ID

public_idstring nullable

Variant public ID

product_idinteger

Product ID

namestring

Name

descriptionstring nullable

The description of the variant. The description of the default variant is the user-facing description of the Product.

skustring nullable

SKU

product_typestring

Type

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:properties_value_ids","oasType":"schema","type":"unknown","description":"Properties values"}
out_of_stock_salesstring nullable

Out of stock sales

weightnumber nullable

Weight

weight_unitstring

Weight unit

heightnumber nullable

Height

widthnumber nullable

Width

lengthnumber nullable

Length

dimensions_unitstring nullable

Dimensions unit

quantityinteger nullable

Quantity

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:tag_ids","oasType":"schema","type":"unknown","description":"Tags"}
tax_category_idstring nullable

Tax category ID

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:asset_ids","oasType":"schema","type":"unknown","description":"Assets"}
taxablestring nullable

Taxable

track_quantityboolean nullable

Track Quantity

archivedboolean nullable

Archived

visibleboolean nullable

Is visible

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:price_ids","oasType":"schema","type":"unknown","description":"Price IDs"}
fulfillment_requiredboolean nullable

Fulfillment required

country_of_manufacture_idstring nullable

Country of manufacture

{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:image_ids","oasType":"schema","type":"unknown","description":"The images for the variant."}
{"stackTrail":"components:schemas:ProductsVariantAttributes:properties:fulfillments_location_ids","oasType":"schema","type":"unknown","description":"The fulfillment locations for the variant."}
created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

defaultboolean nullable

Identifies if the variant is the default variant for the product.

Example response

[
  {
    "id": 15,
    "public_id": "NRBUIp",
    "product_id": 24,
    "name": "Small Aluminum Gloves variant 393f",
    "description": "Dolore provident unde quas.",
    "sku": "LxbnGP0kqyqzQDTK",
    "product_type": "physical",
    "properties_value_ids": [
      null
    ],
    "out_of_stock_sales": null,
    "weight": "24.0",
    "weight_unit": "lb",
    "height": "96.0",
    "width": "418.0",
    "length": "66.0",
    "dimensions_unit": "inches",
    "quantity": 0,
    "tag_ids": [
      39
    ],
    "tax_category_id": null,
    "asset_ids": [],
    "taxable": null,
    "track_quantity": false,
    "archived": false,
    "visible": true,
    "price_ids": [],
    "fulfillment_required": false,
    "country_of_manufacture_id": null,
    "image_ids": [],
    "fulfillments_location_ids": [],
    "created_at": "2025-08-11T19:14:39.799Z",
    "updated_at": "2025-08-11T19:14:39.799Z",
    "default": false,
    "properties_values": [
      {
        "property_id": 15,
        "value": "Red"
      }
    ],
    "created_by_platform_application": null
  }
]