Discovery Tags
Operations and Schemas
Discovery Tags (Tags) are a feature to describe a Menu Item and positively influence search and discovery.
Want to learn how to Link Discovery Tags to a Menu Item?
Each Tag belongs to a TagGroup, which groups similar product qualities i.e:
- Effects
- Flavors
- Material
- Dietary
Operations
You can explore available Discovery Tags with these operations:
| Method | Description | Try It! |
|---|---|---|
| GET | Retrieve all Discovery Tags | Retrieve Discovery Tags |
You can utilize the many
filtersparameters on these operation for search and discovery.
Schemas
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Discovery Tags",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the tag"
},
"slug": {
"type": "string",
"description": "URL-friendly identifier (lowercase, hyphens)",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"name": {
"type": "string",
"description": "Human-readable name of the tag"
},
"published": {
"type": "boolean",
"description": "Whether the tag is publicly visible"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of the last update"
},
"group": {
"type": "object",
"description": "Optional grouping metadata for this tag",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the group"
},
"name": {
"type": "string",
"description": "Name of the group"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of when the group was last updated"
}
},
"required": [
"id",
"name",
"updated_at"
],
"additionalProperties": false
}
},
"required": [
"id",
"slug",
"name",
"published",
"updated_at",
"group"
],
"additionalProperties": false
}
{
"id": 121,
"slug": "mint",
"name": "Mint",
"published": true,
"updated_at": "2023-10-19T19:14:37Z",
"group": {
"id": 8,
"name": "Flavors",
"updated_at": "2019-10-30T21:24:58Z"
}
}
Updated 3 days ago