Category is a JSON Structure definition published by Otter, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-category-structure.json",
"name": "Category",
"description": "Categories contain a list of Item references.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier that exists in the third party system. During a menu publish event, uuidV4 ids will be generated for new entities that do not yet exist in the internal menu.",
"example": "b01485b0-034a-47c5-8a0a-0eeca08bf994"
},
"name": {
"type": "string",
"description": "Name of Category.",
"example": "Drinks"
},
"description": {
"type": "string",
"description": "Description of Category.",
"example": "All drink items served up nice and fresh!"
},
"itemIds": {
"type": "array",
"default": [],
"description": "All items in the category.",
"items": {
"type": "string"
},
"example": [
"fa4f0192-4c4e-4455-9db8-61d428c34969"
]
},
"photoIds": {
"type": "array",
"description": "A list of Photo references associated with the Category.",
"default": [],
"items": {
"type": "string"
}
},
"exposedThirdPartyInfos": {
"type": "array",
"default": [],
"description": "Additional information about the menu that should be exposed to third party",
"items": {
"$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-exposed-third-party-info-schema.json"
}
}
},
"required": [
"id",
"name"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.