Skip to main content
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
variants
Error
A valid request URL is required to generate request examples
{
  "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>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ],
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>",
          "values": {}
        }
      ],
      "created_at": "<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>",
                    "omni_channel_translations": [
                      {
                        "id": "<string>",
                        "market_id": "<string>",
                        "store_group_id": "<string>",
                        "value": "<string>"
                      }
                    ],
                    "value": "<string>"
                  }
                ],
                "name": [
                  {
                    "id": "<string>",
                    "locale": "<string>",
                    "omni_channel_translations": [
                      {
                        "id": "<string>",
                        "market_id": "<string>",
                        "store_group_id": "<string>",
                        "value": "<string>"
                      }
                    ],
                    "value": "<string>"
                  }
                ]
              },
              "updated_at": "<string>",
              "values": {}
            }
          ],
          "blurhash": "<string>",
          "copyright": "<string>",
          "custom": {},
          "folder_id": "<string>",
          "id": "<string>",
          "priority": 123,
          "status": "<string>",
          "title": "<string>",
          "translations": {
            "alt": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ],
            "copyright": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ],
            "title": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ]
          },
          "url": "<string>"
        }
      ],
      "listings": {
        "smart": [
          {
            "id": "<string>",
            "slug": "<string>"
          }
        ],
        "static": [
          {
            "id": "<string>",
            "slug": "<string>"
          }
        ]
      },
      "omnichannel": {
        "store_group_attributes": [
          {
            "id": "<string>",
            "market_id": "<string>",
            "store_group_id": "<string>",
            "value": [
              {
                "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>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ],
                  "name": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>",
                "values": {}
              }
            ]
          }
        ],
        "store_group_categories": [
          {
            "id": "<string>",
            "market_id": "<string>",
            "store_group_id": "<string>",
            "value": [
              {
                "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>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ],
                      "name": [
                        {
                          "id": "<string>",
                          "locale": "<string>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ]
                    },
                    "updated_at": "<string>",
                    "values": {}
                  }
                ],
                "children": [
                  {
                    "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>",
                              "omni_channel_translations": [
                                {
                                  "id": "<string>",
                                  "market_id": "<string>",
                                  "store_group_id": "<string>",
                                  "value": "<string>"
                                }
                              ],
                              "value": "<string>"
                            }
                          ],
                          "name": [
                            {
                              "id": "<string>",
                              "locale": "<string>",
                              "omni_channel_translations": [
                                {
                                  "id": "<string>",
                                  "market_id": "<string>",
                                  "store_group_id": "<string>",
                                  "value": "<string>"
                                }
                              ],
                              "value": "<string>"
                            }
                          ]
                        },
                        "updated_at": "<string>",
                        "values": {}
                      }
                    ],
                    "children": "<array>",
                    "created_at": "<string>",
                    "id": "<string>",
                    "name": "<string>",
                    "parent_id": "<string>",
                    "redirects": [
                      {
                        "id": "<string>",
                        "item_id": "<string>",
                        "locale": "<string>",
                        "new_slug": "<string>",
                        "old_slug": "<string>",
                        "type": "product"
                      }
                    ],
                    "slug": "<string>",
                    "sort_order": 123,
                    "status": "<string>",
                    "translations": {
                      "name": [
                        {
                          "id": "<string>",
                          "locale": "<string>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ],
                      "slug": [
                        {
                          "id": "<string>",
                          "locale": "<string>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ]
                    },
                    "updated_at": "<string>",
                    "uri": "<string>"
                  }
                ],
                "created_at": "<string>",
                "id": "<string>",
                "name": "<string>",
                "order": 123,
                "parent_id": "<string>",
                "redirects": [
                  {
                    "id": "<string>",
                    "item_id": "<string>",
                    "locale": "<string>",
                    "new_slug": "<string>",
                    "old_slug": "<string>",
                    "type": "product"
                  }
                ],
                "slug": "<string>",
                "sort_order": 123,
                "status": "<string>",
                "translations": {
                  "name": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ],
                  "slug": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>",
                "uri": "<string>"
              }
            ]
          }
        ],
        "store_group_collections": [
          {
            "id": "<string>",
            "market_id": "<string>",
            "store_group_id": "<string>",
            "value": [
              {
                "slug": "<string>",
                "status": "active",
                "children": [
                  {
                    "slug": "<string>",
                    "status": "active",
                    "children": "<array>",
                    "created_at": "<string>",
                    "id": "<string>",
                    "parent_id": "<string>",
                    "redirects": [
                      {
                        "id": "<string>",
                        "item_id": "<string>",
                        "locale": "<string>",
                        "new_slug": "<string>",
                        "old_slug": "<string>",
                        "type": "product"
                      }
                    ],
                    "title": "<string>",
                    "translations": {
                      "slug": [
                        {
                          "id": "<string>",
                          "locale": "<string>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ],
                      "title": [
                        {
                          "id": "<string>",
                          "locale": "<string>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ]
                    },
                    "updated_at": "<string>",
                    "uri": "<string>"
                  }
                ],
                "created_at": "<string>",
                "id": "<string>",
                "order": 123,
                "parent_id": "<string>",
                "redirects": [
                  {
                    "id": "<string>",
                    "item_id": "<string>",
                    "locale": "<string>",
                    "new_slug": "<string>",
                    "old_slug": "<string>",
                    "type": "product"
                  }
                ],
                "title": "<string>",
                "translations": {
                  "slug": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ],
                  "title": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>",
                "uri": "<string>"
              }
            ]
          }
        ],
        "store_group_images": [
          {
            "id": "<string>",
            "market_id": "<string>",
            "store_group_id": "<string>",
            "value": [
              {
                "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>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ],
                      "name": [
                        {
                          "id": "<string>",
                          "locale": "<string>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ]
                    },
                    "updated_at": "<string>",
                    "values": {}
                  }
                ],
                "blurhash": "<string>",
                "copyright": "<string>",
                "custom": {},
                "folder_id": "<string>",
                "id": "<string>",
                "priority": 123,
                "status": "<string>",
                "title": "<string>",
                "translations": {
                  "alt": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ],
                  "copyright": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ],
                  "title": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ]
                },
                "url": "<string>"
              }
            ]
          }
        ],
        "store_group_tags": [
          {
            "id": "<string>",
            "market_id": "<string>",
            "store_group_id": "<string>",
            "value": [
              {
                "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>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ],
                      "name": [
                        {
                          "id": "<string>",
                          "locale": "<string>",
                          "omni_channel_translations": [
                            {
                              "id": "<string>",
                              "market_id": "<string>",
                              "store_group_id": "<string>",
                              "value": "<string>"
                            }
                          ],
                          "value": "<string>"
                        }
                      ]
                    },
                    "updated_at": "<string>",
                    "values": {}
                  }
                ],
                "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>",
                "order": 123,
                "schedules": [
                  {
                    "execute_at": "<string>",
                    "finished_at": "<string>",
                    "id": "<string>",
                    "item_id": "<string>",
                    "item_type": "<string>",
                    "to_amount_cents_with_tax": 123,
                    "to_on_sale": true,
                    "to_sale_amount_cents_with_tax": 123,
                    "to_status": "<string>"
                  }
                ],
                "status": "<string>",
                "translations": {
                  "name": [
                    {
                      "id": "<string>",
                      "locale": "<string>",
                      "omni_channel_translations": [
                        {
                          "id": "<string>",
                          "market_id": "<string>",
                          "store_group_id": "<string>",
                          "value": "<string>"
                        }
                      ],
                      "value": "<string>"
                    }
                  ]
                },
                "updated_at": "<string>"
              }
            ]
          }
        ],
        "store_group_variant_name": [
          {
            "id": "<string>",
            "market_id": "<string>",
            "store_group_id": "<string>",
            "value": "<string>"
          }
        ]
      },
      "parent_product_id": "<string>",
      "product_name": "<string>",
      "product_number": "<string>",
      "shipping_attributes": [
        "<string>"
      ],
      "status": "<string>",
      "store_group": [
        {
          "created_at": "<string>",
          "id": "<string>",
          "name": "<string>",
          "prices": [
            {
              "amount_cents_with_tax": 123,
              "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,
              "sale_end_timestamp": "<string>",
              "sale_price_with_tax": 123,
              "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>",
                    "omni_channel_translations": [
                      {
                        "id": "<string>",
                        "market_id": "<string>",
                        "store_group_id": "<string>",
                        "value": "<string>"
                      }
                    ],
                    "value": "<string>"
                  }
                ],
                "name": [
                  {
                    "id": "<string>",
                    "locale": "<string>",
                    "omni_channel_translations": [
                      {
                        "id": "<string>",
                        "market_id": "<string>",
                        "store_group_id": "<string>",
                        "value": "<string>"
                      }
                    ],
                    "value": "<string>"
                  }
                ]
              },
              "updated_at": "<string>",
              "values": {}
            }
          ],
          "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": [
            {
              "execute_at": "<string>",
              "finished_at": "<string>",
              "id": "<string>",
              "item_id": "<string>",
              "item_type": "<string>",
              "to_amount_cents_with_tax": 123,
              "to_on_sale": true,
              "to_sale_amount_cents_with_tax": 123,
              "to_status": "<string>"
            }
          ],
          "status": "<string>",
          "translations": {
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>"
        }
      ],
      "translations": {
        "name": [
          {
            "id": "<string>",
            "locale": "<string>",
            "omni_channel_translations": [
              {
                "id": "<string>",
                "market_id": "<string>",
                "store_group_id": "<string>",
                "value": "<string>"
              }
            ],
            "value": "<string>"
          }
        ]
      },
      "updated_at": "<string>",
      "validate_stock": true,
      "variant_name": "<string>",
      "variant_number": "<string>",
      "videos": [
        {
          "description": "<string>",
          "folder_id": "<string>",
          "id": "<string>",
          "path": "<string>",
          "status": "<string>",
          "title": "<string>",
          "translations": {
            "description": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ],
            "title": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ]
          },
          "variants": [
            {
              "format": "<string>",
              "height": 123,
              "url": "<string>",
              "width": 123
            }
          ]
        }
      ],
      "warehouse_variant_stock": [
        {
          "available_online": true,
          "created_at": "<string>",
          "id": "<string>",
          "inventory_date": "<string>",
          "quantity": 123,
          "updated_at": "<string>",
          "warehouse_name": "<string>",
          "warehouse_slug": "<string>"
        }
      ]
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

Query Parameters

per-page
integer

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

page
integer

Page number (default is 1)

product_numbers
string[]

Filter by product numbers. e.g., SKU-001

product_ids
string[]

Filter by product IDs

tag_keys
string[]

Filter by tag keys (variants that have these tags)

category_ids
string[]

Filter by category IDs

collection_ids
string[]

Filter by collection IDs

status
string[]

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

attributes
string[]

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

warehouse_slugs
string[]

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

store_group_slugs
string[]

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

market_slugs
string[]

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

ids
string[]

Filter by variant ids

Search by variant name (case-insensitive, partial match)

sort_by
string

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

sort_order
string

Sort order: asc, desc (default: asc)

Response

List of variants

data
object[]
success
boolean
total
integer
total_pages
integer