Get product
Gets a single product with references to categories, tags, collections, media, variant groups, variants, attributes, markets, statuses, translations and brand series.
GET
/api/v2/{team_slug}/{app_slug}/products/{product_id}Authorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
team_slugstringrequiredapp_slugstringrequiredproduct_idstring<uuid>requiredResponses
200
OK
dataProductrequiredShow propertiesHide properties
idUUIDrequiredproduct_namestringrequiredproduct_numberstringrequiredslugstringstatusstringrequiredmeta_titlestringmeta_descriptionstringhtml_descriptionstringhtml_short_descriptionstringdescriptionstringshort_descriptionstringtax_group_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullproduct_typestringexclude_from_feedsbooleanproduct_dimensionsProductDimension | nullShow propertiesHide properties
Any of:
ProductDimension
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegernull
nullpackage_dimensionsProductDimension | nullShow propertiesHide properties
Any of:
ProductDimension
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegernull
nullcustom_fieldsobject | nullbrandProductBrand | nullShow propertiesHide properties
Any of:
ProductBrand
idUUIDrequirednamestringrequiredslugstringrequiredseriesProductBrandSeries | nullShow propertiesHide properties
Any of:
ProductBrandSeries
idUUIDrequirednamestringrequiredslugstringrequirednull
nullnull
nullcategoriesProductCategoryRef[] | nullShow propertiesHide properties
Array of
ProductCategoryRefidUUIDrequiredslugstringuristringtitlestringis_main_categorybooleancollectionsProductCollectionRef[] | nullShow propertiesHide properties
Array of
ProductCollectionRefidUUIDrequiredslugstringuristringtitlestringtagsProductTagRef[] | nullShow propertiesHide properties
Array of
ProductTagRefidUUIDrequiredkeystringnamestringimagesProductImageRef[] | nullShow propertiesHide properties
Array of
ProductImageRefidUUIDrequiredurlstringtitlestringpriorityintegervideosProductVideoRef[] | nullShow propertiesHide properties
Array of
ProductVideoRefidUUIDrequiredurlstringtitlestringfilesProductFileRef[] | nullShow propertiesHide properties
Array of
ProductFileRefidUUIDrequiredurlstringtitlestringcreated_atstring<date-time>updated_atstring<date-time> | nullvariant_groupsProductVariantGroupRef[] | nullShow propertiesHide properties
Array of
ProductVariantGroupRefidUUIDrequirednamestringslugstringimagesProductImageRef[] | nullrelationsProductRelationRef[] | nullShow propertiesHide properties
Array of
ProductRelationRefidUUIDrequiredtitlestringtypestringthird_party_linksProductThirdPartyLinkRef[] | nullShow propertiesHide properties
Array of
ProductThirdPartyLinkRefidUUIDrequiredtypestringtitlestringurlstringattributesProductAttribute[] | nullShow propertiesHide properties
Array of
ProductAttributeidUUIDrequiredkeystringtemplate_keystringtemplate_namestringnamestringdescriptionstringfilterablebooleantranslatablebooleanvaluesobjectmarket_statusProductMarketStatus[] | nullShow propertiesHide properties
Array of
ProductMarketStatusmarket_idUUIDrequiredstore_group_idUUIDrequiredmarket_slugstringstore_group_slugstringstatusstringrequiredAllowed:
activeinactivedraftincompletearchivedchannel_statusesProductChannelStatus[] | nullShow propertiesHide properties
Array of
ProductChannelStatuschannel_idUUIDrequiredchannel_slugstringstatusstringrequiredtranslationsProductTranslations | nullShow propertiesHide properties
Any of:
ProductTranslations
nameTranslation[]Show propertiesHide properties
Array of
TranslationidUUIDlocalestringvaluestringslugTranslation[]descriptionTranslation[]short_descriptionTranslation[]html_descriptionTranslation[]html_short_descriptionTranslation[]meta_titleTranslation[]meta_descriptionTranslation[]null
nullcreated_atstring<date-time>requiredupdated_atstring<date-time> | null400
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required401
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required403
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required404
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required500
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required