Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List product variants

Retrieves all variants for a specific product with optional filtering by attributes, warehouse, store group, market, tags, categories, and status. Supports pagination and sorting.

GET/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
product_idstringrequired

Product ID

app_slugstringrequired

App slug

team_slugstringrequired

Team slug

Query parameters
per-pageinteger

Amount of product variants per page. Minimum 0 and max 100 (default is 20)

pageinteger

Page number (default is 1)

attributesstring[]

Filter by attributes. Format: template_key/value_key. e.g., color/red

warehouse_slugsstring[]

Filter by warehouse slugs. e.g., main-warehouse

store_group_slugsstring[]

Filter by store group slugs. e.g., retail-stores

market_slugsstring[]

Filter by market slugs. e.g., us-market

idsstring[]

Filter by variant ids

tag_keysstring[]

Filter by tag keys. e.g., color, size

category_idsstring[]

Filter by category IDs

collection_idsstring[]

Filter by collection IDs

statusstring[]

Filter by status. Allowed values: active, draft, inactive, archived

sort_bystring

Sort by field: name, variant_number, created_at (default: name)

sort_orderstring

Sort order: asc, desc (default: asc)

Responses
200

Product variants

datagithub_com_enadhq_nabbit_internal_pkg_webserver_models.Variant[]required
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Variant
attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute
created_atstring
descriptionstring | null
filterableboolean | null
idstring
keystring
namestring | null
template_keystring
template_namestring
translatableboolean | null
translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslations
Show properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
updated_atstring | null
valuesobject | null
created_atstring
custom_fieldsobject | null
idstring
imagesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority[] | null

