DocsDocsReference

List all app variants

Retrieves all variants for an app with optional filtering by product, category, collection, status, attributes, and more. Supports pagination and sorting.

GET/api/v1/{team_slug}/{app_slug}/variants
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/variants

Retrieves all variants for an app with optional filtering by product, category, collection, status, attributes, and more. Supports pagination and sorting.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/variants
  • Summary: List all app variants
  • Description: Retrieves all variants for an app with optional filtering by product, category, collection, status, attributes, and more. Supports pagination and sorting.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters21 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
per-pagequeryNointegerAmount of variants per page. Minimum 0 and max 100 (default is 20)
pagequeryNointegerPage number (default is 1)
product_numbersqueryNostring[]Filter by product numbers. e.g., SKU-001
product_idsqueryNostring[]Filter by product IDs
tag_keysqueryNostring[]Filter by tag keys (variants that have these tags)
category_idsqueryNostring[]Filter by category IDs
collection_idsqueryNostring[]Filter by collection IDs
statusqueryNostring[]Filter by status. Allowed values: active, draft, inactive, archived
attributesqueryNostring[]Filter by attributes. Format: template_key/value_key. e.g., color/red
parent_attributesqueryNostring[]Filter by parent product attributes. Format: template_key/value_key. e.g., color/red
warehouse_slugsqueryNostring[]Filter by warehouse slugs. e.g., main-warehouse
store_group_slugsqueryNostring[]Filter by store group slugs. e.g., retail-stores
market_slugsqueryNostring[]Filter by market slugs. e.g., us-market
idsqueryNostring[]Filter by variant ids
searchqueryNostringSearch by variant name (case-insensitive, partial match)
sort_byqueryNostringSort by field: name, variant_number, created_at (default: name)
sort_orderqueryNostringSort order: asc, desc (default: asc)
smart-listingqueryNostring[]Filter by smart-listing slug(s)
static-listingqueryNostring[]Filter by static-listing slug(s)
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200List of variantsapplication/json (object)
400Invalid request (e.g., bad query parameter)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Variant With Product Information List

