Tags
Fetch tag by key
deprecated
Fetch a single tag by its key and its related products, ordered by the product-tag relationship order. Deprecated. Use https://graphql.enad.io instead.
GET
/
api
/
v1
/
omni
/
:app_id
/
:store_group
/
:market
/
:locale
/
tags
/
key
/
{tag_key}
Error
A valid request URL is required to generate request examples{
"data": {
"attributes": {},
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"products": {
"data": [
{
"attributes": {},
"brands": {
"address": {
"city": "<string>",
"co_address": "<string>",
"country": "<string>",
"email": "<string>",
"house_number": "<string>",
"postal_code": "<string>",
"state_province": "<string>",
"street_address": "<string>"
},
"name": "<string>",
"series": {
"name": "<string>",
"slug": "<string>"
},
"slug": "<string>"
},
"categories": [
{
"attributes": {},
"cover_url": "<string>",
"full_path_name": [
"<string>"
],
"full_uri_translations": {},
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": {},
"slug_translations": {},
"sort_order": 123,
"status": "<string>",
"sub_categories": [
{
"attributes": {},
"cover_url": "<string>",
"full_path_name": [
"<string>"
],
"full_uri_translations": {},
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": {},
"slug_translations": {},
"sort_order": 123,
"status": "<string>",
"sub_categories": "<array>",
"uri": "<string>"
}
],
"uri": "<string>"
}
],
"collections": [
{
"children": [
{
"children": "<array>",
"id": "<string>",
"parent_id": "<string>",
"title": "<string>",
"uri": "<string>"
}
],
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"title": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"custom_fields": {},
"description": "<string>",
"files": [
{
"attributes": {},
"title": "<string>",
"type": "<string>",
"url": "<string>"
}
],
"html_description": "<string>",
"html_short_description": "<string>",
"id": "<string>",
"images": [
{
"alt": "<string>",
"attributes": {},
"blurhash": "<string>",
"custom_fields": {},
"sort": 123,
"title": "<string>",
"url": "<string>"
}
],
"in_stock": true,
"is_active": true,
"meta_description": "<string>",
"meta_title": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"rank": 123,
"redirects": {},
"related_products": [
{
"attributes": {},
"id": "<string>",
"image": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"slug": "<string>",
"type": "<string>"
}
],
"short_description": "<string>",
"slug": "<string>",
"slug_translations": {},
"status": "<string>",
"tags": [
{
"attributes": {},
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"order": 123,
"status": "<string>",
"updated_at": "<string>"
}
],
"third_party_links": [
{
"id": "<string>",
"title": "<string>",
"type": "<string>",
"url": "<string>"
}
],
"updated_at": "<string>",
"variants": [
{
"attributes": {},
"custom_fields": {},
"description": "<string>",
"dimensions": {
"capacity_milliliter": 123,
"depth": 123,
"diameter": 123,
"height": 123,
"length": 123,
"weight": 123,
"width": 123
},
"id": "<string>",
"image_url": "<string>",
"images": [
{
"alt": "<string>",
"attributes": {},
"blurhash": "<string>",
"custom_fields": {},
"sort": 123,
"title": "<string>",
"url": "<string>"
}
],
"inventories": [
{
"inventory_date": "<string>",
"quantity": 123,
"warehouse": {
"address": {
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"region": "<string>",
"street_address": "<string>"
},
"description": "<string>",
"id": "<string>",
"name": "<string>"
}
}
],
"is_active": true,
"packaging_dimensions": {
"capacity_milliliter": 123,
"depth": 123,
"diameter": 123,
"height": 123,
"length": 123,
"weight": 123,
"width": 123
},
"prices": [
{
"country_of_sale": "<string>",
"markets": [
{
"base_price_amount": 123,
"country_code": "<string>",
"country_codes": [
"<string>"
],
"currency": "<string>",
"id": "<string>",
"market_id": "<string>",
"market_slug": "<string>",
"on_sale": true,
"reference_price_amount": 123,
"sale_end_timestamp": "<string>",
"sale_price_amount": 123,
"sale_start_timestamp": "<string>"
}
],
"store_group_description": "<string>",
"store_group_id": "<string>",
"store_group_name": "<string>",
"store_group_slug": "<string>"
}
],
"shipping_attributes": [
"<string>"
],
"tags": [
{
"attributes": {},
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"status": "<string>",
"updated_at": "<string>"
}
],
"validate_stock": true,
"variant_name": "<string>",
"variant_number": "<string>",
"videos": [
{
"attributes": {},
"description": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"videos": [
{
"attributes": {},
"description": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"page": 123,
"total": 123,
"total_pages": 123
},
"status": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Type "Bearer" followed by a space and a token.
Path Parameters
App ID
Store group
Market
Locale
Tag key
Query Parameters
Page number for products (default: 1)
Items per page for products (default: 50, max: 50)
Filter only active products
Response
Tag with paginated products
Show child attributes
Show child attributes
⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"attributes": {},
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"products": {
"data": [
{
"attributes": {},
"brands": {
"address": {
"city": "<string>",
"co_address": "<string>",
"country": "<string>",
"email": "<string>",
"house_number": "<string>",
"postal_code": "<string>",
"state_province": "<string>",
"street_address": "<string>"
},
"name": "<string>",
"series": {
"name": "<string>",
"slug": "<string>"
},
"slug": "<string>"
},
"categories": [
{
"attributes": {},
"cover_url": "<string>",
"full_path_name": [
"<string>"
],
"full_uri_translations": {},
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": {},
"slug_translations": {},
"sort_order": 123,
"status": "<string>",
"sub_categories": [
{
"attributes": {},
"cover_url": "<string>",
"full_path_name": [
"<string>"
],
"full_uri_translations": {},
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": {},
"slug_translations": {},
"sort_order": 123,
"status": "<string>",
"sub_categories": "<array>",
"uri": "<string>"
}
],
"uri": "<string>"
}
],
"collections": [
{
"children": [
{
"children": "<array>",
"id": "<string>",
"parent_id": "<string>",
"title": "<string>",
"uri": "<string>"
}
],
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"title": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"custom_fields": {},
"description": "<string>",
"files": [
{
"attributes": {},
"title": "<string>",
"type": "<string>",
"url": "<string>"
}
],
"html_description": "<string>",
"html_short_description": "<string>",
"id": "<string>",
"images": [
{
"alt": "<string>",
"attributes": {},
"blurhash": "<string>",
"custom_fields": {},
"sort": 123,
"title": "<string>",
"url": "<string>"
}
],
"in_stock": true,
"is_active": true,
"meta_description": "<string>",
"meta_title": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"rank": 123,
"redirects": {},
"related_products": [
{
"attributes": {},
"id": "<string>",
"image": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"slug": "<string>",
"type": "<string>"
}
],
"short_description": "<string>",
"slug": "<string>",
"slug_translations": {},
"status": "<string>",
"tags": [
{
"attributes": {},
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"order": 123,
"status": "<string>",
"updated_at": "<string>"
}
],
"third_party_links": [
{
"id": "<string>",
"title": "<string>",
"type": "<string>",
"url": "<string>"
}
],
"updated_at": "<string>",
"variants": [
{
"attributes": {},
"custom_fields": {},
"description": "<string>",
"dimensions": {
"capacity_milliliter": 123,
"depth": 123,
"diameter": 123,
"height": 123,
"length": 123,
"weight": 123,
"width": 123
},
"id": "<string>",
"image_url": "<string>",
"images": [
{
"alt": "<string>",
"attributes": {},
"blurhash": "<string>",
"custom_fields": {},
"sort": 123,
"title": "<string>",
"url": "<string>"
}
],
"inventories": [
{
"inventory_date": "<string>",
"quantity": 123,
"warehouse": {
"address": {
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"region": "<string>",
"street_address": "<string>"
},
"description": "<string>",
"id": "<string>",
"name": "<string>"
}
}
],
"is_active": true,
"packaging_dimensions": {
"capacity_milliliter": 123,
"depth": 123,
"diameter": 123,
"height": 123,
"length": 123,
"weight": 123,
"width": 123
},
"prices": [
{
"country_of_sale": "<string>",
"markets": [
{
"base_price_amount": 123,
"country_code": "<string>",
"country_codes": [
"<string>"
],
"currency": "<string>",
"id": "<string>",
"market_id": "<string>",
"market_slug": "<string>",
"on_sale": true,
"reference_price_amount": 123,
"sale_end_timestamp": "<string>",
"sale_price_amount": 123,
"sale_start_timestamp": "<string>"
}
],
"store_group_description": "<string>",
"store_group_id": "<string>",
"store_group_name": "<string>",
"store_group_slug": "<string>"
}
],
"shipping_attributes": [
"<string>"
],
"tags": [
{
"attributes": {},
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"status": "<string>",
"updated_at": "<string>"
}
],
"validate_stock": true,
"variant_name": "<string>",
"variant_number": "<string>",
"videos": [
{
"attributes": {},
"description": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"videos": [
{
"attributes": {},
"description": "<string>",
"title": "<string>",
"url": "<string>"
}
]
}
],
"page": 123,
"total": 123,
"total_pages": 123
},
"status": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}