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.
/api/v1/{team_slug}/{app_slug}/variantsAuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
app_slugstringrequiredApp slug
team_slugstringrequiredTeam slug
per-pageintegerAmount of variants per page. Minimum 0 and max 100 (default is 20)
pageintegerPage number (default is 1)
product_numbersstring[]Filter by product numbers. e.g., SKU-001
product_idsstring[]Filter by product IDs
tag_keysstring[]Filter by tag keys (variants that have these tags)
category_idsstring[]Filter by category IDs
collection_idsstring[]Filter by collection IDs
statusstring[]Filter by status. Allowed values: active, draft, inactive, archived
attributesstring[]Filter by attributes. Format: template_key/value_key. e.g., color/red
parent_attributesstring[]Filter by parent product 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
searchstringSearch by variant name (case-insensitive, partial match)
sort_bystringSort by field: name, variant_number, created_at (default: name)
sort_orderstringSort order: asc, desc (default: asc)
smart-listingstring[]Filter by smart-listing slug(s)
static-listingstring[]Filter by static-listing slug(s)
List of variants
datagithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantWithProductInformation[]requiredShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantWithProductInformationattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.Attributecreated_atstringdescriptionstring | nullfilterableboolean | nullidstringkeystringnamestring | nulltemplate_keystringtemplate_namestringtranslatableboolean | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslationsShow propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]updated_atstring | nullvaluesobject | nullcreated_atstringcustom_fieldsobject | nullidstringimagesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriority[] | nullImages of the product
Show propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.ImageWithPriorityaltstring | nullapp_idstring | nullattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullblurhashstringcopyrightstring | nullcustomobject | nullfolder_idstringidstringparent_idstring | nullpriorityintegerpublicbooleanstatusstringtitlestring | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ImageTranslationShow propertiesHide properties
altgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullcopyrightgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nulltitlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullurlstringlistingsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListingsShow propertiesHide properties
smartgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListing[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListingidstringslugstringstaticgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VariantListing[] | nullparent_product_idstringproduct_namestringproduct_numberstringpurchase_pricegithub_com_enadhq_nabbit_internal_pkg_webserver_models.PurchasePrice | nullShow propertiesHide properties
currencystringvalue_centsintegernullshipping_attributesstring[] | nullstatusstringstore_groupgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantStoreGroupWithPrices[] | nullProduct StoreGroup
Show propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantStoreGroupWithPricescreated_atstringidstringnamestringpricesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantPrice[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantPriceamount_cents_with_taxintegercreated_atstringidstringmarketgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Marketon_salebooleanreference_price_with_taxinteger | nullsale_end_timestampstring | nullsale_price_with_taxinteger | nullsale_start_timestampstring | nullstatusgithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceStatusactiveinactivedraftupdated_atstring | nullslugstringstore_typestringupdated_atstring | nulltagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Tag[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.Tagattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullcreated_atstringfilterablebooleanidstringkeystringmarketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.Marketactivebooleancountry_codesstring[] | nullcreated_atstringcurrency_codestringidstringlocalestringnamestringslugstringupdated_atstring | nullnamestringschedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.Jobadd_category_namesstring[]add_collection_namesstring[]add_tag_namesstring[]execute_atstringDate when the job should run
finished_atstring | nullIf a job is finished will this timestamp be filled
group_idstringidstringitem_idstringitem_namestringitem_typestringremove_category_namesstring[]remove_collection_namesstring[]remove_tag_namesstring[]to_amount_cents_with_taxinteger | nullto_market_idstringto_market_statusstringto_on_saleboolean | nullto_sale_amount_cents_with_taxinteger | nullto_start_sale_timestampstringto_statusstring | nullto_stop_sale_timestampstringto_store_group_idstringstatusstringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.TagTranslationsShow propertiesHide properties
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]updated_atstring | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.ProductVariantTranslationsShow propertiesHide properties
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.Translationidstringlocalestringvaluestringupdated_atstring | nullvalidate_stockbooleanvariant_dimensionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Dimensions | nullShow propertiesHide properties
capacity_milliliterintegerthe capacity in milliliter
depthintegerThe products depth in millimeter
diameterintegerthe products diameter in millimeter
heightintegerThe products height in millimeter
lengthintegerThe products length in millimeter
weightintegerThe products weight in grams
widthintegerThe products width in millimeter
nullvariant_group_idstringvariant_namestringvariant_numberstringvideosgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Video[] | nullVideos of the product
Show propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.Videoattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nulldescriptionstringfolder_idstringidstringpathstringpublicbooleanstatusstringtitlestringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoTranslationsShow propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nulltitlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | nullvariantsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariant[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.VideoVariantformatstringheightintegerurlstringwidthintegerwarehouse_variant_stockgithub_com_enadhq_nabbit_internal_pkg_webserver_models.WarehouseVariantStock[] | nullShow propertiesHide properties
github_com_enadhq_nabbit_internal_pkg_webserver_models.WarehouseVariantStockavailable_onlinebooleancreated_atstringidstringinventory_datestring | nullquantityintegerupdated_atstring | nullwarehouse_namestringwarehouse_slugstringsuccessbooleantotalintegertotal_pagesintegerInvalid request (e.g., bad query parameter)
detailsstring[]messagestringsuccessbooleanrequiredUnauthorized access
detailsstring[]messagestringsuccessbooleanrequiredInternal server error
detailsstring[]messagestringsuccessbooleanrequired