Images of the product

Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority
altstring | null
app_idstring | null
attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null
blurhashstring
copyrightstring | null
customobject | null
folder_idstring
idstring
parent_idstring | null
priorityinteger
publicboolean
statusstring
titlestring | null
translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageTranslation
Show properties
altgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
copyrightgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
urlstring
listingsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListings
Show properties
smartgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListing[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListing
idstring
slugstring
staticgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListing[] | null
parent_product_idstring
purchase_pricegithub_com_enadhq_nabbit_internal_pkg_webserver_models.PurchasePrice | null
Show properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.PurchasePrice
currencystring
value_centsinteger
null
null
shipping_attributesstring[] | null
statusstring
store_groupgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantStoreGroupWithPrices[] | null

Product StoreGroup

Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantStoreGroupWithPrices
created_atstring
idstring
namestring
pricesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantPrice[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantPrice
amount_cents_with_taxinteger
created_atstring
idstring
marketgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market
on_saleboolean
reference_price_with_taxinteger | null
sale_end_timestampstring | null
sale_price_with_taxinteger | null
sale_start_timestampstring | null
statusgithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceStatus
Allowed:activeinactivedraft
updated_atstring | null
slugstring
store_typestring
updated_atstring | null
tagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Tag[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Tag
attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null
created_atstring
filterableboolean
idstring
keystring
marketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Market
activeboolean
country_codesstring[] | null
created_atstring
currency_codestring
idstring
localestring
namestring
slugstring
updated_atstring | null
namestring
schedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Job
add_category_namesstring[]
add_collection_namesstring[]
add_tag_namesstring[]
execute_atstring

Date when the job should run

finished_atstring | null

If a job is finished will this timestamp be filled

group_idstring
idstring
item_idstring
item_namestring
item_typestring
remove_category_namesstring[]
remove_collection_namesstring[]
remove_tag_namesstring[]
to_amount_cents_with_taxinteger | null
to_market_idstring
to_market_statusstring
to_on_saleboolean | null
to_sale_amount_cents_with_taxinteger | null
to_start_sale_timestampstring
to_statusstring | null
to_stop_sale_timestampstring
to_store_group_idstring
statusstring
translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.TagTranslations
Show properties
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
updated_atstring | null
translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantTranslations
Show properties
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation
idstring
localestring
valuestring
updated_atstring | null
validate_stockboolean
variant_dimensionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Dimensions | null
Show properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.Dimensions
capacity_milliliterinteger

the capacity in milliliter

min 0
depthinteger

The products depth in millimeter

min 0
diameterinteger

the products diameter in millimeter

min 0
heightinteger

The products height in millimeter

min 0
lengthinteger

The products length in millimeter

min 0
weightinteger

The products weight in grams

min 0
widthinteger

The products width in millimeter

min 0
null
null
variant_group_idstring
variant_namestring
variant_numberstring
videosgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Video[] | null

Videos of the product

Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Video
attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null
descriptionstring
folder_idstring
idstring
pathstring
publicboolean
statusstring
titlestring
translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoTranslations
Show properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
variantsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariant[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariant
formatstring
heightinteger
urlstring
widthinteger
warehouse_variant_stockgithub_com_enadhq_nabbit_internal_pkg_webserver_models.WarehouseVariantStock[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.WarehouseVariantStock
available_onlineboolean
created_atstring
idstring
inventory_datestring | null
quantityinteger
updated_atstring | null
warehouse_namestring
warehouse_slugstring
successboolean
totalinteger
total_pagesinteger
400

Invalid request (e.g. bad UUID, validation error)

detailsstring[]
messagestring
successbooleanrequired
401

Unauthorized access

detailsstring[]
messagestring
successbooleanrequired
500

Internal server error

detailsstring[]
messagestring
successbooleanrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.enad.io/api/v1/string/string/products/string/variants' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "attributes": [
        {
          "created_at": "string",
          "description": "string",
          "filterable": true,
          "id": "string",
          "key": "string",
          "name": "string",
          "template_key": "string",
          "template_name": "string",
          "translatable": true,
          "translations": {
            "description": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ],
            "name": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ]
          },
          "updated_at": "string",
          "values": {
            "property1": {
              "field_id": "string",
              "id": "string",
              "image_id": "string",
              "image_object": {
                "alt": "string",
                "app_id": "string",
                "blurhash": "string",
                "copyright": "string",
                "custom": {
                  "property1": "string",
                  "property2": "string"
                },
                "folder_id": "string",
                "id": "string",
                "parent_id": "string",
                "public": true,
                "status": "string",
                "title": "string",
                "url": "string"
              },
              "translations": {
                "value": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ]
              },
              "type": "string",
              "value": "string"
            },
            "property2": {
              "field_id": "string",
              "id": "string",
              "image_id": "string",
              "image_object": {
                "alt": "string",
                "app_id": "string",
                "blurhash": "string",
                "copyright": "string",
                "custom": {
                  "property1": "string",
                  "property2": "string"
                },
                "folder_id": "string",
                "id": "string",
                "parent_id": "string",
                "public": true,
                "status": "string",
                "title": "string",
                "url": "string"
              },
              "translations": {
                "value": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ]
              },
              "type": "string",
              "value": "string"
            }
          }
        }
      ],
      "created_at": "string",
      "custom_fields": {
        "property1": "string",
        "property2": "string"
      },
      "id": "string",
      "images": [
        {
          "alt": "string",
          "app_id": "string",
          "attributes": [
            {
              "created_at": "string",
              "description": "string",
              "filterable": true,
              "id": "string",
              "key": "string",
              "name": "string",
              "template_key": "string",
              "template_name": "string",
              "translatable": true,
              "translations": {
                "description": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ],
                "name": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ]
              },
              "updated_at": "string",
              "values": {
                "property1": {
                  "field_id": "string",
                  "id": "string",
                  "image_id": "string",
                  "image_object": {
                    "alt": "string",
                    "app_id": "string",
                    "blurhash": "string",
                    "copyright": "string",
                    "custom": {
                      "property1": "string",
                      "property2": "string"
                    },
                    "folder_id": "string",
                    "id": "string",
                    "parent_id": "string",
                    "public": true,
                    "status": "string",
                    "title": "string",
                    "url": "string"
                  },
                  "translations": {
                    "value": [
                      {
                        "id": "string",
                        "locale": "string",
                        "value": "string"
                      }
                    ]
                  },
                  "type": "string",
                  "value": "string"
                },
                "property2": {
                  "field_id": "string",
                  "id": "string",
                  "image_id": "string",
                  "image_object": {
                    "alt": "string",
                    "app_id": "string",
                    "blurhash": "string",
                    "copyright": "string",
                    "custom": {
                      "property1": "string",
                      "property2": "string"
                    },
                    "folder_id": "string",
                    "id": "string",
                    "parent_id": "string",
                    "public": true,
                    "status": "string",
                    "title": "string",
                    "url": "string"
                  },
                  "translations": {
                    "value": [
                      {
                        "id": "string",
                        "locale": "string",
                        "value": "string"
                      }
                    ]
                  },
                  "type": "string",
                  "value": "string"
                }
              }
            }
          ],
          "blurhash": "string",
          "copyright": "string",
          "custom": {
            "property1": "string",
            "property2": "string"
          },
          "folder_id": "string",
          "id": "string",
          "parent_id": "string",
          "priority": 0,
          "public": true,
          "status": "string",
          "title": "string",
          "translations": {
            "alt": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ],
            "copyright": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ],
            "title": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ]
          },
          "url": "string"
        }
      ],
      "listings": {
        "smart": [
          {
            "id": "string",
            "slug": "string"
          }
        ],
        "static": [
          {
            "id": "string",
            "slug": "string"
          }
        ]
      },
      "parent_product_id": "string",
      "purchase_price": {
        "currency": "string",
        "value_cents": 0
      },
      "shipping_attributes": [
        "string"
      ],
      "status": "string",
      "store_group": [
        {
          "created_at": "string",
          "id": "string",
          "name": "string",
          "prices": [
            {
              "amount_cents_with_tax": 0,
              "created_at": "string",
              "id": "string",
              "market": {
                "active": true,
                "country_codes": [
                  "string"
                ],
                "created_at": "string",
                "currency_code": "string",
                "id": "string",
                "locale": "string",
                "name": "string",
                "slug": "string",
                "updated_at": "string"
              },
              "on_sale": true,
              "reference_price_with_tax": 0,
              "sale_end_timestamp": "string",
              "sale_price_with_tax": 0,
              "sale_start_timestamp": "string",
              "status": "active",
              "updated_at": "string"
            }
          ],
          "slug": "string",
          "store_type": "string",
          "updated_at": "string"
        }
      ],
      "tags": [
        {
          "attributes": [
            {
              "created_at": "string",
              "description": "string",
              "filterable": true,
              "id": "string",
              "key": "string",
              "name": "string",
              "template_key": "string",
              "template_name": "string",
              "translatable": true,
              "translations": {
                "description": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ],
                "name": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ]
              },
              "updated_at": "string",
              "values": {
                "property1": {
                  "field_id": "string",
                  "id": "string",
                  "image_id": "string",
                  "image_object": {
                    "alt": "string",
                    "app_id": "string",
                    "blurhash": "string",
                    "copyright": "string",
                    "custom": {
                      "property1": "string",
                      "property2": "string"
                    },
                    "folder_id": "string",
                    "id": "string",
                    "parent_id": "string",
                    "public": true,
                    "status": "string",
                    "title": "string",
                    "url": "string"
                  },
                  "translations": {
                    "value": [
                      {
                        "id": "string",
                        "locale": "string",
                        "value": "string"
                      }
                    ]
                  },
                  "type": "string",
                  "value": "string"
                },
                "property2": {
                  "field_id": "string",
                  "id": "string",
                  "image_id": "string",
                  "image_object": {
                    "alt": "string",
                    "app_id": "string",
                    "blurhash": "string",
                    "copyright": "string",
                    "custom": {
                      "property1": "string",
                      "property2": "string"
                    },
                    "folder_id": "string",
                    "id": "string",
                    "parent_id": "string",
                    "public": true,
                    "status": "string",
                    "title": "string",
                    "url": "string"
                  },
                  "translations": {
                    "value": [
                      {
                        "id": "string",
                        "locale": "string",
                        "value": "string"
                      }
                    ]
                  },
                  "type": "string",
                  "value": "string"
                }
              }
            }
          ],
          "created_at": "string",
          "filterable": true,
          "id": "string",
          "key": "string",
          "markets": [
            {
              "active": true,
              "country_codes": [
                "string"
              ],
              "created_at": "string",
              "currency_code": "string",
              "id": "string",
              "locale": "string",
              "name": "string",
              "slug": "string",
              "updated_at": "string"
            }
          ],
          "name": "string",
          "schedules": [
            {
              "add_category_names": [
                "string"
              ],
              "add_collection_names": [
                "string"
              ],
              "add_tag_names": [
                "string"
              ],
              "execute_at": "string",
              "finished_at": "string",
              "group_id": "string",
              "id": "string",
              "item_id": "string",
              "item_name": "string",
              "item_type": "string",
              "remove_category_names": [
                "string"
              ],
              "remove_collection_names": [
                "string"
              ],
              "remove_tag_names": [
                "string"
              ],
              "to_amount_cents_with_tax": 0,
              "to_market_id": "string",
              "to_market_status": "string",
              "to_on_sale": true,
              "to_sale_amount_cents_with_tax": 0,
              "to_start_sale_timestamp": "string",
              "to_status": "string",
              "to_stop_sale_timestamp": "string",
              "to_store_group_id": "string"
            }
          ],
          "status": "string",
          "translations": {
            "name": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ]
          },
          "updated_at": "string"
        }
      ],
      "translations": {
        "name": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ]
      },
      "updated_at": "string",
      "validate_stock": true,
      "variant_dimensions": {
        "capacity_milliliter": 0,
        "depth": 0,
        "diameter": 0,
        "height": 0,
        "length": 0,
        "weight": 0,
        "width": 0
      },
      "variant_group_id": "string",
      "variant_name": "string",
      "variant_number": "string",
      "videos": [
        {
          "attributes": [
            {
              "created_at": "string",
              "description": "string",
              "filterable": true,
              "id": "string",
              "key": "string",
              "name": "string",
              "template_key": "string",
              "template_name": "string",
              "translatable": true,
              "translations": {
                "description": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ],
                "name": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ]
              },
              "updated_at": "string",
              "values": {
                "property1": {
                  "field_id": "string",
                  "id": "string",
                  "image_id": "string",
                  "image_object": {
                    "alt": "string",
                    "app_id": "string",
                    "blurhash": "string",
                    "copyright": "string",
                    "custom": {
                      "property1": "string",
                      "property2": "string"
                    },
                    "folder_id": "string",
                    "id": "string",
                    "parent_id": "string",
                    "public": true,
                    "status": "string",
                    "title": "string",
                    "url": "string"
                  },
                  "translations": {
                    "value": [
                      {
                        "id": "string",
                        "locale": "string",
                        "value": "string"
                      }
                    ]
                  },
                  "type": "string",
                  "value": "string"
                },
                "property2": {
                  "field_id": "string",
                  "id": "string",
                  "image_id": "string",
                  "image_object": {
                    "alt": "string",
                    "app_id": "string",
                    "blurhash": "string",
                    "copyright": "string",
                    "custom": {
                      "property1": "string",
                      "property2": "string"
                    },
                    "folder_id": "string",
                    "id": "string",
                    "parent_id": "string",
                    "public": true,
                    "status": "string",
                    "title": "string",
                    "url": "string"
                  },
                  "translations": {
                    "value": [
                      {
                        "id": "string",
                        "locale": "string",
                        "value": "string"
                      }
                    ]
                  },
                  "type": "string",
                  "value": "string"
                }
              }
            }
          ],
          "description": "string",
          "folder_id": "string",
          "id": "string",
          "path": "string",
          "public": true,
          "status": "string",
          "title": "string",
          "translations": {
            "description": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ],
            "title": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ]
          },
          "variants": [
            {
              "format": "string",
              "height": 0,
              "url": "string",
              "width": 0
            }
          ]
        }
      ],
      "warehouse_variant_stock": [
        {
          "available_online": true,
          "created_at": "string",
          "id": "string",
          "inventory_date": "string",
          "quantity": 0,
          "updated_at": "string",
          "warehouse_name": "string",
          "warehouse_slug": "string"
        }
      ]
    }
  ],
  "success": true,
  "total": 0,
  "total_pages": 0
}