Skip to main content
GET
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
variant-groups
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "attributes": [
        {
          "attribute_id": "<string>",
          "attribute_key": "<string>",
          "attribute_name": "<string>",
          "template_key": "<string>",
          "template_name": "<string>"
        }
      ],
      "channel_statuses": [
        {
          "channel_id": "<string>",
          "channel_slug": "<string>",
          "status": "<string>"
        }
      ],
      "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>",
                    "value": "<string>"
                  }
                ],
                "name": [
                  {
                    "id": "<string>",
                    "locale": "<string>",
                    "value": "<string>"
                  }
                ]
              },
              "updated_at": "<string>",
              "values": {}
            }
          ],
          "blurhash": "<string>",
          "copyright": "<string>",
          "custom": {},
          "folder_id": "<string>",
          "id": "<string>",
          "parent_id": "<string>",
          "priority": 123,
          "public": true,
          "source_app_id": "<string>",
          "source_id": "<string>",
          "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>"
        }
      ],
      "name": "<string>",
      "priority": 123,
      "product_id": "<string>",
      "product_name": "<string>",
      "product_number": "<string>",
      "slug": "<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": {}
            }
          ],
          "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": [
            {
              "add_category_names": [
                "<string>"
              ],
              "add_collection_names": [
                "<string>"
              ],
              "add_tag_names": [
                "<string>"
              ],
              "execute_at": "<string>",
              "finished_at": "<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": 123,
              "to_market_id": "<string>",
              "to_market_status": "<string>",
              "to_on_sale": true,
              "to_sale_amount_cents_with_tax": 123,
              "to_start_sale_timestamp": "<string>",
              "to_status": "<string>",
              "to_stop_sale_timestamp": "<string>",
              "to_store_group_id": "<string>"
            }
          ],
          "source_app_id": "<string>",
          "source_id": "<string>",
          "status": "<string>",
          "translations": {
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>"
        }
      ],
      "translations": {
        "name": [
          {
            "id": "<string>",
            "locale": "<string>",
            "value": "<string>"
          }
        ],
        "slug": [
          {
            "id": "<string>",
            "locale": "<string>",
            "value": "<string>"
          }
        ]
      },
      "updated_at": "<string>",
      "variants": [
        {
          "id": "<string>",
          "status": "<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": {}
            }
          ],
          "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": 123,
              "url": "<string>",
              "width": 123
            }
          ]
        }
      ]
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

Query Parameters

page
integer

Page number (default: 1)

per-page
integer

Items per page (default: 20, max: 100)

tag-keys
string[]

Filter by tag keys

attribute-keys
string[]

Filter by attributes as template_key/value_key (any match)

Response

Variant groups with product information

data
object[]
success
boolean
total
integer
total_pages
integer