PropertyTypeRequiredDetails
dataobject[]No-
successbooleanNo-
totalintegerNo-
total_pagesintegerNo-
Variant With Product Information
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
custom_fieldsobjectNo-
idstringNo-
imagesobject[]NoImages of the product
listingsobjectNo-
parent_product_idstringNo-
product_namestringNo-
product_numberstringNo-
purchase_priceobjectNo-
shipping_attributesstring[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
store_groupobject[]NoProduct StoreGroup
tagsobject[]No-
translationsobjectNo-
updated_atstringNo-
validate_stockbooleanNo-
variant_dimensionsobjectNo-
variant_group_idstringNo-
variant_namestringNo-
variant_numberstringNo-
videosobject[]NoVideos of the product
warehouse_variant_stockobject[]No-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
Image With Priority
PropertyTypeRequiredDetails
altstringNo-
app_idstringNo-
attributesobject[]No-
blurhashstringNo-
copyrightstringNo-
customobjectNo-
folder_idstringNo-
idstringNo-
parent_idstringNo-
priorityintegerNo-
publicbooleanNo-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
titlestringNo-
translationsobjectNo-
urlstringNo-
Variant Listings
PropertyTypeRequiredDetails
smartobject[]No-
staticobject[]No-
Purchase Price
PropertyTypeRequiredDetails
currencystringNo-
value_centsintegerNo-
Product Variant Store Group With Prices
PropertyTypeRequiredDetails
created_atstringNo-
idstringNo-
namestringNo-
pricesobject[]No-
slugstringNo-
store_typestringNo-
updated_atstringNo-
Tag
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
marketsobject[]No-
namestringNo-
schedulesobject[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
translationsobjectNo-
updated_atstringNo-
Product Variant Translations
PropertyTypeRequiredDetails
nameobject[]No-
Dimensions
PropertyTypeRequiredDetails
capacity_milliliterintegerNomin: 0 the capacity in milliliter
depthintegerNomin: 0 The products depth in millimeter
diameterintegerNomin: 0 the products diameter in millimeter
heightintegerNomin: 0 The products height in millimeter
lengthintegerNomin: 0 The products length in millimeter
weightintegerNomin: 0 The products weight in grams
widthintegerNomin: 0 The products width in millimeter
Video
PropertyTypeRequiredDetails
attributesobject[]No-
descriptionstringNo-
folder_idstringNo-
idstringNo-
pathstringNo-
publicbooleanNo-
statusstringNo-
titlestringNo-
translationsobjectNo-
variantsobject[]No-
Warehouse Variant Stock
PropertyTypeRequiredDetails
available_onlinebooleanNo-
created_atstringNo-
idstringNo-
inventory_datestringNo-
quantityintegerNo-
updated_atstringNo-
warehouse_namestringNo-
warehouse_slugstringNo-
{
  "data": [
    {
      "attributes": [
        {
          "created_at": null,
          "description": null,
          "filterable": null,
          "id": null,
          "key": null,
          "name": null,
          "template_key": null,
          "template_name": null,
          "translatable": null,
          "translations": null,
          "updated_at": null,
          "values": null
        }
      ],
      "created_at": "string",
      "custom_fields": {},
      "id": "string",
      "images": [
        {
          "alt": null,
          "app_id": null,
          "attributes": null,
          "blurhash": null,
          "copyright": null,
          "custom": null,
          "folder_id": null,
          "id": null,
          "parent_id": null,
          "priority": null,
          "public": null,
          "source_app_id": null,
          "source_id": null,
          "status": null,
          "title": null,
          "translations": null,
          "url": null
        }
      ],
      "listings": {
        "smart": [],
        "static": []
      },
      "parent_product_id": "string",
      "product_name": "string",
      "product_number": "string",
      "purchase_price": {
        "currency": "string",
        "value_cents": 0
      },
      "shipping_attributes": [
        "string"
      ],
      "source_app_id": "string",
      "source_id": "string",
      "status": "string",
      "store_group": [
        {
          "created_at": null,
          "id": null,
          "name": null,
          "prices": null,
          "slug": null,
          "store_type": null,
          "updated_at": null
        }
      ],
      "tags": [
        {
          "attributes": null,
          "created_at": null,
          "filterable": null,
          "id": null,
          "key": null,
          "markets": null,
          "name": null,
          "schedules": null,
          "source_app_id": null,
          "source_id": null,
          "status": null,
          "translations": null,
          "updated_at": null
        }
      ],
      "translations": {
        "name": []
      },
      "updated_at": "string",
      "validate_stock": false,
      "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": null,
          "description": null,
          "folder_id": null,
          "id": null,
          "path": null,
          "public": null,
          "status": null,
          "title": null,
          "translations": null,
          "variants": null
        }
      ],
      "warehouse_variant_stock": [
        {
          "available_online": null,
          "created_at": null,
          "id": null,
          "inventory_date": null,
          "quantity": null,
          "updated_at": null,
          "warehouse_name": null,
          "warehouse_slug": null
        }
      ]
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/variants
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Variants
  • OpenAPI summary: List all app variants

List all app variants

# List all app variants Retrieves all variants for an app with optional filtering by product, category, collection, status, attributes, and more. Supports pagination and sorting.
GET /api/v1/{team_slug}/{app_slug}/variants
Purpose

Retrieves all variants for an app with optional filtering by product, category, collection, status, attributes, and more.

Required inputs

app_slug path team_slug path

Primary response

200 ยท List of variants

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/variants

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/variants` - Summary: List all app variants - Description: Retrieves all variants for an app with optional filtering by product, category, collection, status, attributes, and more. Supports pagination and sorting. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/variants` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | per-page | query | No | integer | Amount of variants per page. Minimum 0 and max 100 (default is 20) | | page | query | No | integer | Page number (default is 1) | | product_numbers | query | No | string[] | Filter by product numbers. e.g., `SKU-001` | | product_ids | query | No | string[] | Filter by product IDs | | tag_keys | query | No | string[] | Filter by tag keys (variants that have these tags) | | category_ids | query | No | string[] | Filter by category IDs | | collection_ids | query | No | string[] | Filter by collection IDs | | status | query | No | string[] | Filter by status. Allowed values: active, draft, inactive, archived | | attributes | query | No | string[] | Filter by attributes. Format: `template_key/value_key`. e.g., `color/red` | | parent_attributes | query | No | string[] | Filter by parent product attributes. Format: `template_key/value_key`. e.g., `color/red` | | warehouse_slugs | query | No | string[] | Filter by warehouse slugs. e.g., `main-warehouse` | | store_group_slugs | query | No | string[] | Filter by store group slugs. e.g., `retail-stores` | | market_slugs | query | No | string[] | Filter by market slugs. e.g., `us-market` | | ids | query | No | string[] | Filter by variant ids | | search | query | No | string | Search by variant name (case-insensitive, partial match) | | sort_by | query | No | string | Sort by field: name, variant_number, created_at (default: name) | | sort_order | query | No | string | Sort order: asc, desc (default: asc) | | smart-listing | query | No | string[] | Filter by smart-listing slug(s) | | static-listing | query | No | string[] | Filter by static-listing slug(s) | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | List of variants | application/json (object) | | 400 | Invalid request (e.g., bad query parameter) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Variant With Product Information List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `success` | boolean | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Variant With Product Information | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `custom_fields` | object | No | - | | `id` | string | No | - | | `images` | object[] | No | Images of the product | | `listings` | object | No | - | | `parent_product_id` | string | No | - | | `product_name` | string | No | - | | `product_number` | string | No | - | | `purchase_price` | object | No | - | | `shipping_attributes` | string[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `store_group` | object[] | No | Product StoreGroup | | `tags` | object[] | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `validate_stock` | boolean | No | - | | `variant_dimensions` | object | No | - | | `variant_group_id` | string | No | - | | `variant_name` | string | No | - | | `variant_number` | string | No | - | | `videos` | object[] | No | Videos of the product | | `warehouse_variant_stock` | object[] | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | No | - | ##### Image With Priority | Property | Type | Required | Details | | --- | --- | --- | --- | | `alt` | string | No | - | | `app_id` | string | No | - | | `attributes` | object[] | No | - | | `blurhash` | string | No | - | | `copyright` | string | No | - | | `custom` | object | No | - | | `folder_id` | string | No | - | | `id` | string | No | - | | `parent_id` | string | No | - | | `priority` | integer | No | - | | `public` | boolean | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `title` | string | No | - | | `translations` | object | No | - | | `url` | string | No | - | ##### Variant Listings | Property | Type | Required | Details | | --- | --- | --- | --- | | `smart` | object[] | No | - | | `static` | object[] | No | - | ##### Purchase Price | Property | Type | Required | Details | | --- | --- | --- | --- | | `currency` | string | No | - | | `value_cents` | integer | No | - | ##### Product Variant Store Group With Prices | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `id` | string | No | - | | `name` | string | No | - | | `prices` | object[] | No | - | | `slug` | string | No | - | | `store_type` | string | No | - | | `updated_at` | string | No | - | ##### Tag | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `markets` | object[] | No | - | | `name` | string | No | - | | `schedules` | object[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | ##### Product Variant Translations | Property | Type | Required | Details | | --- | --- | --- | --- | | `name` | object[] | No | - | ##### Dimensions | Property | Type | Required | Details | | --- | --- | --- | --- | | `capacity_milliliter` | integer | No | min: 0 the capacity in milliliter | | `depth` | integer | No | min: 0 The products depth in millimeter | | `diameter` | integer | No | min: 0 the products diameter in millimeter | | `height` | integer | No | min: 0 The products height in millimeter | | `length` | integer | No | min: 0 The products length in millimeter | | `weight` | integer | No | min: 0 The products weight in grams | | `width` | integer | No | min: 0 The products width in millimeter | ##### Video | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `description` | string | No | - | | `folder_id` | string | No | - | | `id` | string | No | - | | `path` | string | No | - | | `public` | boolean | No | - | | `status` | string | No | - | | `title` | string | No | - | | `translations` | object | No | - | | `variants` | object[] | No | - | ##### Warehouse Variant Stock | Property | Type | Required | Details | | --- | --- | --- | --- | | `available_online` | boolean | No | - | | `created_at` | string | No | - | | `id` | string | No | - | | `inventory_date` | string | No | - | | `quantity` | integer | No | - | | `updated_at` | string | No | - | | `warehouse_name` | string | No | - | | `warehouse_slug` | string | No | - |
Generated example (synthetic) ```json { "data": [ { "attributes": [ { "created_at": null, "description": null, "filterable": null, "id": null, "key": null, "name": null, "template_key": null, "template_name": null, "translatable": null, "translations": null, "updated_at": null, "values": null } ], "created_at": "string", "custom_fields": {}, "id": "string", "images": [ { "alt": null, "app_id": null, "attributes": null, "blurhash": null, "copyright": null, "custom": null, "folder_id": null, "id": null, "parent_id": null, "priority": null, "public": null, "source_app_id": null, "source_id": null, "status": null, "title": null, "translations": null, "url": null } ], "listings": { "smart": [], "static": [] }, "parent_product_id": "string", "product_name": "string", "product_number": "string", "purchase_price": { "currency": "string", "value_cents": 0 }, "shipping_attributes": [ "string" ], "source_app_id": "string", "source_id": "string", "status": "string", "store_group": [ { "created_at": null, "id": null, "name": null, "prices": null, "slug": null, "store_type": null, "updated_at": null } ], "tags": [ { "attributes": null, "created_at": null, "filterable": null, "id": null, "key": null, "markets": null, "name": null, "schedules": null, "source_app_id": null, "source_id": null, "status": null, "translations": null, "updated_at": null } ], "translations": { "name": [] }, "updated_at": "string", "validate_stock": false, "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": null, "description": null, "folder_id": null, "id": null, "path": null, "public": null, "status": null, "title": null, "translations": null, "variants": null } ], "warehouse_variant_stock": [ { "available_online": null, "created_at": null, "id": null, "inventory_date": null, "quantity": null, "updated_at": null, "warehouse_name": null, "warehouse_slug": null } ] } ], "success": false, "total": 0, "total_pages": 0 } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/variants` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/variants` - OpenAPI tag: Variants - OpenAPI summary: List all app variants