Authentication
Authorization: Bearer <HALLIFY_TABLE_GUEST_TOKEN>Guest-owned table membership capability constrained by its native venue, session, guest, current access epochs, presentation resource and browser origin.
Parameters
originHeader · RequiredActual browser-managed request origin used to validate approved presentation provenance and its current resource binding. Browser clients preserve this value; the separate join or membership credential supplies guest authorization.
string · uriFull definition
{ "type": "string", "format": "uri", "example": "https://example.test/resource" }sessionIdPath · RequiredNative primary table-service session that owns the public access, admission requests and guest memberships addressed by this operation.
string · uuidFull definition
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
Responses
200Native published catalog including its current version and opaque graph token.
PublicMenuResponseDto
Full definition
{
"$ref": "#/components/schemas/PublicMenuResponseDto"
}Example response · 200 · application/json
{
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
"menuVersionId": "490ccfcb-caa6-472e-836a-a8416e8cee92",
"versionNumber": 1,
"graphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"publishedAt": "2026-01-15T12:00:00.000Z",
"servedAt": "2026-01-15T12:00:00.000Z",
"categories": [
{
"id": "a5038d8c-af77-49d1-8b1c-095a41971c2c",
"menuCategoryId": null,
"name": "Example name",
"sortOrder": 1,
"items": [
{
"id": "1f29df05-cd6f-4563-8c71-ad1b872b9447",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"description": null,
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"structure": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
},
"availability": {
"available": true,
"reason": "AVAILABLE"
},
"sortOrder": 1
}
]
}
]
}400The supplied identifier, query or credential shape is invalid.
TranslatedErrorDto
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}Example response · 400 · application/json
{
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}401The QR credential, current native authority or exact requesting Origin is denied.
TranslatedErrorDto
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}Example response · 401 · application/json
{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}404The current public locator, presentation binding or owned native resource is unavailable.
TranslatedErrorDto
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}Example response · 404 · application/json
{
"statusCode": 404,
"error": "errors:http.notFound",
"code": "HTTP_NOT_FOUND",
"message": "errors:http.notFound",
"translationKey": "errors:http.notFound"
}429The hashed membership/source attempt budget is exhausted. TABLE_PUBLIC_THROTTLED includes retryAfterSeconds; no new native work is performed.
Response headers
Retry-AfterWhole seconds the client must wait before retrying the rejected request.
integerFull definition
{
"type": "integer",
"minimum": 1,
"example": 60
}TranslatedErrorDto
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}Example response · 429 · application/json
{
"statusCode": 429,
"error": "errors:http.tooManyRequests",
"code": "HTTP_TOO_MANY_REQUESTS",
"message": "errors:http.tooManyRequests",
"translationKey": "errors:http.tooManyRequests"
}503QR key material or authoritative native state cannot be safely used.
TranslatedErrorDto
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}Example response · 503 · application/json
{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Schemas
PublicMenuResponseDto
Strictly bound published guest menu for one active venue and exact sales channel.
venueIdRequiredNative venue UUID owning this menu.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Native venue UUID owning this menu.", "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391" }salesChannelIdRequiredExact active sales channel UUID used for every published read.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Exact active sales channel UUID used for every published read.", "example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc" }menuVersionIdRequiredCurrent published menu version UUID for this venue and sales channel.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Current published menu version UUID for this venue and sales channel.", "example": "490ccfcb-caa6-472e-836a-a8416e8cee92" }versionNumberRequiredNative published menu version number.
integerFull definition
{ "type": "integer", "minimum": 1, "description": "Native published menu version number.", "example": 1 }graphHashRequiredOpaque published graph token required by native guest quote requests; no raw graph hash is exposed.
stringFull definition
{ "type": "string", "pattern": "^menu-cost-v1\\.graph\\.[A-Za-z0-9_-]{43}$", "description": "Opaque published graph token required by native guest quote requests; no raw graph hash is exposed.", "example": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }currencyRequiredSingle venue currency used by every published selling price in this menu.
stringFull definition
{ "type": "string", "pattern": "^[A-Z]{3}$", "description": "Single venue currency used by every published selling price in this menu.", "example": "GEL" }timeZoneRequiredVenue IANA timezone used by published package and fulfillment rules.
stringFull definition
{ "type": "string", "description": "Venue IANA timezone used by published package and fulfillment rules.", "example": "Asia/Tbilisi" }publishedAtRequiredRFC 3339 instant at which the active menu version was published.
string · date-timeFull definition
{ "type": "string", "format": "date-time", "description": "RFC 3339 instant at which the active menu version was published.", "example": "2026-01-15T12:00:00.000Z" }servedAtRequiredRFC 3339 instant used to evaluate current public availability.
string · date-timeFull definition
{ "type": "string", "format": "date-time", "description": "RFC 3339 instant used to evaluate current public availability.", "example": "2026-01-15T12:00:00.000Z" }categoriesRequiredPublished categories and explicit cost-safe guest item projections.
arrayFull definition
{ "maxItems": 500, "description": "Published categories and explicit cost-safe guest item projections.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuCategoryDto" }, "example": [ { "id": "a5038d8c-af77-49d1-8b1c-095a41971c2c", "menuCategoryId": null, "name": "Example name", "sortOrder": 1, "items": [ { "id": "1f29df05-cd6f-4563-8c71-ad1b872b9447", "menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd", "name": "Example name", "description": null, "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "variants": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "structure": { "executionMode": "DIRECT_ITEM", "configuratorMode": "DIRECT_ITEM", "pricingBehavior": "BASE_PRICE", "sellableVersions": "NONE", "groups": [ { "id": "example-id", "name": "Example name", "sourceType": "CATALOG_ITEMS", "mode": "FIXED_CONTENTS", "minSelections": 0, "maxSelections": 0, "required": true, "choices": [ { "id": "example-id", "menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd", "name": "Example name", "quantity": 1, "upcharge": 0, "isDefault": true, "isIncluded": true, "variants": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifierGroup": null } ], "courses": [ { "groupId": "example", "name": "Example name", "sequence": 0 } ], "measuredPolicy": null, "preorderPolicy": null }, "availability": { "available": true, "reason": "AVAILABLE" }, "sortOrder": 1 } ] } ] }
Full definition
{
"type": "object",
"properties": {
"venueId": {
"type": "string",
"format": "uuid",
"description": "Native venue UUID owning this menu.",
"example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
},
"salesChannelId": {
"type": "string",
"format": "uuid",
"description": "Exact active sales channel UUID used for every published read.",
"example": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc"
},
"menuVersionId": {
"type": "string",
"format": "uuid",
"description": "Current published menu version UUID for this venue and sales channel.",
"example": "490ccfcb-caa6-472e-836a-a8416e8cee92"
},
"versionNumber": {
"type": "integer",
"minimum": 1,
"description": "Native published menu version number.",
"example": 1
},
"graphHash": {
"type": "string",
"pattern": "^menu-cost-v1\\.graph\\.[A-Za-z0-9_-]{43}$",
"description": "Opaque published graph token required by native guest quote requests; no raw graph hash is exposed.",
"example": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "Single venue currency used by every published selling price in this menu.",
"example": "GEL"
},
"timeZone": {
"type": "string",
"description": "Venue IANA timezone used by published package and fulfillment rules.",
"example": "Asia/Tbilisi"
},
"publishedAt": {
"type": "string",
"format": "date-time",
"description": "RFC 3339 instant at which the active menu version was published.",
"example": "2026-01-15T12:00:00.000Z"
},
"servedAt": {
"type": "string",
"format": "date-time",
"description": "RFC 3339 instant used to evaluate current public availability.",
"example": "2026-01-15T12:00:00.000Z"
},
"categories": {
"maxItems": 500,
"description": "Published categories and explicit cost-safe guest item projections.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuCategoryDto"
},
"example": [
{
"id": "a5038d8c-af77-49d1-8b1c-095a41971c2c",
"menuCategoryId": null,
"name": "Example name",
"sortOrder": 1,
"items": [
{
"id": "1f29df05-cd6f-4563-8c71-ad1b872b9447",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"description": null,
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"structure": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
},
"availability": {
"available": true,
"reason": "AVAILABLE"
},
"sortOrder": 1
}
]
}
]
}
},
"description": "Strictly bound published guest menu for one active venue and exact sales channel.",
"required": [
"venueId",
"salesChannelId",
"menuVersionId",
"versionNumber",
"graphHash",
"currency",
"timeZone",
"publishedAt",
"servedAt",
"categories"
],
"example": {
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"salesChannelId": "ff0fa725-ba44-4e7a-82bb-a15650e0a0cc",
"menuVersionId": "490ccfcb-caa6-472e-836a-a8416e8cee92",
"versionNumber": 1,
"graphHash": "menu-cost-v1.graph.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"publishedAt": "2026-01-15T12:00:00.000Z",
"servedAt": "2026-01-15T12:00:00.000Z",
"categories": [
{
"id": "a5038d8c-af77-49d1-8b1c-095a41971c2c",
"menuCategoryId": null,
"name": "Example name",
"sortOrder": 1,
"items": [
{
"id": "1f29df05-cd6f-4563-8c71-ad1b872b9447",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"description": null,
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"structure": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
},
"availability": {
"available": true,
"reason": "AVAILABLE"
},
"sortOrder": 1
}
]
}
]
}
}PublicMenuCategoryDto
Published guest menu category containing only typed public items.
idRequiredPublished category snapshot UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Published category snapshot UUID.", "example": "a5038d8c-af77-49d1-8b1c-095a41971c2c" }menuCategoryIdRequiredStable menu category UUID, or null when the published category has no live catalog identity.
string · uuid · nullFull definition
{ "type": "string", "format": "uuid", "nullable": true, "description": "Stable menu category UUID, or null when the published category has no live catalog identity.", "example": "cb5f7601-2b73-4705-8ddc-9f32947c3200" }nameRequiredPublished guest-facing category name.
stringFull definition
{ "type": "string", "description": "Published guest-facing category name.", "example": "Example name" }sortOrderRequiredPublished category display order.
integerFull definition
{ "type": "integer", "description": "Published category display order.", "example": 1 }itemsRequiredTyped public items belonging to this published category.
arrayFull definition
{ "maxItems": 500, "description": "Typed public items belonging to this published category.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuItemDto" }, "example": [ { "id": "1f29df05-cd6f-4563-8c71-ad1b872b9447", "menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd", "name": "Example name", "description": null, "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "variants": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "structure": { "executionMode": "DIRECT_ITEM", "configuratorMode": "DIRECT_ITEM", "pricingBehavior": "BASE_PRICE", "sellableVersions": "NONE", "groups": [ { "id": "example-id", "name": "Example name", "sourceType": "CATALOG_ITEMS", "mode": "FIXED_CONTENTS", "minSelections": 0, "maxSelections": 0, "required": true, "choices": [ { "id": "example-id", "menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd", "name": "Example name", "quantity": 1, "upcharge": 0, "isDefault": true, "isIncluded": true, "variants": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifierGroup": null } ], "courses": [ { "groupId": "example", "name": "Example name", "sequence": 0 } ], "measuredPolicy": null, "preorderPolicy": null }, "availability": { "available": true, "reason": "AVAILABLE" }, "sortOrder": 1 } ] }
Full definition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Published category snapshot UUID.",
"example": "a5038d8c-af77-49d1-8b1c-095a41971c2c"
},
"menuCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "Stable menu category UUID, or null when the published category has no live catalog identity.",
"example": "cb5f7601-2b73-4705-8ddc-9f32947c3200"
},
"name": {
"type": "string",
"description": "Published guest-facing category name.",
"example": "Example name"
},
"sortOrder": {
"type": "integer",
"description": "Published category display order.",
"example": 1
},
"items": {
"maxItems": 500,
"description": "Typed public items belonging to this published category.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuItemDto"
},
"example": [
{
"id": "1f29df05-cd6f-4563-8c71-ad1b872b9447",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"description": null,
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"structure": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
},
"availability": {
"available": true,
"reason": "AVAILABLE"
},
"sortOrder": 1
}
]
}
},
"description": "Published guest menu category containing only typed public items.",
"required": [
"id",
"menuCategoryId",
"name",
"sortOrder",
"items"
],
"example": {
"id": "a5038d8c-af77-49d1-8b1c-095a41971c2c",
"menuCategoryId": null,
"name": "Example name",
"sortOrder": 1,
"items": [
{
"id": "1f29df05-cd6f-4563-8c71-ad1b872b9447",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"description": null,
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"structure": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
},
"availability": {
"available": true,
"reason": "AVAILABLE"
},
"sortOrder": 1
}
]
}
}PublicMenuItemDto
Cost-safe published guest menu item with explicit configuration and current availability.
idRequiredPublished menu item snapshot UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Published menu item snapshot UUID.", "example": "1f29df05-cd6f-4563-8c71-ad1b872b9447" }menuItemIdRequiredStable menu item UUID accepted by native guest ordering.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Stable menu item UUID accepted by native guest ordering.", "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd" }nameRequiredEffective published public item name.
stringFull definition
{ "type": "string", "description": "Effective published public item name.", "example": "Example name" }descriptionRequiredEffective published public item description; null means none is supplied.
string · nullFull definition
{ "type": "string", "nullable": true, "description": "Effective published public item description; null means none is supplied.", "example": "Synthetic example" }priceRequiredPublished item selling price in the menu currency, before guest configuration and quote validation.
numberFull definition
{ "type": "number", "minimum": 0, "maximum": 9999999999.99, "description": "Published item selling price in the menu currency, before guest configuration and quote validation.", "example": 0 }allergenCodesRequiredPublished item allergen codes.
arrayFull definition
{ "type": "array", "description": "Published item allergen codes.", "items": { "type": "string", "enum": [ "GLUTEN", "CRUSTACEANS", "EGGS", "FISH", "PEANUTS", "SOY", "MILK", "TREE_NUTS", "CELERY", "MUSTARD", "SESAME", "SULPHITES", "LUPIN", "MOLLUSCS" ], "example": "GLUTEN" }, "example": [ "GLUTEN" ] }isAlcoholicRequiredWhether the published item contains alcohol.
booleanFull definition
{ "type": "boolean", "description": "Whether the published item contains alcohol.", "example": true }modifiersRequiredEffective published base-item modifier groups.
arrayFull definition
{ "maxItems": 10000, "description": "Effective published base-item modifier groups.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuModifierGroupDto" }, "example": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ] }variantsRequiredPublished sellable versions accepted by the canonical item runtime.
arrayFull definition
{ "maxItems": 5000, "description": "Published sellable versions accepted by the canonical item runtime.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuVariantDto" }, "example": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ] }structureRequiredTyped public configuration without arbitrary policy graphs or staff internals.
allOfFull definition
{ "description": "Typed public configuration without arbitrary policy graphs or staff internals.", "allOf": [ { "$ref": "#/components/schemas/PublicMenuConfiguratorDto" } ], "example": { "executionMode": "DIRECT_ITEM", "configuratorMode": "DIRECT_ITEM", "pricingBehavior": "BASE_PRICE", "sellableVersions": "NONE", "groups": [ { "id": "example-id", "name": "Example name", "sourceType": "CATALOG_ITEMS", "mode": "FIXED_CONTENTS", "minSelections": 0, "maxSelections": 0, "required": true, "choices": [ { "id": "example-id", "menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd", "name": "Example name", "quantity": 1, "upcharge": 0, "isDefault": true, "isIncluded": true, "variants": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifierGroup": null } ], "courses": [ { "groupId": "example", "name": "Example name", "sequence": 0 } ], "measuredPolicy": null, "preorderPolicy": null } }availabilityRequiredCurrent published availability; ordering additionally validates its native service and timing rules.
allOfFull definition
{ "description": "Current published availability; ordering additionally validates its native service and timing rules.", "allOf": [ { "$ref": "#/components/schemas/PublicMenuAvailabilityDto" } ], "example": { "available": true, "reason": "AVAILABLE" } }sortOrderRequiredPublished display order within the category.
integerFull definition
{ "type": "integer", "description": "Published display order within the category.", "example": 1 }
Full definition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Published menu item snapshot UUID.",
"example": "1f29df05-cd6f-4563-8c71-ad1b872b9447"
},
"menuItemId": {
"type": "string",
"format": "uuid",
"description": "Stable menu item UUID accepted by native guest ordering.",
"example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
},
"name": {
"type": "string",
"description": "Effective published public item name.",
"example": "Example name"
},
"description": {
"type": "string",
"nullable": true,
"description": "Effective published public item description; null means none is supplied.",
"example": "Synthetic example"
},
"price": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"description": "Published item selling price in the menu currency, before guest configuration and quote validation.",
"example": 0
},
"allergenCodes": {
"type": "array",
"description": "Published item allergen codes.",
"items": {
"type": "string",
"enum": [
"GLUTEN",
"CRUSTACEANS",
"EGGS",
"FISH",
"PEANUTS",
"SOY",
"MILK",
"TREE_NUTS",
"CELERY",
"MUSTARD",
"SESAME",
"SULPHITES",
"LUPIN",
"MOLLUSCS"
],
"example": "GLUTEN"
},
"example": [
"GLUTEN"
]
},
"isAlcoholic": {
"type": "boolean",
"description": "Whether the published item contains alcohol.",
"example": true
},
"modifiers": {
"maxItems": 10000,
"description": "Effective published base-item modifier groups.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuModifierGroupDto"
},
"example": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
]
},
"variants": {
"maxItems": 5000,
"description": "Published sellable versions accepted by the canonical item runtime.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuVariantDto"
},
"example": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
]
},
"structure": {
"description": "Typed public configuration without arbitrary policy graphs or staff internals.",
"allOf": [
{
"$ref": "#/components/schemas/PublicMenuConfiguratorDto"
}
],
"example": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
}
},
"availability": {
"description": "Current published availability; ordering additionally validates its native service and timing rules.",
"allOf": [
{
"$ref": "#/components/schemas/PublicMenuAvailabilityDto"
}
],
"example": {
"available": true,
"reason": "AVAILABLE"
}
},
"sortOrder": {
"type": "integer",
"description": "Published display order within the category.",
"example": 1
}
},
"description": "Cost-safe published guest menu item with explicit configuration and current availability.",
"required": [
"id",
"menuItemId",
"name",
"description",
"price",
"allergenCodes",
"isAlcoholic",
"modifiers",
"variants",
"structure",
"availability",
"sortOrder"
],
"example": {
"id": "1f29df05-cd6f-4563-8c71-ad1b872b9447",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"description": null,
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"structure": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
},
"availability": {
"available": true,
"reason": "AVAILABLE"
},
"sortOrder": 1
}
}PublicMenuModifierGroupDto
Effective published modifier group and its available guest choices.
idRequiredPublished modifier group snapshot UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Published modifier group snapshot UUID.", "example": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d" }groupIdRequiredStable modifier group UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Stable modifier group UUID.", "example": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb" }nameRequiredPublished guest-facing modifier group name.
stringFull definition
{ "type": "string", "description": "Published guest-facing modifier group name.", "example": "Example name" }isRequiredRequiredWhether the effective published assignment requires a selection.
booleanFull definition
{ "type": "boolean", "description": "Whether the effective published assignment requires a selection.", "example": true }maxSelectionsRequiredMaximum number of options accepted by the effective published assignment.
integerFull definition
{ "type": "integer", "minimum": 0, "description": "Maximum number of options accepted by the effective published assignment.", "example": 0 }optionsRequiredCurrently available published options in their configured order.
arrayFull definition
{ "maxItems": 20000, "description": "Currently available published options in their configured order.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuModifierOptionDto" }, "example": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] }
Full definition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Published modifier group snapshot UUID.",
"example": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d"
},
"groupId": {
"type": "string",
"format": "uuid",
"description": "Stable modifier group UUID.",
"example": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb"
},
"name": {
"type": "string",
"description": "Published guest-facing modifier group name.",
"example": "Example name"
},
"isRequired": {
"type": "boolean",
"description": "Whether the effective published assignment requires a selection.",
"example": true
},
"maxSelections": {
"type": "integer",
"minimum": 0,
"description": "Maximum number of options accepted by the effective published assignment.",
"example": 0
},
"options": {
"maxItems": 20000,
"description": "Currently available published options in their configured order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuModifierOptionDto"
},
"example": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
},
"description": "Effective published modifier group and its available guest choices.",
"required": [
"id",
"groupId",
"name",
"isRequired",
"maxSelections",
"options"
],
"example": {
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
}PublicMenuModifierOptionDto
Published modifier option with guest-facing price delta and allergen information.
idRequiredPublished modifier option snapshot UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Published modifier option snapshot UUID.", "example": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126" }modifierOptionIdRequiredStable modifier option UUID used in guest selections.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Stable modifier option UUID used in guest selections.", "example": "2375c3d7-0141-4f9a-896c-d07acfb6af1b" }nameRequiredPublished guest-facing modifier option name.
stringFull definition
{ "type": "string", "description": "Published guest-facing modifier option name.", "example": "Example name" }priceDeltaRequiredPublished selling-price delta in the menu currency, using the existing numeric menu wire representation.
numberFull definition
{ "type": "number", "description": "Published selling-price delta in the menu currency, using the existing numeric menu wire representation.", "example": 0 }isDefaultRequiredWhether the published modifier option is selected by default.
booleanFull definition
{ "type": "boolean", "description": "Whether the published modifier option is selected by default.", "example": true }allergenCodesRequiredPublished allergen codes for the modifier option.
arrayFull definition
{ "type": "array", "description": "Published allergen codes for the modifier option.", "items": { "type": "string", "enum": [ "GLUTEN", "CRUSTACEANS", "EGGS", "FISH", "PEANUTS", "SOY", "MILK", "TREE_NUTS", "CELERY", "MUSTARD", "SESAME", "SULPHITES", "LUPIN", "MOLLUSCS" ], "example": "GLUTEN" }, "example": [ "GLUTEN" ] }
Full definition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Published modifier option snapshot UUID.",
"example": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126"
},
"modifierOptionId": {
"type": "string",
"format": "uuid",
"description": "Stable modifier option UUID used in guest selections.",
"example": "2375c3d7-0141-4f9a-896c-d07acfb6af1b"
},
"name": {
"type": "string",
"description": "Published guest-facing modifier option name.",
"example": "Example name"
},
"priceDelta": {
"type": "number",
"description": "Published selling-price delta in the menu currency, using the existing numeric menu wire representation.",
"example": 0
},
"isDefault": {
"type": "boolean",
"description": "Whether the published modifier option is selected by default.",
"example": true
},
"allergenCodes": {
"type": "array",
"description": "Published allergen codes for the modifier option.",
"items": {
"type": "string",
"enum": [
"GLUTEN",
"CRUSTACEANS",
"EGGS",
"FISH",
"PEANUTS",
"SOY",
"MILK",
"TREE_NUTS",
"CELERY",
"MUSTARD",
"SESAME",
"SULPHITES",
"LUPIN",
"MOLLUSCS"
],
"example": "GLUTEN"
},
"example": [
"GLUTEN"
]
}
},
"description": "Published modifier option with guest-facing price delta and allergen information.",
"required": [
"id",
"modifierOptionId",
"name",
"priceDelta",
"isDefault",
"allergenCodes"
],
"example": {
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
}PublicMenuVariantDto
Published sellable version with its effective price and modifier assignments.
idRequiredPublished sellable version snapshot UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Published sellable version snapshot UUID.", "example": "28f3e585-3f5c-438c-8645-68ea6c44e293" }menuVariantIdRequiredStable menu variant UUID used in guest selections.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Stable menu variant UUID used in guest selections.", "example": "94389946-e5d8-4fba-8358-e3a9c8a04b11" }nameRequiredPublished guest-facing sellable version name.
stringFull definition
{ "type": "string", "description": "Published guest-facing sellable version name.", "example": "Example name" }priceRequiredEffective published selling price in the menu currency; no cost or margin is included.
numberFull definition
{ "type": "number", "minimum": 0, "maximum": 9999999999.99, "description": "Effective published selling price in the menu currency; no cost or margin is included.", "example": 0 }allergenCodesRequiredPublished allergen codes for this sellable version.
arrayFull definition
{ "type": "array", "description": "Published allergen codes for this sellable version.", "items": { "type": "string", "enum": [ "GLUTEN", "CRUSTACEANS", "EGGS", "FISH", "PEANUTS", "SOY", "MILK", "TREE_NUTS", "CELERY", "MUSTARD", "SESAME", "SULPHITES", "LUPIN", "MOLLUSCS" ], "example": "GLUTEN" }, "example": [ "GLUTEN" ] }isAlcoholicRequiredWhether the published sellable version contains alcohol.
booleanFull definition
{ "type": "boolean", "description": "Whether the published sellable version contains alcohol.", "example": true }modifiersRequiredEffective base and variant modifier assignments in published order.
arrayFull definition
{ "maxItems": 10000, "description": "Effective base and variant modifier assignments in published order.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuModifierGroupDto" }, "example": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ] }availabilityRequiredCurrent public availability of this sellable version.
allOfFull definition
{ "description": "Current public availability of this sellable version.", "allOf": [ { "$ref": "#/components/schemas/PublicMenuAvailabilityDto" } ], "example": { "available": true, "reason": "AVAILABLE" } }
Full definition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Published sellable version snapshot UUID.",
"example": "28f3e585-3f5c-438c-8645-68ea6c44e293"
},
"menuVariantId": {
"type": "string",
"format": "uuid",
"description": "Stable menu variant UUID used in guest selections.",
"example": "94389946-e5d8-4fba-8358-e3a9c8a04b11"
},
"name": {
"type": "string",
"description": "Published guest-facing sellable version name.",
"example": "Example name"
},
"price": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"description": "Effective published selling price in the menu currency; no cost or margin is included.",
"example": 0
},
"allergenCodes": {
"type": "array",
"description": "Published allergen codes for this sellable version.",
"items": {
"type": "string",
"enum": [
"GLUTEN",
"CRUSTACEANS",
"EGGS",
"FISH",
"PEANUTS",
"SOY",
"MILK",
"TREE_NUTS",
"CELERY",
"MUSTARD",
"SESAME",
"SULPHITES",
"LUPIN",
"MOLLUSCS"
],
"example": "GLUTEN"
},
"example": [
"GLUTEN"
]
},
"isAlcoholic": {
"type": "boolean",
"description": "Whether the published sellable version contains alcohol.",
"example": true
},
"modifiers": {
"maxItems": 10000,
"description": "Effective base and variant modifier assignments in published order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuModifierGroupDto"
},
"example": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
]
},
"availability": {
"description": "Current public availability of this sellable version.",
"allOf": [
{
"$ref": "#/components/schemas/PublicMenuAvailabilityDto"
}
],
"example": {
"available": true,
"reason": "AVAILABLE"
}
}
},
"description": "Published sellable version with its effective price and modifier assignments.",
"required": [
"id",
"menuVariantId",
"name",
"price",
"allergenCodes",
"isAlcoholic",
"modifiers",
"availability"
],
"example": {
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
}PublicMenuAvailabilityDto
Current published availability exposed to guests without stock, capacity or staff reasons.
availableRequiredWhether the published selection is currently available to guests.
booleanFull definition
{ "type": "boolean", "description": "Whether the published selection is currently available to guests.", "example": true }reasonRequiredPublic reason for the current availability decision.
stringFull definition
{ "type": "string", "enum": [ "AVAILABLE", "PUBLISHED_UNAVAILABLE", "STAFF_INPUT_REQUIRED" ], "description": "Public reason for the current availability decision.", "example": "AVAILABLE" }
Full definition
{
"type": "object",
"properties": {
"available": {
"type": "boolean",
"description": "Whether the published selection is currently available to guests.",
"example": true
},
"reason": {
"type": "string",
"enum": [
"AVAILABLE",
"PUBLISHED_UNAVAILABLE",
"STAFF_INPUT_REQUIRED"
],
"description": "Public reason for the current availability decision.",
"example": "AVAILABLE"
}
},
"description": "Current published availability exposed to guests without stock, capacity or staff reasons.",
"required": [
"available",
"reason"
],
"example": {
"available": true,
"reason": "AVAILABLE"
}
}PublicMenuConfiguratorDto
Explicit public configurator projection derived from the canonical published item runtime.
executionModeRequiredNative published item execution mode.
stringFull definition
{ "type": "string", "enum": [ "DIRECT_ITEM", "SELLABLE_VERSION", "COMPONENT_GROUPS", "COURSE_SEQUENCE", "GUIDED_STAGES", "BUNDLE_SECTIONS", "MEASURED_QUANTITY", "OPEN_PRICE_ENTRY", "PREORDER_PACKAGE", "CUSTOM_POLICY" ], "description": "Native published item execution mode.", "example": "DIRECT_ITEM" }configuratorModeRequiredEffective canonical configurator, including the delegate of a custom policy.
stringFull definition
{ "type": "string", "enum": [ "DIRECT_ITEM", "SELLABLE_VERSION", "COMPONENT_GROUPS", "COURSE_SEQUENCE", "GUIDED_STAGES", "BUNDLE_SECTIONS", "MEASURED_QUANTITY", "OPEN_PRICE_ENTRY", "PREORDER_PACKAGE", "CUSTOM_POLICY" ], "description": "Effective canonical configurator, including the delegate of a custom policy.", "example": "DIRECT_ITEM" }pricingBehaviorRequiredCanonical published selling-price behavior; authoritative totals are calculated by the quote owner.
stringFull definition
{ "type": "string", "enum": [ "BASE_PRICE", "FIXED_PRICE", "MEASURED", "OPEN_PRICE" ], "description": "Canonical published selling-price behavior; authoritative totals are calculated by the quote owner.", "example": "BASE_PRICE" }sellableVersionsRequiredCanonical published sellable-version selection requirement.
stringFull definition
{ "type": "string", "enum": [ "NONE", "OPTIONAL", "REQUIRED" ], "description": "Canonical published sellable-version selection requirement.", "example": "NONE" }groupsRequiredTyped published guest selection groups in their configured order.
arrayFull definition
{ "maxItems": 50, "description": "Typed published guest selection groups in their configured order.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuSelectionGroupDto" }, "example": [ { "id": "example-id", "name": "Example name", "sourceType": "CATALOG_ITEMS", "mode": "FIXED_CONTENTS", "minSelections": 0, "maxSelections": 0, "required": true, "choices": [ { "id": "example-id", "menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd", "name": "Example name", "quantity": 1, "upcharge": 0, "isDefault": true, "isIncluded": true, "variants": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifierGroup": null } ] }coursesRequiredGuest-facing course names and sequence; empty for an item without courses.
arrayFull definition
{ "maxItems": 50, "description": "Guest-facing course names and sequence; empty for an item without courses.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuCourseDto" }, "example": [ { "groupId": "example", "name": "Example name", "sequence": 0 } ] }measuredPolicyRequiredPublished measurement policy, or null when the item is not measured.
object · nullFull definition
{ "nullable": true, "description": "Published measurement policy, or null when the item is not measured.", "type": "object", "properties": { "measurementType": { "type": "string", "enum": [ "WEIGHT", "VOLUME" ], "description": "Published measurement dimension.", "example": "WEIGHT" }, "unit": { "type": "string", "enum": [ "G", "KG", "OZ", "LB", "ML", "L", "FL_OZ" ], "description": "Published mass or volume unit used by the measured quantity fields.", "example": "G" }, "priceBasisQuantity": { "type": "string", "description": "Decimal quantity to which the published selling price applies.", "example": "1.00" }, "saleIncrement": { "type": "string", "description": "Decimal step between accepted guest measurement quantities.", "example": "example" }, "minimumQuantity": { "type": "string", "description": "Minimum accepted decimal measurement quantity.", "example": "1.000" }, "maximumQuantity": { "type": "string", "nullable": true, "description": "Maximum accepted decimal measurement quantity; null means no published maximum.", "example": "1.000" }, "defaultQuantity": { "type": "string", "description": "Published default decimal measurement quantity.", "example": "1.000" } }, "required": [ "measurementType", "unit", "priceBasisQuantity", "saleIncrement", "minimumQuantity", "maximumQuantity", "defaultQuantity" ], "example": { "measurementType": "WEIGHT", "unit": "G", "priceBasisQuantity": "1.00", "saleIncrement": "example", "minimumQuantity": "1.000", "maximumQuantity": null, "defaultQuantity": "1.000" } }preorderPolicyRequiredPublished catering/preorder package policy, or null for other item types.
object · nullFull definition
{ "nullable": true, "description": "Published catering/preorder package policy, or null for other item types.", "type": "object", "properties": { "pricingMode": { "type": "string", "enum": [ "FIXED_PACKAGE", "PER_GUEST" ], "description": "Whether the published package price applies per package or per guest.", "example": "FIXED_PACKAGE" }, "allowedServiceModes": { "type": "array", "description": "Fulfillment modes accepted by the published package.", "items": { "type": "string", "enum": [ "DINE_IN", "PICKUP", "DELIVERY", "CATERING" ], "example": "DINE_IN" }, "example": [ "DINE_IN" ] }, "leadTimeHours": { "type": "integer", "minimum": 1, "description": "Published minimum lead time in hours.", "example": 1 }, "maximumAdvanceDays": { "type": "integer", "minimum": 1, "description": "Published maximum number of days in advance.", "example": 1 }, "cutoffTime": { "type": "string", "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$", "description": "Published local cutoff clock time in the venue timezone.", "example": "12:30" }, "minGuestCount": { "type": "integer", "minimum": 1, "description": "Minimum guest count accepted by the package.", "example": 1 }, "maxGuestCount": { "type": "integer", "minimum": 1, "description": "Maximum guest count accepted by the package.", "example": 1 }, "guestCountStep": { "type": "integer", "minimum": 1, "description": "Published step between accepted guest counts.", "example": 1 }, "fulfillmentDays": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6, "example": 0 }, "description": "Accepted venue-local weekdays, with Sunday represented by zero.", "example": [ 0 ] }, "requiresContactDetails": { "type": "boolean", "description": "Whether this package requires guest contact details.", "example": true }, "requiresFulfillmentNote": { "type": "boolean", "description": "Whether this package requires a guest fulfillment note.", "example": true } }, "required": [ "pricingMode", "allowedServiceModes", "leadTimeHours", "maximumAdvanceDays", "cutoffTime", "minGuestCount", "maxGuestCount", "guestCountStep", "fulfillmentDays", "requiresContactDetails", "requiresFulfillmentNote" ], "example": { "pricingMode": "FIXED_PACKAGE", "allowedServiceModes": [ "DINE_IN" ], "leadTimeHours": 1, "maximumAdvanceDays": 1, "cutoffTime": "12:30", "minGuestCount": 1, "maxGuestCount": 1, "guestCountStep": 1, "fulfillmentDays": [ 0 ], "requiresContactDetails": true, "requiresFulfillmentNote": true } }
Full definition
{
"type": "object",
"properties": {
"executionMode": {
"type": "string",
"enum": [
"DIRECT_ITEM",
"SELLABLE_VERSION",
"COMPONENT_GROUPS",
"COURSE_SEQUENCE",
"GUIDED_STAGES",
"BUNDLE_SECTIONS",
"MEASURED_QUANTITY",
"OPEN_PRICE_ENTRY",
"PREORDER_PACKAGE",
"CUSTOM_POLICY"
],
"description": "Native published item execution mode.",
"example": "DIRECT_ITEM"
},
"configuratorMode": {
"type": "string",
"enum": [
"DIRECT_ITEM",
"SELLABLE_VERSION",
"COMPONENT_GROUPS",
"COURSE_SEQUENCE",
"GUIDED_STAGES",
"BUNDLE_SECTIONS",
"MEASURED_QUANTITY",
"OPEN_PRICE_ENTRY",
"PREORDER_PACKAGE",
"CUSTOM_POLICY"
],
"description": "Effective canonical configurator, including the delegate of a custom policy.",
"example": "DIRECT_ITEM"
},
"pricingBehavior": {
"type": "string",
"enum": [
"BASE_PRICE",
"FIXED_PRICE",
"MEASURED",
"OPEN_PRICE"
],
"description": "Canonical published selling-price behavior; authoritative totals are calculated by the quote owner.",
"example": "BASE_PRICE"
},
"sellableVersions": {
"type": "string",
"enum": [
"NONE",
"OPTIONAL",
"REQUIRED"
],
"description": "Canonical published sellable-version selection requirement.",
"example": "NONE"
},
"groups": {
"maxItems": 50,
"description": "Typed published guest selection groups in their configured order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuSelectionGroupDto"
},
"example": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
]
},
"courses": {
"maxItems": 50,
"description": "Guest-facing course names and sequence; empty for an item without courses.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuCourseDto"
},
"example": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
]
},
"measuredPolicy": {
"nullable": true,
"description": "Published measurement policy, or null when the item is not measured.",
"type": "object",
"properties": {
"measurementType": {
"type": "string",
"enum": [
"WEIGHT",
"VOLUME"
],
"description": "Published measurement dimension.",
"example": "WEIGHT"
},
"unit": {
"type": "string",
"enum": [
"G",
"KG",
"OZ",
"LB",
"ML",
"L",
"FL_OZ"
],
"description": "Published mass or volume unit used by the measured quantity fields.",
"example": "G"
},
"priceBasisQuantity": {
"type": "string",
"description": "Decimal quantity to which the published selling price applies.",
"example": "1.00"
},
"saleIncrement": {
"type": "string",
"description": "Decimal step between accepted guest measurement quantities.",
"example": "example"
},
"minimumQuantity": {
"type": "string",
"description": "Minimum accepted decimal measurement quantity.",
"example": "1.000"
},
"maximumQuantity": {
"type": "string",
"nullable": true,
"description": "Maximum accepted decimal measurement quantity; null means no published maximum.",
"example": "1.000"
},
"defaultQuantity": {
"type": "string",
"description": "Published default decimal measurement quantity.",
"example": "1.000"
}
},
"required": [
"measurementType",
"unit",
"priceBasisQuantity",
"saleIncrement",
"minimumQuantity",
"maximumQuantity",
"defaultQuantity"
],
"example": {
"measurementType": "WEIGHT",
"unit": "G",
"priceBasisQuantity": "1.00",
"saleIncrement": "example",
"minimumQuantity": "1.000",
"maximumQuantity": null,
"defaultQuantity": "1.000"
}
},
"preorderPolicy": {
"nullable": true,
"description": "Published catering/preorder package policy, or null for other item types.",
"type": "object",
"properties": {
"pricingMode": {
"type": "string",
"enum": [
"FIXED_PACKAGE",
"PER_GUEST"
],
"description": "Whether the published package price applies per package or per guest.",
"example": "FIXED_PACKAGE"
},
"allowedServiceModes": {
"type": "array",
"description": "Fulfillment modes accepted by the published package.",
"items": {
"type": "string",
"enum": [
"DINE_IN",
"PICKUP",
"DELIVERY",
"CATERING"
],
"example": "DINE_IN"
},
"example": [
"DINE_IN"
]
},
"leadTimeHours": {
"type": "integer",
"minimum": 1,
"description": "Published minimum lead time in hours.",
"example": 1
},
"maximumAdvanceDays": {
"type": "integer",
"minimum": 1,
"description": "Published maximum number of days in advance.",
"example": 1
},
"cutoffTime": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"description": "Published local cutoff clock time in the venue timezone.",
"example": "12:30"
},
"minGuestCount": {
"type": "integer",
"minimum": 1,
"description": "Minimum guest count accepted by the package.",
"example": 1
},
"maxGuestCount": {
"type": "integer",
"minimum": 1,
"description": "Maximum guest count accepted by the package.",
"example": 1
},
"guestCountStep": {
"type": "integer",
"minimum": 1,
"description": "Published step between accepted guest counts.",
"example": 1
},
"fulfillmentDays": {
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 6,
"example": 0
},
"description": "Accepted venue-local weekdays, with Sunday represented by zero.",
"example": [
0
]
},
"requiresContactDetails": {
"type": "boolean",
"description": "Whether this package requires guest contact details.",
"example": true
},
"requiresFulfillmentNote": {
"type": "boolean",
"description": "Whether this package requires a guest fulfillment note.",
"example": true
}
},
"required": [
"pricingMode",
"allowedServiceModes",
"leadTimeHours",
"maximumAdvanceDays",
"cutoffTime",
"minGuestCount",
"maxGuestCount",
"guestCountStep",
"fulfillmentDays",
"requiresContactDetails",
"requiresFulfillmentNote"
],
"example": {
"pricingMode": "FIXED_PACKAGE",
"allowedServiceModes": [
"DINE_IN"
],
"leadTimeHours": 1,
"maximumAdvanceDays": 1,
"cutoffTime": "12:30",
"minGuestCount": 1,
"maxGuestCount": 1,
"guestCountStep": 1,
"fulfillmentDays": [
0
],
"requiresContactDetails": true,
"requiresFulfillmentNote": true
}
}
},
"description": "Explicit public configurator projection derived from the canonical published item runtime.",
"required": [
"executionMode",
"configuratorMode",
"pricingBehavior",
"sellableVersions",
"groups",
"courses",
"measuredPolicy",
"preorderPolicy"
],
"example": {
"executionMode": "DIRECT_ITEM",
"configuratorMode": "DIRECT_ITEM",
"pricingBehavior": "BASE_PRICE",
"sellableVersions": "NONE",
"groups": [
{
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
],
"courses": [
{
"groupId": "example",
"name": "Example name",
"sequence": 0
}
],
"measuredPolicy": null,
"preorderPolicy": null
}
}PublicMenuSelectionGroupDto
Typed guest selection group shared by components, guided stages, courses, bundles and catering packages.
idRequiredStable group or stage identifier accepted in guest component selections.
stringFull definition
{ "type": "string", "description": "Stable group or stage identifier accepted in guest component selections.", "example": "example-id" }nameRequiredPublished guest-facing group or stage label.
stringFull definition
{ "type": "string", "description": "Published guest-facing group or stage label.", "example": "Example name" }sourceTypeRequiredWhether the selection refers to catalog components or published modifier options.
stringFull definition
{ "type": "string", "enum": [ "CATALOG_ITEMS", "MODIFIER_GROUP" ], "description": "Whether the selection refers to catalog components or published modifier options.", "example": "CATALOG_ITEMS" }modeRequiredPublished selection behavior for fixed contents, a guest choice or an optional add-on.
stringFull definition
{ "type": "string", "enum": [ "FIXED_CONTENTS", "GUEST_CHOICE", "OPTIONAL_ADD_ON" ], "description": "Published selection behavior for fixed contents, a guest choice or an optional add-on.", "example": "FIXED_CONTENTS" }minSelectionsRequiredMinimum number of choices required by the published group.
integerFull definition
{ "type": "integer", "minimum": 0, "description": "Minimum number of choices required by the published group.", "example": 0 }maxSelectionsRequiredMaximum number of choices allowed by the published group.
integerFull definition
{ "type": "integer", "minimum": 0, "description": "Maximum number of choices allowed by the published group.", "example": 0 }requiredRequiredWhether the guest must satisfy this published selection group.
booleanFull definition
{ "type": "boolean", "description": "Whether the guest must satisfy this published selection group.", "example": true }choicesRequiredPublished catalog choices; empty for a modifier-group stage.
arrayFull definition
{ "maxItems": 100, "description": "Published catalog choices; empty for a modifier-group stage.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuSelectionChoiceDto" }, "example": [ { "id": "example-id", "menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd", "name": "Example name", "quantity": 1, "upcharge": 0, "isDefault": true, "isIncluded": true, "variants": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ], "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ] }modifierGroupRequiredPublished modifier group for a modifier stage; null for catalog choices.
object · nullFull definition
{ "nullable": true, "description": "Published modifier group for a modifier stage; null for catalog choices.", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Published modifier group snapshot UUID.", "example": "ec6e241e-1951-41c2-8739-0bd8d04ca0a6" }, "groupId": { "type": "string", "format": "uuid", "description": "Stable modifier group UUID.", "example": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb" }, "name": { "type": "string", "description": "Published guest-facing modifier group name.", "example": "Example name" }, "isRequired": { "type": "boolean", "description": "Whether the effective published assignment requires a selection.", "example": true }, "maxSelections": { "type": "integer", "minimum": 0, "description": "Maximum number of options accepted by the effective published assignment.", "example": 0 }, "options": { "maxItems": 20000, "description": "Currently available published options in their configured order.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuModifierOptionDto" }, "example": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } }, "required": [ "id", "groupId", "name", "isRequired", "maxSelections", "options" ], "example": { "id": "ec6e241e-1951-41c2-8739-0bd8d04ca0a6", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } }
Full definition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable group or stage identifier accepted in guest component selections.",
"example": "example-id"
},
"name": {
"type": "string",
"description": "Published guest-facing group or stage label.",
"example": "Example name"
},
"sourceType": {
"type": "string",
"enum": [
"CATALOG_ITEMS",
"MODIFIER_GROUP"
],
"description": "Whether the selection refers to catalog components or published modifier options.",
"example": "CATALOG_ITEMS"
},
"mode": {
"type": "string",
"enum": [
"FIXED_CONTENTS",
"GUEST_CHOICE",
"OPTIONAL_ADD_ON"
],
"description": "Published selection behavior for fixed contents, a guest choice or an optional add-on.",
"example": "FIXED_CONTENTS"
},
"minSelections": {
"type": "integer",
"minimum": 0,
"description": "Minimum number of choices required by the published group.",
"example": 0
},
"maxSelections": {
"type": "integer",
"minimum": 0,
"description": "Maximum number of choices allowed by the published group.",
"example": 0
},
"required": {
"type": "boolean",
"description": "Whether the guest must satisfy this published selection group.",
"example": true
},
"choices": {
"maxItems": 100,
"description": "Published catalog choices; empty for a modifier-group stage.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuSelectionChoiceDto"
},
"example": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
]
},
"modifierGroup": {
"nullable": true,
"description": "Published modifier group for a modifier stage; null for catalog choices.",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Published modifier group snapshot UUID.",
"example": "ec6e241e-1951-41c2-8739-0bd8d04ca0a6"
},
"groupId": {
"type": "string",
"format": "uuid",
"description": "Stable modifier group UUID.",
"example": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb"
},
"name": {
"type": "string",
"description": "Published guest-facing modifier group name.",
"example": "Example name"
},
"isRequired": {
"type": "boolean",
"description": "Whether the effective published assignment requires a selection.",
"example": true
},
"maxSelections": {
"type": "integer",
"minimum": 0,
"description": "Maximum number of options accepted by the effective published assignment.",
"example": 0
},
"options": {
"maxItems": 20000,
"description": "Currently available published options in their configured order.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuModifierOptionDto"
},
"example": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
},
"required": [
"id",
"groupId",
"name",
"isRequired",
"maxSelections",
"options"
],
"example": {
"id": "ec6e241e-1951-41c2-8739-0bd8d04ca0a6",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
}
},
"description": "Typed guest selection group shared by components, guided stages, courses, bundles and catering packages.",
"required": [
"id",
"name",
"sourceType",
"mode",
"minSelections",
"maxSelections",
"required",
"choices",
"modifierGroup"
],
"example": {
"id": "example-id",
"name": "Example name",
"sourceType": "CATALOG_ITEMS",
"mode": "FIXED_CONTENTS",
"minSelections": 0,
"maxSelections": 0,
"required": true,
"choices": [
{
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifierGroup": null
}
}PublicMenuSelectionChoiceDto
Published component or package choice with guest-facing configuration and selling upcharge.
idRequiredStable choice identifier accepted for its published selection group.
stringFull definition
{ "type": "string", "description": "Stable choice identifier accepted for its published selection group.", "example": "example-id" }menuItemIdRequiredStable published component menu item UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Stable published component menu item UUID.", "example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd" }nameRequiredPublished choice label or the component public name.
stringFull definition
{ "type": "string", "description": "Published choice label or the component public name.", "example": "Example name" }quantityRequiredPublished component quantity represented in the existing menu quantity wire format.
numberFull definition
{ "type": "number", "minimum": 0.001, "maximum": 999999999.999, "description": "Published component quantity represented in the existing menu quantity wire format.", "example": 1 }upchargeRequiredPublished selling upcharge for selecting this component in the parent menu currency.
numberFull definition
{ "type": "number", "minimum": 0, "maximum": 9999999999.99, "description": "Published selling upcharge for selecting this component in the parent menu currency.", "example": 0 }isDefaultRequiredWhether this choice is selected by default.
booleanFull definition
{ "type": "boolean", "description": "Whether this choice is selected by default.", "example": true }isIncludedRequiredWhether this component is part of the published included contents.
booleanFull definition
{ "type": "boolean", "description": "Whether this component is part of the published included contents.", "example": true }variantsRequiredPublished sellable versions accepted for this component choice.
arrayFull definition
{ "maxItems": 5000, "description": "Published sellable versions accepted for this component choice.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuVariantDto" }, "example": [ { "id": "28f3e585-3f5c-438c-8645-68ea6c44e293", "menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11", "name": "Example name", "price": 0, "allergenCodes": [ "GLUTEN" ], "isAlcoholic": true, "modifiers": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ], "availability": { "available": true, "reason": "AVAILABLE" } } ] }modifiersRequiredPublished modifiers accepted for this component choice.
arrayFull definition
{ "maxItems": 10000, "description": "Published modifiers accepted for this component choice.", "type": "array", "items": { "$ref": "#/components/schemas/PublicMenuModifierGroupDto" }, "example": [ { "id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d", "groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb", "name": "Example name", "isRequired": true, "maxSelections": 0, "options": [ { "id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126", "modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b", "name": "Example name", "priceDelta": 0, "isDefault": true, "allergenCodes": [ "GLUTEN" ] } ] } ] }availabilityRequiredCurrent public availability of this component choice.
allOfFull definition
{ "description": "Current public availability of this component choice.", "allOf": [ { "$ref": "#/components/schemas/PublicMenuAvailabilityDto" } ], "example": { "available": true, "reason": "AVAILABLE" } }
Full definition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Stable choice identifier accepted for its published selection group.",
"example": "example-id"
},
"menuItemId": {
"type": "string",
"format": "uuid",
"description": "Stable published component menu item UUID.",
"example": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd"
},
"name": {
"type": "string",
"description": "Published choice label or the component public name.",
"example": "Example name"
},
"quantity": {
"type": "number",
"minimum": 0.001,
"maximum": 999999999.999,
"description": "Published component quantity represented in the existing menu quantity wire format.",
"example": 1
},
"upcharge": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"description": "Published selling upcharge for selecting this component in the parent menu currency.",
"example": 0
},
"isDefault": {
"type": "boolean",
"description": "Whether this choice is selected by default.",
"example": true
},
"isIncluded": {
"type": "boolean",
"description": "Whether this component is part of the published included contents.",
"example": true
},
"variants": {
"maxItems": 5000,
"description": "Published sellable versions accepted for this component choice.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuVariantDto"
},
"example": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
]
},
"modifiers": {
"maxItems": 10000,
"description": "Published modifiers accepted for this component choice.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicMenuModifierGroupDto"
},
"example": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
]
},
"availability": {
"description": "Current public availability of this component choice.",
"allOf": [
{
"$ref": "#/components/schemas/PublicMenuAvailabilityDto"
}
],
"example": {
"available": true,
"reason": "AVAILABLE"
}
}
},
"description": "Published component or package choice with guest-facing configuration and selling upcharge.",
"required": [
"id",
"menuItemId",
"name",
"quantity",
"upcharge",
"isDefault",
"isIncluded",
"variants",
"modifiers",
"availability"
],
"example": {
"id": "example-id",
"menuItemId": "16ee6f36-c0cb-4311-85e8-2d2b3edea0fd",
"name": "Example name",
"quantity": 1,
"upcharge": 0,
"isDefault": true,
"isIncluded": true,
"variants": [
{
"id": "28f3e585-3f5c-438c-8645-68ea6c44e293",
"menuVariantId": "94389946-e5d8-4fba-8358-e3a9c8a04b11",
"name": "Example name",
"price": 0,
"allergenCodes": [
"GLUTEN"
],
"isAlcoholic": true,
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
],
"modifiers": [
{
"id": "b7c8dac2-5dc8-457c-8ccd-cdd7bb09d27d",
"groupId": "a457fc4d-a0cd-4f90-8fb1-e0db1f8a6beb",
"name": "Example name",
"isRequired": true,
"maxSelections": 0,
"options": [
{
"id": "cfd7f5ea-ada3-4506-8d5e-d10a89a0b126",
"modifierOptionId": "2375c3d7-0141-4f9a-896c-d07acfb6af1b",
"name": "Example name",
"priceDelta": 0,
"isDefault": true,
"allergenCodes": [
"GLUTEN"
]
}
]
}
],
"availability": {
"available": true,
"reason": "AVAILABLE"
}
}
}PublicMenuCourseDto
Guest-visible course label and sequence without staff release or kitchen scheduling policy.
groupIdRequiredPublished selection group belonging to this course.
stringFull definition
{ "type": "string", "description": "Published selection group belonging to this course.", "example": "example" }nameRequiredGuest-visible course name.
stringFull definition
{ "type": "string", "description": "Guest-visible course name.", "example": "Example name" }sequenceRequiredPublished service sequence used to order the guest course choices.
integerFull definition
{ "type": "integer", "description": "Published service sequence used to order the guest course choices.", "example": 0 }
Full definition
{
"type": "object",
"properties": {
"groupId": {
"type": "string",
"description": "Published selection group belonging to this course.",
"example": "example"
},
"name": {
"type": "string",
"description": "Guest-visible course name.",
"example": "Example name"
},
"sequence": {
"type": "integer",
"description": "Published service sequence used to order the guest course choices.",
"example": 0
}
},
"description": "Guest-visible course label and sequence without staff release or kitchen scheduling policy.",
"required": [
"groupId",
"name",
"sequence"
],
"example": {
"groupId": "example",
"name": "Example name",
"sequence": 0
}
}TranslatedErrorDto
Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.
statusCodeRequiredHTTP status code repeated from the response.
integerFull definition
{ "type": "integer", "description": "HTTP status code repeated from the response.", "example": 400 }errorRequiredTranslation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.
stringFull definition
{ "type": "string", "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.", "example": "errors.request.invalid" }codeRequiredStable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.
stringFull definition
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions." }messageRequiredTranslation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application." }translationKeyRequiredCanonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }validationErrorsOptionalField validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.
arrayFull definition
{ "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsOptionalOptional domain-specific blocker or validation details
oneOfFull definition
{ "description": "Optional domain-specific blocker or validation details", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Full definition
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP status code repeated from the response.",
"example": 400
},
"error": {
"type": "string",
"description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Optional domain-specific blocker or validation details",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.
fieldRequiredPublic field path. Nested properties and array indices are separated by dots.
stringFull definition
{ "type": "string", "example": "email", "description": "Public field path. Nested properties and array indices are separated by dots." }translationKeyRequiredTranslation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog." }codeRequiredStable validator identifier for this field failure. Custom validators may define additional identifiers.
stringFull definition
{ "type": "string", "example": "isEmail", "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers." }messageRequiredTranslation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }
Full definition
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Public field path. Nested properties and array indices are separated by dots."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.
Full definition
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
"example": "example"
}