{ "openapi": "3.1.0", "xId": [ "reitit.openapi/default" ], "info": { "title": "SoundHound Restaurants API", "description": "OpenAPI v3 Specifications", "version": "0.1" }, "paths": { "/v0/concepts/{concept-id}/locations": { "get": { "parameters": [ { "in": "path", "name": "concept-id", "required": true, "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conceptId": { "type": "integer", "minimum": 0 }, "locations": { "description": "List of locations associated with the specified concept", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of location", "type": "integer", "minimum": 0 }, "label": { "description": "Name of location", "type": "string", "minLength": 1 }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false }, "rating": { "description": "Location rating", "type": "number" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "conceptId", "locations" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "conceptId": { "type": "integer", "minimum": 0 }, "locations": { "description": "List of locations associated with the specified concept", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of location", "type": "integer", "minimum": 0 }, "label": { "description": "Name of location", "type": "string", "minLength": 1 }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false }, "rating": { "description": "Location rating", "type": "number" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "conceptId", "locations" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "conceptId": { "type": "integer", "minimum": 0 }, "locations": { "description": "List of locations associated with the specified concept", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of location", "type": "integer", "minimum": 0 }, "label": { "description": "Name of location", "type": "string", "minLength": 1 }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false }, "rating": { "description": "Location rating", "type": "number" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "conceptId", "locations" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "conceptId": { "type": "integer", "minimum": 0 }, "locations": { "description": "List of locations associated with the specified concept", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of location", "type": "integer", "minimum": 0 }, "label": { "description": "Name of location", "type": "string", "minLength": 1 }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false }, "rating": { "description": "Location rating", "type": "number" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "conceptId", "locations" ], "additionalProperties": false } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } } } } }, "tags": [ "Concepts" ], "summary": "Fetch locations associated with specified `concept-id`" } }, "/v0/locations/{location-id}/menu/selections/availability": { "get": { "parameters": [ { "in": "path", "name": "location-id", "required": true, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "version", "required": false, "schema": { "type": "string" }, "description": "Replay the snapshot as of this version instead of the current record: the one stored at exactly this version, or -- when none was -- the most recent one stored before it. The value is the `version` of an earlier response (equivalently its `ETag`, unquoted), or any timestamp to ask for whatever was current then. The response's `version` / `ETag` identify the snapshot actually served, which may predate the one requested." } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "locationId": { "description": "ID of the target location", "type": "integer", "minimum": 0 }, "disabledSelections": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "disabledBy": { "description": "tool, service or event that disabled this selection", "type": "string" }, "reason": { "description": "reason why it's disabled", "type": "string" } }, "required": [ "selectionId", "disabledBy" ], "additionalProperties": false } }, "selectionSchedules": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "schedule": { "type": "array", "items": { "type": "object", "properties": { "availableFrom": { "description": "when this selection starts availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "availableTo": { "description": "when this selection ends availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "availableFrom", "availableTo" ], "additionalProperties": false } } }, "required": [ "selectionId", "schedule" ], "additionalProperties": false } } }, "required": [ "locationId", "disabledSelections", "selectionSchedules" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "locationId": { "description": "ID of the target location", "type": "integer", "minimum": 0 }, "disabledSelections": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "disabledBy": { "description": "tool, service or event that disabled this selection", "type": "string" }, "reason": { "description": "reason why it's disabled", "type": "string" } }, "required": [ "selectionId", "disabledBy" ], "additionalProperties": false } }, "selectionSchedules": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "schedule": { "type": "array", "items": { "type": "object", "properties": { "availableFrom": { "description": "when this selection starts availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "availableTo": { "description": "when this selection ends availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "availableFrom", "availableTo" ], "additionalProperties": false } } }, "required": [ "selectionId", "schedule" ], "additionalProperties": false } } }, "required": [ "locationId", "disabledSelections", "selectionSchedules" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "locationId": { "description": "ID of the target location", "type": "integer", "minimum": 0 }, "disabledSelections": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "disabledBy": { "description": "tool, service or event that disabled this selection", "type": "string" }, "reason": { "description": "reason why it's disabled", "type": "string" } }, "required": [ "selectionId", "disabledBy" ], "additionalProperties": false } }, "selectionSchedules": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "schedule": { "type": "array", "items": { "type": "object", "properties": { "availableFrom": { "description": "when this selection starts availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "availableTo": { "description": "when this selection ends availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "availableFrom", "availableTo" ], "additionalProperties": false } } }, "required": [ "selectionId", "schedule" ], "additionalProperties": false } } }, "required": [ "locationId", "disabledSelections", "selectionSchedules" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "locationId": { "description": "ID of the target location", "type": "integer", "minimum": 0 }, "disabledSelections": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "disabledBy": { "description": "tool, service or event that disabled this selection", "type": "string" }, "reason": { "description": "reason why it's disabled", "type": "string" } }, "required": [ "selectionId", "disabledBy" ], "additionalProperties": false } }, "selectionSchedules": { "type": "array", "items": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "schedule": { "type": "array", "items": { "type": "object", "properties": { "availableFrom": { "description": "when this selection starts availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "availableTo": { "description": "when this selection ends availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "availableFrom", "availableTo" ], "additionalProperties": false } } }, "required": [ "selectionId", "schedule" ], "additionalProperties": false } } }, "required": [ "locationId", "disabledSelections", "selectionSchedules" ], "additionalProperties": false } } }, "headers": { "ETag": { "description": "Strong validator for this representation: the response's `version`, quoted. Send it back in `If-None-Match` to be answered `304` while it is still current.", "schema": { "type": "string" } }, "Last-Modified": { "description": "The same version as an HTTP-date. Send it back in `If-Modified-Since` for the same effect as `If-None-Match`, which takes precedence when both are sent.", "schema": { "type": "string" } }, "X-Snapshot": { "description": "Which path served the response: `HIT` (replayed from the snapshot store), `MISS` (generated, then stored), `FRESH` (always-regenerated endpoint) or `NOT-MODIFIED`. INFORMATIONAL ONLY, do not build against it.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } } } }, "304": { "description": "Not Modified: the `If-None-Match` / `If-Modified-Since` sent with the request matches the current version, so the client's copy is still good. No body.", "headers": { "ETag": { "description": "Strong validator for this representation: the response's `version`, quoted. Send it back in `If-None-Match` to be answered `304` while it is still current.", "schema": { "type": "string" } }, "Last-Modified": { "description": "The same version as an HTTP-date. Send it back in `If-Modified-Since` for the same effect as `If-None-Match`, which takes precedence when both are sent.", "schema": { "type": "string" } }, "X-Snapshot": { "description": "Which path served the response: `HIT` (replayed from the snapshot store), `MISS` (generated, then stored), `FRESH` (always-regenerated endpoint) or `NOT-MODIFIED`. INFORMATIONAL ONLY, do not build against it.", "schema": { "type": "string" } } } }, "404": { "description": "The requested resource -- or, on a `?version=` request, any snapshot taken at or before that version -- could not be found. The body's `type` says which." } }, "tags": [ "Locations" ], "summary": "86ing and menu schedule data for specified location", "description": "Snapshotted: the response body carries a `version` -- the timestamp of the most recent change\nto the data behind it -- and every distinct version is archived, so an earlier one can be\nfetched again.\n\n* `?version=` replays the snapshot as of that version -- the one stored at exactly that version, else the most recent one stored before it -- or `404`s with `type: snapshot/not-found` when nothing that old was stored. The served snapshot's own version is what the body's `version` and the `ETag` report.\n* `ETag` and `Last-Modified` both derive from that version; sending either back in `If-None-Match` / `If-Modified-Since` is answered `304 Not Modified` with no body." } }, "/v0/concepts/{concept-id}/menu/selections": { "get": { "parameters": [ { "in": "path", "name": "concept-id", "required": true, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "version", "required": false, "schema": { "type": "string" }, "description": "Replay the snapshot as of this version instead of the current record: the one stored at exactly this version, or -- when none was -- the most recent one stored before it. The value is the `version` of an earlier response (equivalently its `ETag`, unquoted), or any timestamp to ask for whatever was current then. The response's `version` / `ETag` identify the snapshot actually served, which may predate the one requested." } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "conceptId": { "description": "unique id of specified concept", "type": "integer", "minimum": 0 }, "categories": { "description": "List of categories owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `category`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of the `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "string" } ] }, "synonyms": { "description": "Synonyms of this `category`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of the `category`", "type": "string" }, "id": { "description": "Unique ID for a `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "parentId": { "description": "ID of parent `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "displayName": { "description": "Display name of the `category`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "parentId", "description" ], "additionalProperties": false } }, "elements": { "description": "List of elements owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `element`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of this `element`", "type": "string", "minLength": 1 }, "synonyms": { "description": "Synonyms of this `element`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of this `element`", "type": "string" }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `selection-group`", "type": "integer", "minimum": 0 }, "id": { "description": "The `id` of the `element`", "type": "integer", "minimum": 0 }, "displayName": { "description": "Display name of this `element`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] }, "partitions": { "description": "How many partitions this element can support. 1 means no partitions", "type": "integer", "minimum": 1 }, "price": { "description": "Price of `element`", "anyOf": [ { "type": "string", "enum": [ "not-available" ] }, { "type": "integer", "minimum": 0 } ] }, "upgradeElementIds": { "description": "The array of `element-ids` this element can be upgraded to", "type": "array", "items": { "type": "integer", "minimum": 0 } } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "categoryId", "price", "description", "partitions", "upgradeElementIds" ], "additionalProperties": false } }, "selections": { "description": "List of selection-based products for specified concept", "type": "array", "items": { "type": "object", "properties": { "mutualExclusions": { "description": "Also known as `anti-elements`, cannot be selected at the same time as the elements listed", "type": "array", "items": { "type": "integer", "minimum": 1 } }, "defaultQuantity": { "description": "Default quantity of this `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "defaultMode": { "description": "Default behaviour of this `selection`", "type": "string", "enum": [ "never", "on-request", "always" ] }, "categoryId": { "description": "The `category-id` that this `selection` belongs to", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "id": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 0 }, "elementId": { "description": "The `element-id` of this `selection`", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "groups": { "description": "The `groups` of this selection. Used for menu fetching.", "type": "array", "items": { "type": "object", "properties": { "mutedSelections": { "description": "Selections in this group that shouldn't be spoken out", "type": "array", "items": { "type": "integer" } }, "maxSelections": { "description": "The maximum amount of `selections` to fulfill this `selection-group`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "muted": { "description": "When true, don't verbalize this group", "type": "boolean" }, "promptOverride": { "description": "Response text when generating a prompt for this group", "type": "string" }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/ramsay.http.router.routes.v3.concepts.selections.schema.selection" } }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "helpPrompt": { "description": "TODO", "type": "string" }, "partitionable": { "description": "Whether this group can be split across partitions", "type": "boolean" }, "readbackOrder": { "description": "Order in which to list out the selections", "type": "array", "items": { "type": "integer" } }, "maxQuantity": { "description": "Maximum quantity a user must set on a single child `selection`", "type": "integer", "minimum": 1 }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `group`", "type": "integer", "minimum": 0 }, "readbackQuantity": { "description": "How many selections to readback when talking about this group", "type": "integer", "minimum": 0 }, "upsell": { "description": "When true upsell this group", "type": "boolean" }, "priority": { "description": "Represents the priority of this item against it's immediate peers", "type": "integer", "minimum": 0 }, "id": { "description": "ID of this `selection` `group` from menu.element_selection_groups_v2", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "minSelections": { "description": "The minimum amount of `selections` to fulfill this `selection-group`", "type": "integer", "minimum": 0 }, "minQuantity": { "description": "Minimum quantity a user must set on a single child `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] } }, "required": [ "id", "productOwnerId", "ownerId", "categoryId", "minSelections", "maxSelections", "minQuantity", "maxQuantity", "partitionable", "priority", "helpPrompt", "upsell", "muted", "mutedSelections", "readbackOrder", "readbackQuantity", "promptOverride" ], "additionalProperties": false } } }, "required": [ "id", "productOwnerId", "ownerId", "elementId", "categoryId", "mutualExclusions" ], "additionalProperties": false } } }, "required": [ "version", "conceptId", "categories", "elements", "selections" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "version": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "conceptId": { "description": "unique id of specified concept", "type": "integer", "minimum": 0 }, "categories": { "description": "List of categories owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `category`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of the `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "string" } ] }, "synonyms": { "description": "Synonyms of this `category`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of the `category`", "type": "string" }, "id": { "description": "Unique ID for a `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "parentId": { "description": "ID of parent `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "displayName": { "description": "Display name of the `category`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "parentId", "description" ], "additionalProperties": false } }, "elements": { "description": "List of elements owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `element`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of this `element`", "type": "string", "minLength": 1 }, "synonyms": { "description": "Synonyms of this `element`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of this `element`", "type": "string" }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `selection-group`", "type": "integer", "minimum": 0 }, "id": { "description": "The `id` of the `element`", "type": "integer", "minimum": 0 }, "displayName": { "description": "Display name of this `element`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] }, "partitions": { "description": "How many partitions this element can support. 1 means no partitions", "type": "integer", "minimum": 1 }, "price": { "description": "Price of `element`", "anyOf": [ { "type": "string", "enum": [ "not-available" ] }, { "type": "integer", "minimum": 0 } ] }, "upgradeElementIds": { "description": "The array of `element-ids` this element can be upgraded to", "type": "array", "items": { "type": "integer", "minimum": 0 } } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "categoryId", "price", "description", "partitions", "upgradeElementIds" ], "additionalProperties": false } }, "selections": { "description": "List of selection-based products for specified concept", "type": "array", "items": { "type": "object", "properties": { "mutualExclusions": { "description": "Also known as `anti-elements`, cannot be selected at the same time as the elements listed", "type": "array", "items": { "type": "integer", "minimum": 1 } }, "defaultQuantity": { "description": "Default quantity of this `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "defaultMode": { "description": "Default behaviour of this `selection`", "type": "string", "enum": [ "never", "on-request", "always" ] }, "categoryId": { "description": "The `category-id` that this `selection` belongs to", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "id": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 0 }, "elementId": { "description": "The `element-id` of this `selection`", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "groups": { "description": "The `groups` of this selection. Used for menu fetching.", "type": "array", "items": { "type": "object", "properties": { "mutedSelections": { "description": "Selections in this group that shouldn't be spoken out", "type": "array", "items": { "type": "integer" } }, "maxSelections": { "description": "The maximum amount of `selections` to fulfill this `selection-group`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "muted": { "description": "When true, don't verbalize this group", "type": "boolean" }, "promptOverride": { "description": "Response text when generating a prompt for this group", "type": "string" }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/ramsay.http.router.routes.v3.concepts.selections.schema.selection" } }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "helpPrompt": { "description": "TODO", "type": "string" }, "partitionable": { "description": "Whether this group can be split across partitions", "type": "boolean" }, "readbackOrder": { "description": "Order in which to list out the selections", "type": "array", "items": { "type": "integer" } }, "maxQuantity": { "description": "Maximum quantity a user must set on a single child `selection`", "type": "integer", "minimum": 1 }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `group`", "type": "integer", "minimum": 0 }, "readbackQuantity": { "description": "How many selections to readback when talking about this group", "type": "integer", "minimum": 0 }, "upsell": { "description": "When true upsell this group", "type": "boolean" }, "priority": { "description": "Represents the priority of this item against it's immediate peers", "type": "integer", "minimum": 0 }, "id": { "description": "ID of this `selection` `group` from menu.element_selection_groups_v2", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "minSelections": { "description": "The minimum amount of `selections` to fulfill this `selection-group`", "type": "integer", "minimum": 0 }, "minQuantity": { "description": "Minimum quantity a user must set on a single child `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] } }, "required": [ "id", "productOwnerId", "ownerId", "categoryId", "minSelections", "maxSelections", "minQuantity", "maxQuantity", "partitionable", "priority", "helpPrompt", "upsell", "muted", "mutedSelections", "readbackOrder", "readbackQuantity", "promptOverride" ], "additionalProperties": false } } }, "required": [ "id", "productOwnerId", "ownerId", "elementId", "categoryId", "mutualExclusions" ], "additionalProperties": false } } }, "required": [ "version", "conceptId", "categories", "elements", "selections" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "version": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "conceptId": { "description": "unique id of specified concept", "type": "integer", "minimum": 0 }, "categories": { "description": "List of categories owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `category`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of the `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "string" } ] }, "synonyms": { "description": "Synonyms of this `category`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of the `category`", "type": "string" }, "id": { "description": "Unique ID for a `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "parentId": { "description": "ID of parent `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "displayName": { "description": "Display name of the `category`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "parentId", "description" ], "additionalProperties": false } }, "elements": { "description": "List of elements owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `element`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of this `element`", "type": "string", "minLength": 1 }, "synonyms": { "description": "Synonyms of this `element`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of this `element`", "type": "string" }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `selection-group`", "type": "integer", "minimum": 0 }, "id": { "description": "The `id` of the `element`", "type": "integer", "minimum": 0 }, "displayName": { "description": "Display name of this `element`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] }, "partitions": { "description": "How many partitions this element can support. 1 means no partitions", "type": "integer", "minimum": 1 }, "price": { "description": "Price of `element`", "anyOf": [ { "type": "string", "enum": [ "not-available" ] }, { "type": "integer", "minimum": 0 } ] }, "upgradeElementIds": { "description": "The array of `element-ids` this element can be upgraded to", "type": "array", "items": { "type": "integer", "minimum": 0 } } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "categoryId", "price", "description", "partitions", "upgradeElementIds" ], "additionalProperties": false } }, "selections": { "description": "List of selection-based products for specified concept", "type": "array", "items": { "type": "object", "properties": { "mutualExclusions": { "description": "Also known as `anti-elements`, cannot be selected at the same time as the elements listed", "type": "array", "items": { "type": "integer", "minimum": 1 } }, "defaultQuantity": { "description": "Default quantity of this `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "defaultMode": { "description": "Default behaviour of this `selection`", "type": "string", "enum": [ "never", "on-request", "always" ] }, "categoryId": { "description": "The `category-id` that this `selection` belongs to", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "id": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 0 }, "elementId": { "description": "The `element-id` of this `selection`", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "groups": { "description": "The `groups` of this selection. Used for menu fetching.", "type": "array", "items": { "type": "object", "properties": { "mutedSelections": { "description": "Selections in this group that shouldn't be spoken out", "type": "array", "items": { "type": "integer" } }, "maxSelections": { "description": "The maximum amount of `selections` to fulfill this `selection-group`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "muted": { "description": "When true, don't verbalize this group", "type": "boolean" }, "promptOverride": { "description": "Response text when generating a prompt for this group", "type": "string" }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/ramsay.http.router.routes.v3.concepts.selections.schema.selection" } }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "helpPrompt": { "description": "TODO", "type": "string" }, "partitionable": { "description": "Whether this group can be split across partitions", "type": "boolean" }, "readbackOrder": { "description": "Order in which to list out the selections", "type": "array", "items": { "type": "integer" } }, "maxQuantity": { "description": "Maximum quantity a user must set on a single child `selection`", "type": "integer", "minimum": 1 }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `group`", "type": "integer", "minimum": 0 }, "readbackQuantity": { "description": "How many selections to readback when talking about this group", "type": "integer", "minimum": 0 }, "upsell": { "description": "When true upsell this group", "type": "boolean" }, "priority": { "description": "Represents the priority of this item against it's immediate peers", "type": "integer", "minimum": 0 }, "id": { "description": "ID of this `selection` `group` from menu.element_selection_groups_v2", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "minSelections": { "description": "The minimum amount of `selections` to fulfill this `selection-group`", "type": "integer", "minimum": 0 }, "minQuantity": { "description": "Minimum quantity a user must set on a single child `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] } }, "required": [ "id", "productOwnerId", "ownerId", "categoryId", "minSelections", "maxSelections", "minQuantity", "maxQuantity", "partitionable", "priority", "helpPrompt", "upsell", "muted", "mutedSelections", "readbackOrder", "readbackQuantity", "promptOverride" ], "additionalProperties": false } } }, "required": [ "id", "productOwnerId", "ownerId", "elementId", "categoryId", "mutualExclusions" ], "additionalProperties": false } } }, "required": [ "version", "conceptId", "categories", "elements", "selections" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "version": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "conceptId": { "description": "unique id of specified concept", "type": "integer", "minimum": 0 }, "categories": { "description": "List of categories owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `category`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of the `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "string" } ] }, "synonyms": { "description": "Synonyms of this `category`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of the `category`", "type": "string" }, "id": { "description": "Unique ID for a `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "parentId": { "description": "ID of parent `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "displayName": { "description": "Display name of the `category`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "parentId", "description" ], "additionalProperties": false } }, "elements": { "description": "List of elements owned by specified concept", "type": "array", "items": { "type": "object", "properties": { "description": { "description": "Description of the `element`", "type": "string" }, "proseHint": { "description": "TODO", "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } }, "additionalProperties": false }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "lookupName": { "description": "Lookup name of this `element`", "type": "string", "minLength": 1 }, "synonyms": { "description": "Synonyms of this `element`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of this `element`", "type": "string" }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `selection-group`", "type": "integer", "minimum": 0 }, "id": { "description": "The `id` of the `element`", "type": "integer", "minimum": 0 }, "displayName": { "description": "Display name of this `element`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] }, "partitions": { "description": "How many partitions this element can support. 1 means no partitions", "type": "integer", "minimum": 1 }, "price": { "description": "Price of `element`", "anyOf": [ { "type": "string", "enum": [ "not-available" ] }, { "type": "integer", "minimum": 0 } ] }, "upgradeElementIds": { "description": "The array of `element-ids` this element can be upgraded to", "type": "array", "items": { "type": "integer", "minimum": 0 } } }, "required": [ "id", "elementType", "lookupName", "displayName", "displayPlural", "synonyms", "categoryId", "price", "description", "partitions", "upgradeElementIds" ], "additionalProperties": false } }, "selections": { "description": "List of selection-based products for specified concept", "type": "array", "items": { "type": "object", "properties": { "mutualExclusions": { "description": "Also known as `anti-elements`, cannot be selected at the same time as the elements listed", "type": "array", "items": { "type": "integer", "minimum": 1 } }, "defaultQuantity": { "description": "Default quantity of this `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "defaultMode": { "description": "Default behaviour of this `selection`", "type": "string", "enum": [ "never", "on-request", "always" ] }, "categoryId": { "description": "The `category-id` that this `selection` belongs to", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "id": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 0 }, "elementId": { "description": "The `element-id` of this `selection`", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "groups": { "description": "The `groups` of this selection. Used for menu fetching.", "type": "array", "items": { "type": "object", "properties": { "mutedSelections": { "description": "Selections in this group that shouldn't be spoken out", "type": "array", "items": { "type": "integer" } }, "maxSelections": { "description": "The maximum amount of `selections` to fulfill this `selection-group`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "muted": { "description": "When true, don't verbalize this group", "type": "boolean" }, "promptOverride": { "description": "Response text when generating a prompt for this group", "type": "string" }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/ramsay.http.router.routes.v3.concepts.selections.schema.selection" } }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "helpPrompt": { "description": "TODO", "type": "string" }, "partitionable": { "description": "Whether this group can be split across partitions", "type": "boolean" }, "readbackOrder": { "description": "Order in which to list out the selections", "type": "array", "items": { "type": "integer" } }, "maxQuantity": { "description": "Maximum quantity a user must set on a single child `selection`", "type": "integer", "minimum": 1 }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `group`", "type": "integer", "minimum": 0 }, "readbackQuantity": { "description": "How many selections to readback when talking about this group", "type": "integer", "minimum": 0 }, "upsell": { "description": "When true upsell this group", "type": "boolean" }, "priority": { "description": "Represents the priority of this item against it's immediate peers", "type": "integer", "minimum": 0 }, "id": { "description": "ID of this `selection` `group` from menu.element_selection_groups_v2", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "minSelections": { "description": "The minimum amount of `selections` to fulfill this `selection-group`", "type": "integer", "minimum": 0 }, "minQuantity": { "description": "Minimum quantity a user must set on a single child `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] } }, "required": [ "id", "productOwnerId", "ownerId", "categoryId", "minSelections", "maxSelections", "minQuantity", "maxQuantity", "partitionable", "priority", "helpPrompt", "upsell", "muted", "mutedSelections", "readbackOrder", "readbackQuantity", "promptOverride" ], "additionalProperties": false } } }, "required": [ "id", "productOwnerId", "ownerId", "elementId", "categoryId", "mutualExclusions" ], "additionalProperties": false } } }, "required": [ "version", "conceptId", "categories", "elements", "selections" ], "additionalProperties": false } } }, "headers": { "ETag": { "description": "Strong validator for this representation: the response's `version`, quoted. Send it back in `If-None-Match` to be answered `304` while it is still current.", "schema": { "type": "string" } }, "Last-Modified": { "description": "The same version as an HTTP-date. Send it back in `If-Modified-Since` for the same effect as `If-None-Match`, which takes precedence when both are sent.", "schema": { "type": "string" } }, "X-Snapshot": { "description": "Which path served the response: `HIT` (replayed from the snapshot store), `MISS` (generated, then stored), `FRESH` (always-regenerated endpoint) or `NOT-MODIFIED`. INFORMATIONAL ONLY, do not build against it.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } } } }, "304": { "description": "Not Modified: the `If-None-Match` / `If-Modified-Since` sent with the request matches the current version, so the client's copy is still good. No body.", "headers": { "ETag": { "description": "Strong validator for this representation: the response's `version`, quoted. Send it back in `If-None-Match` to be answered `304` while it is still current.", "schema": { "type": "string" } }, "Last-Modified": { "description": "The same version as an HTTP-date. Send it back in `If-Modified-Since` for the same effect as `If-None-Match`, which takes precedence when both are sent.", "schema": { "type": "string" } }, "X-Snapshot": { "description": "Which path served the response: `HIT` (replayed from the snapshot store), `MISS` (generated, then stored), `FRESH` (always-regenerated endpoint) or `NOT-MODIFIED`. INFORMATIONAL ONLY, do not build against it.", "schema": { "type": "string" } } } }, "404": { "description": "The requested resource -- or, on a `?version=` request, any snapshot taken at or before that version -- could not be found. The body's `type` says which." } }, "tags": [ "Concepts" ], "summary": "Fetch selections menu for specified `concept`", "description": "Snapshotted: the response body carries a `version` -- the timestamp of the most recent change\nto the data behind it -- and every distinct version is archived, so an earlier one can be\nfetched again.\n\n* `?version=` replays the snapshot as of that version -- the one stored at exactly that version, else the most recent one stored before it -- or `404`s with `type: snapshot/not-found` when nothing that old was stored. The served snapshot's own version is what the body's `version` and the `ETag` report.\n* `ETag` and `Last-Modified` both derive from that version; sending either back in `If-None-Match` / `If-Modified-Since` is answered `304 Not Modified` with no body." } }, "/v0/concepts": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "concepts": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "concepts" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "concepts": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "concepts" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "concepts": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "concepts" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "concepts": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } } }, "required": [ "concepts" ], "additionalProperties": false } } } } }, "tags": [ "Concepts" ], "summary": "Fetch list of all concepts" } }, "/v0/locations/{location-id}": { "get": { "parameters": [ { "in": "path", "name": "location-id", "required": true, "schema": { "type": "integer", "minimum": 0 } }, { "in": "query", "name": "version", "required": false, "schema": { "type": "string" }, "description": "Replay the snapshot as of this version instead of the current record: the one stored at exactly this version, or -- when none was -- the most recent one stored before it. The value is the `version` of an earlier response (equivalently its `ETag`, unquoted), or any timestamp to ask for whatever was current then. The response's `version` / `ETag` identify the snapshot actually served, which may predate the one requested." } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "location": { "type": "object", "properties": { "timezone": { "description": "Timezone of this location" }, "occasions": { "description": "List of `occasion`s part of this `location`", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of this `occasion`", "type": "integer", "minimum": 0 }, "occasion": { "description": "Enum of valid `occasion` types", "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] }, "payment": { "description": "Field denoting whether `payment` is required or optional", "type": "string", "enum": [ "required", "optional", "prohibited" ] }, "available": { "description": "`true` if the `occasion` is available for ordering", "type": "boolean" }, "valid": { "description": "`true` if the `occasion` is valid and supported by the POS", "type": "boolean" }, "schedule": { "description": "The opening and closing times for this `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } } }, "required": [ "id", "occasion", "payment", "available", "valid", "schedule" ], "additionalProperties": false } }, "telephone": { "description": "Phone number of this `location`" }, "name": { "description": "Name of this `location`", "type": "string" }, "stateCode": { "description": "US state of this `location` in 2 letter code form", "type": "string", "maxLength": 3 }, "city": { "description": "City this `location` is in", "type": "string" }, "businessHours": { "description": "The hours this `location` is open, independent of any `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } }, "tenders": { "description": "List of `tender`s part of this `location`", "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "cash" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "text-to-pay" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "prepaid" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "credit-card" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" }, "cardType": { "description": "The kind of credit card", "enum": [ "visa", "master-card", "american-express", "diners-club", "discover", "j-c-b", "jcb", "insta-payment", "maestro", "unionpay", "" ] } }, "required": [ "tender", "available", "cardType" ], "additionalProperties": false } ] } }, "countryCode": { "description": "Country this `location` is in via code", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "longitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "postalCode": { "description": "postal code of this `location`", "type": "string" }, "id": { "description": "ID of this `location`", "type": "integer", "minimum": 1 }, "streetAddress": { "description": "Street address of this `location`.", "type": "string" }, "latitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "available": { "description": "Whether this location is available", "type": "boolean" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "available", "name", "streetAddress", "city", "stateCode", "countryCode", "postalCode", "timezone", "telephone", "longitude", "latitude", "occasions", "tenders", "businessHours" ], "additionalProperties": false } }, "required": [ "location" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "location": { "type": "object", "properties": { "timezone": { "description": "Timezone of this location" }, "occasions": { "description": "List of `occasion`s part of this `location`", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of this `occasion`", "type": "integer", "minimum": 0 }, "occasion": { "description": "Enum of valid `occasion` types", "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] }, "payment": { "description": "Field denoting whether `payment` is required or optional", "type": "string", "enum": [ "required", "optional", "prohibited" ] }, "available": { "description": "`true` if the `occasion` is available for ordering", "type": "boolean" }, "valid": { "description": "`true` if the `occasion` is valid and supported by the POS", "type": "boolean" }, "schedule": { "description": "The opening and closing times for this `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } } }, "required": [ "id", "occasion", "payment", "available", "valid", "schedule" ], "additionalProperties": false } }, "telephone": { "description": "Phone number of this `location`" }, "name": { "description": "Name of this `location`", "type": "string" }, "stateCode": { "description": "US state of this `location` in 2 letter code form", "type": "string", "maxLength": 3 }, "city": { "description": "City this `location` is in", "type": "string" }, "businessHours": { "description": "The hours this `location` is open, independent of any `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } }, "tenders": { "description": "List of `tender`s part of this `location`", "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "cash" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "text-to-pay" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "prepaid" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "credit-card" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" }, "cardType": { "description": "The kind of credit card", "enum": [ "visa", "master-card", "american-express", "diners-club", "discover", "j-c-b", "jcb", "insta-payment", "maestro", "unionpay", "" ] } }, "required": [ "tender", "available", "cardType" ], "additionalProperties": false } ] } }, "countryCode": { "description": "Country this `location` is in via code", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "longitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "postalCode": { "description": "postal code of this `location`", "type": "string" }, "id": { "description": "ID of this `location`", "type": "integer", "minimum": 1 }, "streetAddress": { "description": "Street address of this `location`.", "type": "string" }, "latitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "available": { "description": "Whether this location is available", "type": "boolean" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "available", "name", "streetAddress", "city", "stateCode", "countryCode", "postalCode", "timezone", "telephone", "longitude", "latitude", "occasions", "tenders", "businessHours" ], "additionalProperties": false } }, "required": [ "location" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "location": { "type": "object", "properties": { "timezone": { "description": "Timezone of this location" }, "occasions": { "description": "List of `occasion`s part of this `location`", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of this `occasion`", "type": "integer", "minimum": 0 }, "occasion": { "description": "Enum of valid `occasion` types", "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] }, "payment": { "description": "Field denoting whether `payment` is required or optional", "type": "string", "enum": [ "required", "optional", "prohibited" ] }, "available": { "description": "`true` if the `occasion` is available for ordering", "type": "boolean" }, "valid": { "description": "`true` if the `occasion` is valid and supported by the POS", "type": "boolean" }, "schedule": { "description": "The opening and closing times for this `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } } }, "required": [ "id", "occasion", "payment", "available", "valid", "schedule" ], "additionalProperties": false } }, "telephone": { "description": "Phone number of this `location`" }, "name": { "description": "Name of this `location`", "type": "string" }, "stateCode": { "description": "US state of this `location` in 2 letter code form", "type": "string", "maxLength": 3 }, "city": { "description": "City this `location` is in", "type": "string" }, "businessHours": { "description": "The hours this `location` is open, independent of any `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } }, "tenders": { "description": "List of `tender`s part of this `location`", "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "cash" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "text-to-pay" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "prepaid" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "credit-card" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" }, "cardType": { "description": "The kind of credit card", "enum": [ "visa", "master-card", "american-express", "diners-club", "discover", "j-c-b", "jcb", "insta-payment", "maestro", "unionpay", "" ] } }, "required": [ "tender", "available", "cardType" ], "additionalProperties": false } ] } }, "countryCode": { "description": "Country this `location` is in via code", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "longitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "postalCode": { "description": "postal code of this `location`", "type": "string" }, "id": { "description": "ID of this `location`", "type": "integer", "minimum": 1 }, "streetAddress": { "description": "Street address of this `location`.", "type": "string" }, "latitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "available": { "description": "Whether this location is available", "type": "boolean" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "available", "name", "streetAddress", "city", "stateCode", "countryCode", "postalCode", "timezone", "telephone", "longitude", "latitude", "occasions", "tenders", "businessHours" ], "additionalProperties": false } }, "required": [ "location" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "location": { "type": "object", "properties": { "timezone": { "description": "Timezone of this location" }, "occasions": { "description": "List of `occasion`s part of this `location`", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of this `occasion`", "type": "integer", "minimum": 0 }, "occasion": { "description": "Enum of valid `occasion` types", "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] }, "payment": { "description": "Field denoting whether `payment` is required or optional", "type": "string", "enum": [ "required", "optional", "prohibited" ] }, "available": { "description": "`true` if the `occasion` is available for ordering", "type": "boolean" }, "valid": { "description": "`true` if the `occasion` is valid and supported by the POS", "type": "boolean" }, "schedule": { "description": "The opening and closing times for this `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } } }, "required": [ "id", "occasion", "payment", "available", "valid", "schedule" ], "additionalProperties": false } }, "telephone": { "description": "Phone number of this `location`" }, "name": { "description": "Name of this `location`", "type": "string" }, "stateCode": { "description": "US state of this `location` in 2 letter code form", "type": "string", "maxLength": 3 }, "city": { "description": "City this `location` is in", "type": "string" }, "businessHours": { "description": "The hours this `location` is open, independent of any `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the location's business hours", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ], "additionalProperties": false } }, "tenders": { "description": "List of `tender`s part of this `location`", "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "cash" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "text-to-pay" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "prepaid" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "tender", "available" ], "additionalProperties": false }, { "type": "object", "properties": { "tender": { "description": "type of `tender`", "type": "string", "enum": [ "credit-card" ] }, "available": { "description": "Whether the `tender` is available", "type": "boolean" }, "cardType": { "description": "The kind of credit card", "enum": [ "visa", "master-card", "american-express", "diners-club", "discover", "j-c-b", "jcb", "insta-payment", "maestro", "unionpay", "" ] } }, "required": [ "tender", "available", "cardType" ], "additionalProperties": false } ] } }, "countryCode": { "description": "Country this `location` is in via code", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "longitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "postalCode": { "description": "postal code of this `location`", "type": "string" }, "id": { "description": "ID of this `location`", "type": "integer", "minimum": 1 }, "streetAddress": { "description": "Street address of this `location`.", "type": "string" }, "latitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "available": { "description": "Whether this location is available", "type": "boolean" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "available", "name", "streetAddress", "city", "stateCode", "countryCode", "postalCode", "timezone", "telephone", "longitude", "latitude", "occasions", "tenders", "businessHours" ], "additionalProperties": false } }, "required": [ "location" ], "additionalProperties": false } } }, "headers": { "ETag": { "description": "Strong validator for this representation: the response's `version`, quoted. Send it back in `If-None-Match` to be answered `304` while it is still current.", "schema": { "type": "string" } }, "Last-Modified": { "description": "The same version as an HTTP-date. Send it back in `If-Modified-Since` for the same effect as `If-None-Match`, which takes precedence when both are sent.", "schema": { "type": "string" } }, "X-Snapshot": { "description": "Which path served the response: `HIT` (replayed from the snapshot store), `MISS` (generated, then stored), `FRESH` (always-regenerated endpoint) or `NOT-MODIFIED`. INFORMATIONAL ONLY, do not build against it.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } } }, "description": "The requested resource -- or, on a `?version=` request, any snapshot taken at or before that version -- could not be found. The body's `type` says which." }, "304": { "description": "Not Modified: the `If-None-Match` / `If-Modified-Since` sent with the request matches the current version, so the client's copy is still good. No body.", "headers": { "ETag": { "description": "Strong validator for this representation: the response's `version`, quoted. Send it back in `If-None-Match` to be answered `304` while it is still current.", "schema": { "type": "string" } }, "Last-Modified": { "description": "The same version as an HTTP-date. Send it back in `If-Modified-Since` for the same effect as `If-None-Match`, which takes precedence when both are sent.", "schema": { "type": "string" } }, "X-Snapshot": { "description": "Which path served the response: `HIT` (replayed from the snapshot store), `MISS` (generated, then stored), `FRESH` (always-regenerated endpoint) or `NOT-MODIFIED`. INFORMATIONAL ONLY, do not build against it.", "schema": { "type": "string" } } } } }, "tags": [ "Locations" ], "summary": "Fetch individual location", "description": "Snapshotted: the response body carries a `version` -- the timestamp of the most recent change\nto the data behind it -- and every distinct version is archived, so an earlier one can be\nfetched again.\n\n* `?version=` replays the snapshot as of that version -- the one stored at exactly that version, else the most recent one stored before it -- or `404`s with `type: snapshot/not-found` when nothing that old was stored. The served snapshot's own version is what the body's `version` and the `ETag` report.\n* `ETag` and `Last-Modified` both derive from that version; sending either back in `If-None-Match` / `If-Modified-Since` is answered `304 Not Modified` with no body." } }, "/v0/concepts/{concept-id}": { "get": { "parameters": [ { "in": "path", "name": "concept-id", "required": true, "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "concept": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "required": [ "concept" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "concept": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "required": [ "concept" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "concept": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "required": [ "concept" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "concept": { "type": "object", "properties": { "id": { "description": "Unique id of a concept", "type": "integer", "minimum": 0 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "id", "label" ], "additionalProperties": false } }, "required": [ "concept" ], "additionalProperties": false } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } } } } }, "tags": [ "Concepts" ], "summary": "Fetch individual concept" } }, "/v0/locations": { "get": { "parameters": [ { "in": "query", "name": "zipCode", "required": true, "schema": { "type": "string" }, "description": "5 digit USPS zip code" }, { "in": "query", "name": "radius", "required": false, "schema": { "default": 5, "type": "number", "minimum": 0.1, "maximum": 50 }, "description": "in miles" }, { "in": "query", "name": "limitPerConcept", "required": false, "schema": { "default": 3, "type": "integer", "minimum": 1, "maximum": 5 }, "description": "number of locations to return per concept" }, { "in": "query", "name": "cuisines", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] }, { "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } } ] }, "description": "list of cuisines to search for" }, { "in": "query", "name": "occasions", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] }, { "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } } ] }, "description": "list of occasions to search for" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "zipCode": { "type": "string" }, "radius": { "type": "number" } }, "required": [ "zipCode", "radius" ], "additionalProperties": false }, "limitPerConcept": { "description": "Absent when no per-concept limit was applied (`publicConceptId` given)", "type": "integer" }, "limit": { "description": "Maximum number of locations returned, when a `limit` was given", "type": "integer" }, "filters": { "type": "object", "properties": { "cuisines": { "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "occasions": { "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } } }, "required": [ "cuisines", "occasions" ], "additionalProperties": false }, "totalLocations": { "type": "integer" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "concept": { "description": "The brand the location is part of.", "type": "object", "properties": { "name": { "description": "Display name of the concept.", "type": "string" }, "id": { "description": "Unique identifier for the concept.", "type": "string" }, "primaryColor": { "description": "Color for UI rendering.", "type": "string" }, "logoUrl": { "description": "URL to the concept logo image.", "type": "string" }, "cuisines": { "description": "Cuisines that the concept caters to.", "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "orderingUrl": { "description": "URL used for ordering / QR code generation.", "type": "string" } }, "required": [ "name", "id", "primaryColor", "logoUrl", "cuisines", "orderingUrl" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "address": { "title": "Delivery address validation schema", "type": "object", "properties": { "streetAddress1": { "type": "string" }, "streetAddress2": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "required": [ "streetAddress1", "city", "stateCode", "postalCode" ], "additionalProperties": false }, "phoneNumber": { "description": "E.164 formatted phone number", "anyOf": [ {}, { "type": "string" } ] }, "occasionsSupported": { "description": "Occasions supported by the location.", "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } }, "name": { "description": "Name of location", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "id": { "description": "Unique identifier for the location.", "type": "string" }, "posProvider": { "description": "POS provider for this location's concept", "type": "string", "minLength": 1 }, "distance": { "description": "Distance from the ZIP code origin, in miles.", "type": "number" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "name", "address", "phoneNumber", "distance", "occasionsSupported" ], "additionalProperties": false }, "featuredItems": { "description": "Featured items for the location.", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Display name of the item.", "type": "string" }, "price": { "description": "Item price (currency handling not specified; assumed USD unless otherwise defined).", "type": "integer" }, "imageUrl": { "description": "URL to the item image.", "type": "string" }, "description": { "description": "Short description of the item.", "type": "string" }, "displayOrder": { "description": "Display priority/order (lower appears first).", "type": "integer" } }, "required": [ "name", "price", "imageUrl", "description", "displayOrder" ], "additionalProperties": false } } }, "required": [ "concept", "location", "featuredItems" ], "additionalProperties": false } } }, "required": [ "origin", "filters", "totalLocations", "locations" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "zipCode": { "type": "string" }, "radius": { "type": "number" } }, "required": [ "zipCode", "radius" ], "additionalProperties": false }, "limitPerConcept": { "description": "Absent when no per-concept limit was applied (`publicConceptId` given)", "type": "integer" }, "limit": { "description": "Maximum number of locations returned, when a `limit` was given", "type": "integer" }, "filters": { "type": "object", "properties": { "cuisines": { "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "occasions": { "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } } }, "required": [ "cuisines", "occasions" ], "additionalProperties": false }, "totalLocations": { "type": "integer" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "concept": { "description": "The brand the location is part of.", "type": "object", "properties": { "name": { "description": "Display name of the concept.", "type": "string" }, "id": { "description": "Unique identifier for the concept.", "type": "string" }, "primaryColor": { "description": "Color for UI rendering.", "type": "string" }, "logoUrl": { "description": "URL to the concept logo image.", "type": "string" }, "cuisines": { "description": "Cuisines that the concept caters to.", "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "orderingUrl": { "description": "URL used for ordering / QR code generation.", "type": "string" } }, "required": [ "name", "id", "primaryColor", "logoUrl", "cuisines", "orderingUrl" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "address": { "title": "Delivery address validation schema", "type": "object", "properties": { "streetAddress1": { "type": "string" }, "streetAddress2": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "required": [ "streetAddress1", "city", "stateCode", "postalCode" ], "additionalProperties": false }, "phoneNumber": { "description": "E.164 formatted phone number", "anyOf": [ {}, { "type": "string" } ] }, "occasionsSupported": { "description": "Occasions supported by the location.", "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } }, "name": { "description": "Name of location", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "id": { "description": "Unique identifier for the location.", "type": "string" }, "posProvider": { "description": "POS provider for this location's concept", "type": "string", "minLength": 1 }, "distance": { "description": "Distance from the ZIP code origin, in miles.", "type": "number" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "name", "address", "phoneNumber", "distance", "occasionsSupported" ], "additionalProperties": false }, "featuredItems": { "description": "Featured items for the location.", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Display name of the item.", "type": "string" }, "price": { "description": "Item price (currency handling not specified; assumed USD unless otherwise defined).", "type": "integer" }, "imageUrl": { "description": "URL to the item image.", "type": "string" }, "description": { "description": "Short description of the item.", "type": "string" }, "displayOrder": { "description": "Display priority/order (lower appears first).", "type": "integer" } }, "required": [ "name", "price", "imageUrl", "description", "displayOrder" ], "additionalProperties": false } } }, "required": [ "concept", "location", "featuredItems" ], "additionalProperties": false } } }, "required": [ "origin", "filters", "totalLocations", "locations" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "zipCode": { "type": "string" }, "radius": { "type": "number" } }, "required": [ "zipCode", "radius" ], "additionalProperties": false }, "limitPerConcept": { "description": "Absent when no per-concept limit was applied (`publicConceptId` given)", "type": "integer" }, "limit": { "description": "Maximum number of locations returned, when a `limit` was given", "type": "integer" }, "filters": { "type": "object", "properties": { "cuisines": { "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "occasions": { "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } } }, "required": [ "cuisines", "occasions" ], "additionalProperties": false }, "totalLocations": { "type": "integer" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "concept": { "description": "The brand the location is part of.", "type": "object", "properties": { "name": { "description": "Display name of the concept.", "type": "string" }, "id": { "description": "Unique identifier for the concept.", "type": "string" }, "primaryColor": { "description": "Color for UI rendering.", "type": "string" }, "logoUrl": { "description": "URL to the concept logo image.", "type": "string" }, "cuisines": { "description": "Cuisines that the concept caters to.", "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "orderingUrl": { "description": "URL used for ordering / QR code generation.", "type": "string" } }, "required": [ "name", "id", "primaryColor", "logoUrl", "cuisines", "orderingUrl" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "address": { "title": "Delivery address validation schema", "type": "object", "properties": { "streetAddress1": { "type": "string" }, "streetAddress2": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "required": [ "streetAddress1", "city", "stateCode", "postalCode" ], "additionalProperties": false }, "phoneNumber": { "description": "E.164 formatted phone number", "anyOf": [ {}, { "type": "string" } ] }, "occasionsSupported": { "description": "Occasions supported by the location.", "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } }, "name": { "description": "Name of location", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "id": { "description": "Unique identifier for the location.", "type": "string" }, "posProvider": { "description": "POS provider for this location's concept", "type": "string", "minLength": 1 }, "distance": { "description": "Distance from the ZIP code origin, in miles.", "type": "number" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "name", "address", "phoneNumber", "distance", "occasionsSupported" ], "additionalProperties": false }, "featuredItems": { "description": "Featured items for the location.", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Display name of the item.", "type": "string" }, "price": { "description": "Item price (currency handling not specified; assumed USD unless otherwise defined).", "type": "integer" }, "imageUrl": { "description": "URL to the item image.", "type": "string" }, "description": { "description": "Short description of the item.", "type": "string" }, "displayOrder": { "description": "Display priority/order (lower appears first).", "type": "integer" } }, "required": [ "name", "price", "imageUrl", "description", "displayOrder" ], "additionalProperties": false } } }, "required": [ "concept", "location", "featuredItems" ], "additionalProperties": false } } }, "required": [ "origin", "filters", "totalLocations", "locations" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "origin": { "type": "object", "properties": { "zipCode": { "type": "string" }, "radius": { "type": "number" } }, "required": [ "zipCode", "radius" ], "additionalProperties": false }, "limitPerConcept": { "description": "Absent when no per-concept limit was applied (`publicConceptId` given)", "type": "integer" }, "limit": { "description": "Maximum number of locations returned, when a `limit` was given", "type": "integer" }, "filters": { "type": "object", "properties": { "cuisines": { "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "occasions": { "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } } }, "required": [ "cuisines", "occasions" ], "additionalProperties": false }, "totalLocations": { "type": "integer" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "concept": { "description": "The brand the location is part of.", "type": "object", "properties": { "name": { "description": "Display name of the concept.", "type": "string" }, "id": { "description": "Unique identifier for the concept.", "type": "string" }, "primaryColor": { "description": "Color for UI rendering.", "type": "string" }, "logoUrl": { "description": "URL to the concept logo image.", "type": "string" }, "cuisines": { "description": "Cuisines that the concept caters to.", "type": "array", "items": { "type": "string", "enum": [ "italian", "chinese", "mexican", "japanese", "indian", "mediterranean", "french", "thai", "american", "burgers", "pizza", "european", "brunch", "asian", "middle-eastern", "sushi", "seafood", "n/a" ] } }, "orderingUrl": { "description": "URL used for ordering / QR code generation.", "type": "string" } }, "required": [ "name", "id", "primaryColor", "logoUrl", "cuisines", "orderingUrl" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "address": { "title": "Delivery address validation schema", "type": "object", "properties": { "streetAddress1": { "type": "string" }, "streetAddress2": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "postalCode": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "required": [ "streetAddress1", "city", "stateCode", "postalCode" ], "additionalProperties": false }, "phoneNumber": { "description": "E.164 formatted phone number", "anyOf": [ {}, { "type": "string" } ] }, "occasionsSupported": { "description": "Occasions supported by the location.", "type": "array", "items": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] } }, "name": { "description": "Name of location", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } }, "additionalProperties": false }, "id": { "description": "Unique identifier for the location.", "type": "string" }, "posProvider": { "description": "POS provider for this location's concept", "type": "string", "minLength": 1 }, "distance": { "description": "Distance from the ZIP code origin, in miles.", "type": "number" }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "name", "address", "phoneNumber", "distance", "occasionsSupported" ], "additionalProperties": false }, "featuredItems": { "description": "Featured items for the location.", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Display name of the item.", "type": "string" }, "price": { "description": "Item price (currency handling not specified; assumed USD unless otherwise defined).", "type": "integer" }, "imageUrl": { "description": "URL to the item image.", "type": "string" }, "description": { "description": "Short description of the item.", "type": "string" }, "displayOrder": { "description": "Display priority/order (lower appears first).", "type": "integer" } }, "required": [ "name", "price", "imageUrl", "description", "displayOrder" ], "additionalProperties": false } } }, "required": [ "concept", "location", "featuredItems" ], "additionalProperties": false } } }, "required": [ "origin", "filters", "totalLocations", "locations" ], "additionalProperties": false } } } }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+msgpack": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/transit+json": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } }, "application/edn": { "schema": { "type": "object", "properties": { "type": { "description": "Type of `not-found` error", "type": "string", "enum": [ "concept/not-found", "cohort/not-found", "location/not-found", "zipcode/not-found", "system-configuration/not-found", "snapshot/not-found" ] }, "message": { "description": "Human readable text appropriate for display", "type": "string", "minLength": 1 }, "category": { "description": "Category of the error", "type": "string", "enum": [ "not-found" ] }, "id": { "description": "The user-supplied `id` of the resource that was not found", "type": "integer" }, "context": { "description": "Additional contextual data about the error; INFORMATIONAL ONLY, do not build against" } }, "required": [ "type", "message", "category", "id", "context" ], "additionalProperties": false } } } } }, "tags": [ "Locations" ], "summary": "return list of locations given filtering criteria" } } }, "components": { "schemas": { "group": { "type": "object", "properties": { "mutedSelections": { "description": "Selections in this group that shouldn't be spoken out", "type": "array", "items": { "type": "integer" } }, "promptUpToMax": { "description": "TODO", "type": "boolean" }, "maxSelections": { "description": "The maximum amount of `selections` to fulfill this `selection-group`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "muted": { "description": "When true, don't verbalize this group", "type": "boolean" }, "promptOverride": { "description": "Response text when generating a prompt for this group", "type": "string" }, "elementSelectionGroupCompositeId": { "description": "TODO", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/ramsay.http.router.routes.menu.selections.schema.selection-response" } }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "helpPrompt": { "description": "TODO", "type": "string" }, "partitionable": { "description": "Whether this group can be split across partitions", "type": "boolean" }, "ocbData": { "description": "Collection of OCB data for the group", "type": "object", "properties": { "ocbLabel": { "description": "Override label to use on the OCB for the group", "type": "string" }, "ocbPrompt": { "description": "Override prompt to use on the OCB for group", "type": "string" } } }, "readbackFinalOption": { "description": "TODO", "type": "string" }, "readOnProductOwner": { "description": "TODO", "type": "boolean" }, "readbackOrder": { "description": "Order in which to list out the selections", "type": "array", "items": { "type": "integer" } }, "maxQuantity": { "description": "Maximum quantity a user must set on a single child `selection`", "type": "integer", "minimum": 1 }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `group`", "type": "integer", "minimum": 0 }, "readbackQuantity": { "description": "How many selections to readback when talking about this group", "type": "integer", "minimum": 0 }, "upsell": { "description": "When true upsell this group", "type": "boolean" }, "priority": { "description": "Represents the priority of this item against it's immediate peers", "type": "integer", "minimum": 0 }, "id": { "description": "ID of this `selection` `group` from menu.element_selection_groups_v2", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "minSelections": { "description": "The minimum amount of `selections` to fulfill this `selection-group`", "type": "integer", "minimum": 0 }, "minQuantity": { "description": "Minimum quantity a user must set on a single child `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "upgradePrompt": { "description": "TODO", "type": "object", "properties": {} }, "categoryNonRestate": { "description": "TODO", "type": "boolean" } }, "required": [ "id", "productOwnerId", "ownerId", "categoryId", "minSelections", "maxSelections", "minQuantity", "maxQuantity", "partitionable", "priority", "helpPrompt", "upsell", "muted", "mutedSelections", "readbackOrder", "readbackQuantity", "promptUpToMax", "elementSelectionGroupCompositeId", "promptOverride", "readbackFinalOption", "readOnProductOwner", "upgradePrompt", "categoryNonRestate", "ocbData" ] }, "selection-response": { "type": "object", "properties": { "mutualExclusions": { "description": "Also known as `anti-elements`, cannot be selected at the same time as the elements listed", "type": "array", "items": { "type": "integer", "minimum": 1 } }, "defaultQuantity": { "description": "Default quantity of this `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "defaultMode": { "description": "Default behaviour of this `selection`", "type": "string", "enum": [ "never", "on-request", "always", "prompt" ] }, "ocbData": { "description": "Collection of OCB data for the selection", "type": "object", "properties": { "promptVisibility": { "description": "Prompt visibility setting for the selection", "type": "string", "enum": [ "hidden", "visible", "highlight" ] } } }, "categoryId": { "description": "The `category-id` that this `selection` belongs to", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "locked": { "description": "TODO", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "boolean" } ] }, "id": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 0 }, "elementId": { "description": "The `element-id` of this `selection`", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "groups": { "description": "The `groups` of this selection. Used for menu fetching.", "type": "array", "items": { "$ref": "#/components/schemas/group" } } }, "required": [ "id", "productOwnerId", "ownerId", "elementId", "categoryId", "mutualExclusions", "locked", "ocbData" ] }, "ramsay.http.router.routes.v3.concepts.selections.schema.selection": { "type": "object", "properties": { "mutualExclusions": { "description": "Also known as `anti-elements`, cannot be selected at the same time as the elements listed", "type": "array", "items": { "type": "integer", "minimum": 1 } }, "defaultQuantity": { "description": "Default quantity of this `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "defaultMode": { "description": "Default behaviour of this `selection`", "type": "string", "enum": [ "never", "on-request", "always" ] }, "categoryId": { "description": "The `category-id` that this `selection` belongs to", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "id": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 0 }, "elementId": { "description": "The `element-id` of this `selection`", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "groups": { "description": "The `groups` of this selection. Used for menu fetching.", "type": "array", "items": { "type": "object", "properties": { "mutedSelections": { "description": "Selections in this group that shouldn't be spoken out", "type": "array", "items": { "type": "integer" } }, "maxSelections": { "description": "The maximum amount of `selections` to fulfill this `selection-group`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "muted": { "description": "When true, don't verbalize this group", "type": "boolean" }, "promptOverride": { "description": "Response text when generating a prompt for this group", "type": "string" }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/ramsay.http.router.routes.v3.concepts.selections.schema.selection" } }, "productOwnerId": { "description": "The `element-id` of this `selection`s product owner", "type": "integer", "minimum": 0 }, "helpPrompt": { "description": "TODO", "type": "string" }, "partitionable": { "description": "Whether this group can be split across partitions", "type": "boolean" }, "readbackOrder": { "description": "Order in which to list out the selections", "type": "array", "items": { "type": "integer" } }, "maxQuantity": { "description": "Maximum quantity a user must set on a single child `selection`", "type": "integer", "minimum": 1 }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `group`", "type": "integer", "minimum": 0 }, "readbackQuantity": { "description": "How many selections to readback when talking about this group", "type": "integer", "minimum": 0 }, "upsell": { "description": "When true upsell this group", "type": "boolean" }, "priority": { "description": "Represents the priority of this item against it's immediate peers", "type": "integer", "minimum": 0 }, "id": { "description": "ID of this `selection` `group` from menu.element_selection_groups_v2", "type": "integer", "minimum": 0 }, "ownerId": { "description": "The `element-id` of this `selection`s owner", "type": "integer", "minimum": 0 }, "minSelections": { "description": "The minimum amount of `selections` to fulfill this `selection-group`", "type": "integer", "minimum": 0 }, "minQuantity": { "description": "Minimum quantity a user must set on a single child `selection`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] } }, "required": [ "id", "productOwnerId", "ownerId", "categoryId", "minSelections", "maxSelections", "minQuantity", "maxQuantity", "partitionable", "priority", "helpPrompt", "upsell", "muted", "mutedSelections", "readbackOrder", "readbackQuantity", "promptOverride" ] } } }, "required": [ "id", "productOwnerId", "ownerId", "elementId", "categoryId", "mutualExclusions" ] }, "upsell-item": { "oneOf": [ { "description": "Defines the element to be prompted, unless that element already exists in the ticket", "type": "object", "properties": { "id": { "description": "The element id of the item to be offered", "type": "integer", "minimum": 1 }, "type": { "description": "Type of end of order upsell", "type": "string", "enum": [ "SingleElement" ] }, "priority": { "description": "The order in which we look at possible upsells to determine if they are valid to be offered", "type": "integer", "minimum": 1 } }, "required": [ "id", "type", "priority" ] }, { "description": "Check the ticket for items of the given category. If none exist, the customer will be offered a randomly selected element from the defined list of offers", "type": "object", "properties": { "id": { "description": "The element id of the item to be offered", "type": "integer", "minimum": 1 }, "type": { "description": "Type of end of order upsell", "type": "string", "enum": [ "MissingCategory" ] }, "priority": { "description": "The order in which we look at possible upsells to determine if they are valid to be offered", "type": "integer", "minimum": 1 }, "offers": { "description": "Element ids belonging to the given category and one of which will be randomly selected to offer to the customer", "type": "array", "items": { "type": "integer", "minimum": 1 } } }, "required": [ "id", "type", "priority", "offers" ] }, { "description": "aka “dynamic upsell”. This type looks at the customer’s previous orders and calculates which items they have purchased before most often, then selects one to offer the customer. If this upsell type is defined for a location, it is a good idea to also have another type defined, for customers that do not have any valid previous orders", "type": "object", "properties": { "type": { "description": "Type of end of order upsell", "type": "string", "enum": [ "AutoMagic" ] }, "priority": { "description": "The order in which we look at possible upsells to determine if they are valid to be offered", "type": "integer", "minimum": 1 } }, "required": [ "type", "priority" ] }, { "description": "if the category doesn’t have elements directly, it will says the category’s name", "type": "object", "properties": { "id": { "description": "The **category** id of the category to be offered", "type": "integer", "minimum": 1 }, "type": { "description": "Type of end of order upsell", "type": "string", "enum": [ "SingleCategory" ] }, "priority": { "description": "The order in which we look at possible upsells to determine if they are valid to be offered", "type": "integer", "minimum": 1 } }, "required": [ "id", "type", "priority" ] } ] }, "entity-request": { "type": "object", "properties": { "mappingId": { "description": "`mapping_id` of an entity from `pos_integration.entities` corresponding to this entry", "type": "string", "minLength": 1 }, "lookupId": { "description": "`lookup_id` of an entity from `pos_integration.entities` corresponding to this entry", "type": "string", "minLength": 1 }, "uniqueOrderingId": { "description": "UUID assigned by client, uniquely identifying this entry within the ticket", "type": "string", "minLength": 1 }, "orderingId": { "description": "Per location. POS ID used during order validation", "type": "string", "minLength": 1 }, "entityId": { "description": "UUID assigned by client, uniquely identifying this entry within the ticket", "type": "string", "minLength": 1 }, "partition": { "description": "Portion of item modifier is applied to; 0 is `whole`, non-0 meaning depends on item", "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "modifiers": { "type": "array", "items": { "$ref": "#/components/schemas/entity-request" } }, "specialInstructions": { "description": "Denotes whether this product is a special instruction", "type": "array", "items": {} }, "label": { "description": "Name of product", "type": "string", "minLength": 1 }, "quantity": { "description": "Number of times this entry was selected", "type": "integer", "minimum": 1 } }, "required": [ "mappingId", "lookupId", "uniqueOrderingId", "entityId", "label", "quantity" ] }, "occasion": { "type": "object", "properties": { "id": { "description": "ID of this `occasion`", "type": "integer", "minimum": 0 }, "occasion": { "description": "The `occasion-type`", "$ref": "#/components/schemas/occasion-type" }, "payment": { "description": "Field denoting whether `payment` is required or optional", "anyOf": [ { "type": "string", "enum": [ "required", "optional", "prohibited" ] }, { "type": "string", "enum": [ "" ] } ] }, "enabled": { "description": "Whether the `occasion` is enabled", "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "available": { "description": "Whether the `occasion` is available", "type": "boolean" }, "schedule": { "description": "The opening and closing times for this `occasion`", "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "The opening time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "The closing time for this segment of the `occasion`", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ] } } }, "required": [ "id", "occasion", "payment", "enabled", "available", "schedule" ] }, "option": { "type": "object", "properties": { "objectId": { "description": "ID corresponding to the `object_id` field from the `entities` array", "type": "string", "minLength": 1 }, "label": { "description": "Name of `option`", "type": "string", "minLength": 1 }, "description": { "description": "Description of `option`", "type": "string" }, "defaultEntity": { "description": "If `true`, `option` is a default choice within parent `constraint`", "type": "boolean" }, "defaultQuantity": { "description": "Set the default quantity of `option`", "type": "integer", "minimum": 1 }, "minimumQuantity": { "description": "Override of `minimum-choice-quantity` from parent `constraint`", "anyOf": [ { "type": "string", "enum": [ "inherit" ] }, { "type": "integer", "minimum": 0 } ] }, "maximumQuantity": { "description": "Override of `maximum-choice-quantity` from parent `constraint`", "anyOf": [ { "type": "string", "enum": [ "inherit" ] }, { "type": "integer", "minimum": 1 } ] }, "circlePartitions": { "description": "If `true`, `option` supports circle partitioning (i.e. Pizza toppings)", "type": "boolean" } }, "required": [ "objectId", "label", "description", "defaultEntity", "defaultQuantity", "minimumQuantity", "maximumQuantity", "circlePartitions" ] }, "upsellv2": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/upsell-item" } }, "occasions": { "description": "List of `occasion-type`s supported for upsell", "type": "array", "items": { "$ref": "#/components/schemas/occasion-type" } }, "schedule": { "anyOf": [ { "type": "string", "enum": [ "continuous" ] }, { "type": "array", "items": { "type": "object", "properties": { "opensAt": { "description": "start datetime of when this item upsell is active in UTC", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "closesAt": { "description": "end datetime of when this item upsell is active in UTC", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "opensAt", "closesAt" ] } } ] } }, "required": [ "items", "occasions", "schedule" ] }, "prose-hint": { "type": "object", "properties": { "enUs": { "description": "Language", "type": "object", "properties": { "readDescription": { "description": "If true, dictate description of category", "type": "boolean" }, "readbackOrder": { "description": "Order to dictate elements within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "readbackQuantity": { "description": "How many objects to dictate", "type": "integer" }, "readbackCategories": { "description": "Order of categories to dictate within category", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "modOrder": { "description": "TODO", "type": "integer" }, "crossSell": { "description": "TODO", "type": "object", "properties": { "elementId": { "description": "element id for cross selling", "type": "integer" }, "categoryId": { "description": "category id for cross selling", "type": "integer" } } }, "helpAddItem": { "description": "Additional text related to item", "type": "string" } } } } }, "disabled-element-selection": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "disabledBy": { "description": "tool, service or event that disabled this selection", "type": "string" }, "reason": { "description": "reason why it's disabled", "enum": [ "eighty-sixed", "off-menu", "validation-error", "" ] } }, "required": [ "selectionId", "disabledBy", "reason" ] }, "tender": { "type": "object", "properties": { "id": { "description": "ID of this `tender`", "type": "integer", "minimum": 0 }, "paymentTender": { "description": "type of `tender`", "type": "string", "enum": [ "cash", "credit-card", "gift-card", "check", "text-to-pay", "prepaid" ] }, "paymentCardType": { "description": "type of credit card if applicable", "enum": [ "visa", "master-card", "american-express", "diners-club", "discover", "j-c-b", "jcb", "insta-payment", "maestro", "unionpay", "" ] }, "enabled": { "description": "Whether the `tender` is enabled", "type": "boolean" }, "available": { "description": "Whether the `tender` is available", "type": "boolean" } }, "required": [ "id", "paymentTender", "paymentCardType", "enabled", "available" ] }, "configuration-response": { "type": "object", "properties": { "menuBoard": { "anyOf": [ { "type": "object", "properties": { "webhookUrl": { "description": "URL to send webhooks to from menu board", "type": "string" } } }, { "type": "object", "properties": {} } ] }, "orderingBot": { "type": "object", "properties": { "mobileOrderPickup": { "description": "Whether mobile order pickup is enabled for the current location", "type": "boolean" }, "rtoEnabled": { "description": "Ability to turn on/off RTO", "type": "boolean" }, "realtimeInputMode": { "description": "What input mode to use for realtime", "type": "string", "enum": [ "audio", "text" ] }, "transcriptionModelConfig": { "description": "Which transcription model to use", "type": "string", "enum": [ "polaris_base_8k", "polaris_base_16k", "polaris_food_8k", "polaris_food_16k", "polaris_bkuk", "polaris_panda_express", "polaris_kfc" ] }, "enableSkipTurn": { "description": "Whether the bot is allowed to skip turns when detecting background noise", "type": "boolean" }, "uiPresent": { "description": "Whether or not a UI is present for ordering", "type": "boolean" }, "forceReadCartSummaryOnCheckout": { "description": "Force cart readback on checkout even when speaking mode is terse", "type": "boolean" }, "promptConfig": { "description": "Configuration for templated fields in the ordering bot's system instructions", "type": "object", "properties": { "comboUpgradeExampleOption": { "type": "string" }, "ambiguousItemNameMatches": { "type": "string" }, "ambiguousItemName": { "type": "string" }, "unambiguousItemName": { "type": "string" }, "comboUpgradeExampleItem": { "type": "string" }, "language": { "type": "string" }, "unambiguousItemNameSimilarMatches": { "type": "string" }, "conceptSpecificOrderingInstructions": { "type": "string" }, "introduction": { "type": "string" }, "comboUpgradeExampleCombo": { "type": "string" } } }, "enableQuietSpeechDetection": { "description": "Whether quiet speech detection is enabled", "type": "boolean" }, "comboUpsell": { "description": "Whether the combo upsell feature is turned on for the location", "type": "boolean" }, "polaris": { "description": "Polaris configuration", "type": "object", "properties": { "minTokens": { "description": "Minimum tokens for polaris", "type": "integer" }, "minSilenceMs": { "description": "Minimum silence milliseconds for polaris", "type": "integer" }, "minSegmentMs": { "description": "Minimum segment milliseconds for polaris", "type": "integer" }, "backtrackMs": { "description": "Backtrack milliseconds for polaris", "type": "integer" } } }, "supportedLanguages": { "description": "Languages supported by the ordering bot", "type": "array", "items": { "type": "string", "enum": [ "English", "Spanish" ] } }, "comboSizeUpsell": { "description": "Whether the upsize combo feature is turned on", "type": "boolean" }, "realtimeProviderFallbackSequence": { "description": "Ordered fallback sequence of realtime API providers", "type": "array", "items": { "type": "string", "enum": [ "openai", "azure", "tempus", "xai" ] } }, "deepgram": { "description": "Deepgram transcription configuration", "type": "object", "properties": { "enabled": { "description": "Whether Deepgram is used for transcriptions", "type": "boolean" }, "language": { "description": "Deepgram language mode", "type": "string", "enum": [ "en", "multi" ] }, "useKeyterms": { "description": "Whether to pass boost phrases as Deepgram keyterms", "type": "boolean" }, "endpointingMs": { "description": "Trailing silence before Deepgram ends an utterance. Defaults to segment silence when unset.", "type": "integer" } } }, "includeDescription": { "description": "Whether to include description in the ordering bot", "type": "boolean" }, "openaiSemanticVad": { "description": "Whether OpenAI Semantic VAD is enabled", "type": "boolean" }, "openaiSemanticVadEagerness": { "description": "OpenAI Semantic VAD eagerness level", "type": "string", "enum": [ "low", "medium", "high", "auto" ] }, "responseStyle": { "description": "encourage the LLM towards specific ways of responding", "type": "object", "properties": { "basicUpdateCartSuccess": { "description": "when a basic update cart is called successfully", "type": "string" }, "invalidOptions": { "description": "when the customer or LLM adds invalid options to an item", "type": "string" }, "slotFilling": { "description": "when slot filling", "type": "string" }, "disambiguation": { "description": "when disambiguating", "type": "string" } } }, "sideUpsizeUpsell": { "description": "Whether the side upsize combo feature is turned on", "type": "boolean" }, "inputAudioNoiseReduction": { "description": "What value to send to openAI for noise reduction", "type": "string", "enum": [ "far_field", "near_field" ] }, "realtimeApiProvider": { "description": "Which realtime API provider to use", "type": "string", "enum": [ "openai", "azure", "tempus", "xai" ] }, "askForCollectionTimeAndName": { "description": "Whether the collection of time and name feature is turned on", "type": "boolean" }, "enableLlmRewriter": { "description": "Whether or not to enable LLM Rewriter", "type": "boolean" }, "semanticEot": { "description": "Semantic eot config", "type": "object", "properties": { "enabled": { "description": "If semantic eot is enabled", "type": "boolean" }, "completeDelayMs": { "description": "EOT complete delay in milliseconds", "type": "integer" }, "maybeCompleteDelayMs": { "description": "EOT maybe complete delay in milliseconds", "type": "integer" } } }, "confirmOrderOnUi": { "description": "Whether to show order confirmation on the UI", "type": "boolean" }, "multimodalSegmentation": { "description": "Enable multimodal segmentation. Takes precedence over manual segmentation when both are enabled.", "type": "object", "properties": { "polarisConfig": { "description": "Polaris VAD config for multimodal segmentation", "type": "object", "properties": { "minSilenceMs": { "description": "Minimum silence milliseconds for polaris", "type": "integer" }, "minSegmentMs": { "description": "Minimum segment milliseconds for polaris", "type": "integer" } } }, "openaiNoiseReduction": { "description": "OpenAI input audio noise reduction setting", "type": "string", "enum": [ "far_field", "near_field" ] }, "openaiEagerness": { "description": "OpenAI semantic VAD eagerness level", "type": "string", "enum": [ "low", "medium", "high", "auto" ] } } }, "speakingMode": { "description": "What speaking mode the analysts have set for the current location", "type": "string", "enum": [ "Terse", "None", "Normal" ] }, "boostPhrases": { "description": "ASR boost phrases", "type": "array", "items": { "type": "string" } }, "maxAllowedConsecutiveNudges": { "description": "Max number of allowed consecutive nudges before we end the session.", "type": "integer" }, "smartlane": { "description": "Whether smart lane is enabled for the current location", "type": "boolean" }, "manualSegmentation": { "description": "When set execute manual segmentation based on the config", "type": "object", "properties": { "type": { "description": "Type of segmentation", "type": "string", "enum": [ "fallback_segmentation" ] }, "config": { "description": "Config params for the segmentation", "type": "object", "properties": { "type": { "description": "Type of fallback segmentation", "type": "string", "enum": [ "polaris_vad_segmentation" ] }, "minSilenceMs": { "description": "Minimum silence milliseconds for polaris", "type": "integer" }, "minSegmentMs": { "description": "Minimum segment milliseconds for polaris", "type": "integer" } } } } }, "backupVad": { "description": "Whether the backup VAD feature is turned on", "type": "boolean" }, "llmModel": { "description": "What llm model and version to use", "type": "string", "enum": [ "gpt-realtime", "gpt-realtime-1.5", "gpt-realtime-2", "gpt-realtime-2.1" ] }, "endOfOrderUpsell": { "description": "Whether the end of order upsell feature is turned on for the location", "type": "boolean" }, "tempusConfig": { "description": "Config params for tempus llm", "type": "object", "properties": { "model": { "description": "Model version of tempus", "type": "string" }, "voice": { "description": "Name of voice used for tempus", "type": "string" }, "temperature": { "description": "Temperature to be passed to the Tempus provider", "type": "number", "minimum": 0, "maximum": 1 }, "semanticVad": { "description": "Whether Tempus semantic VAD is enabled", "type": "boolean" }, "semanticVadEagerness": { "description": "Tempus Semantic VAD eagerness level", "type": "string", "enum": [ "low", "medium", "high", "auto" ] }, "silenceDurationMs": { "description": "The amount of time the AI takes to respond after the user stops speaking", "type": "integer" }, "voiceSpeed": { "description": "Playback speed of TTS output", "type": "number" }, "delayStartMs": { "description": "The amount of time the AI waits to respond when the LLM determines the user has not finished speaking", "type": "integer" } } } } }, "salesSmartOrderingDemo": { "type": "object", "properties": { "prompt": { "description": "Prompt for the sales smart ordering demo", "type": "string" }, "menuData": { "description": "Menu data for the sales smart ordering demo", "type": "string" }, "configuration": { "description": "Arbitrary sales smart ordering demo config", "type": "string" } } }, "vox": { "type": "object", "properties": { "sendToHuman": { "description": "Configuration to destinations for each send to human reason", "type": "object", "properties": { "default": { "description": "Default if no language specified", "type": "array", "items": { "type": "object", "properties": { "reason": { "description": "Reason this entry applies", "type": "string" }, "to": { "description": "Value used when the reason applies", "type": "string" } }, "required": [ "reason", "to" ] } }, "en": { "description": "English overrides of default", "type": "array", "items": { "type": "object", "properties": { "reason": { "description": "Reason this entry applies", "type": "string" }, "to": { "description": "Value used when the reason applies", "type": "string" } }, "required": [ "reason", "to" ] } }, "es": { "description": "Spanish overrides of default", "type": "array", "items": { "type": "object", "properties": { "reason": { "description": "Reason this entry applies", "type": "string" }, "to": { "description": "Value used when the reason applies", "type": "string" } }, "required": [ "reason", "to" ] } } } } } }, "pos": { "type": "object", "properties": { "rateLimit": { "description": "the rate limit set by the POS for hitting their APIs (hits/s)", "type": "integer" } } }, "featureFlags": { "description": "The `feature-flags` map is 2 levels, `feature` and then `flag`", "type": "object", "properties": { "conceptMenu": { "description": "Flags associated with concept oriented menu, i.e. `concept/entities`", "type": "object", "properties": { "import": { "description": "Enable concept menu for importing", "type": "boolean" }, "order": { "description": "Enable concept menu for ordering; requires `import` is enabled", "type": "boolean" } } } } }, "version": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "voiceInsights": { "type": "object", "properties": { "features": { "description": "List of VI features", "type": "array", "items": { "type": "string", "enum": [ "customer-effort-score", "menu-items", "upsell" ] } }, "audio": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "hme", "smartorder_ai", "digital-acoustics", "acrelec", "lumen" ] }, "sourceExternalId": { "description": "Identifier within the provided audio source", "type": "string" } } }, "liveData": { "description": "Enable live data to be inserted", "type": "boolean" }, "speechToText": { "type": "object", "properties": { "provider": { "description": "Speech-to-text provider and model", "type": "string", "enum": [ "deepgram", "polaris-default_for_source", "polaris-base_8k", "polaris-base_16k", "polaris-food_8k", "polaris-food_16k", "polaris-bkuk", "polaris-panda_express" ] } } } } }, "viDashboard": { "type": "object", "properties": { "title": { "description": "Title for the dashboard", "type": "string" }, "time": { "description": "Config params for time display", "type": "object", "properties": { "enabled": { "description": "If time should be shown", "type": "boolean" } } }, "theme": { "description": "Which theme to use (default is a dark mode)", "type": "string", "enum": [ "soundhound" ] }, "fields": { "description": "Field information for dashboard", "type": "array", "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID for component", "type": "string" }, "component": { "description": "Name of the component to use", "type": "string" }, "props": { "description": "Props for component", "type": "string" }, "refreshSeconds": { "description": "How many seconds before the component should refresh the data", "type": "integer" }, "hide": { "description": "If component should be hidden", "type": "boolean" } }, "required": [ "id", "component", "props" ] } } }, "refreshSeconds": { "description": "How many seconds before the dashboard should refresh the data", "type": "integer" } }, "required": [ "fields" ] } } }, "intent-action": { "type": "object", "properties": { "llmDescription": { "description": "", "type": "string" }, "state": { "description": "State of conversation", "type": "string" }, "argument": { "description": "", "type": "string" }, "id": { "description": "ID of this intent-action", "type": "integer", "minimum": 1 }, "llmEntity": { "description": "", "type": "string" }, "comment": { "description": "", "type": "string" }, "channelId": { "description": "", "type": "integer", "minimum": 0 }, "intent": { "description": "Type of intent", "type": "string" }, "includeNext": { "description": "", "type": "boolean" }, "entity": { "description": "Reason why this intent action is triggered", "type": "string" }, "handler": { "description": "How to proceed with the conversation", "type": "string" } }, "required": [ "id", "intent", "entity", "handler", "argument", "comment", "state", "includeNext", "channelId", "llmDescription", "llmEntity" ] }, "element": { "type": "object", "properties": { "description": { "description": "Description of the `element`", "type": "string" }, "proseHint": { "description": "TODO", "$ref": "#/components/schemas/prose-hint" }, "categoryReadbackName": { "description": "TODO", "type": "string" }, "liftElementId": { "description": "`element-id` to apply a lift to", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "lookupName": { "description": "Lookup name of this `element`", "type": "string", "minLength": 1 }, "ocbData": { "description": "Collection of OCB data for the element", "type": "object", "properties": { "ocbLabel": { "description": "Override label to use on the OCB for the element", "type": "string" }, "ocbPromptLabel": { "description": "Override label to use on the OCB for the element when it is within a prompting scenario", "type": "string" }, "promptPhosphorIcons": { "description": "Collection of phosphor icons to display on the OCB beside the element", "type": "array", "items": { "type": "object", "properties": { "iconType": { "description": "Phosphor icon type", "type": "string" }, "iconWeight": { "description": "Phosphor icon weight", "type": "string" } }, "required": [ "iconType" ] } } } }, "synonyms": { "description": "Synonyms of this `element`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "lookupTags": { "description": "TODO", "type": "array", "items": { "type": "string" } }, "displayPlural": { "description": "Pluralized display name of this `element`", "type": "string" }, "categoryId": { "description": "The `category-id` of the immediate parent `category` of this `selection-group`", "type": "integer", "minimum": 0 }, "isFakeElement": { "description": "If this element has an element_tag = 17 (fakeProduct)", "type": "boolean" }, "customHints": { "description": "TODO", "type": "array", "items": { "type": "string" } }, "id": { "description": "The `id` of the `element`", "type": "integer", "minimum": 0 }, "comment": { "description": "TODO", "type": "string" }, "displayName": { "description": "Display name of this `element`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] }, "partitions": { "description": "How many partitions this element can support. 1 means no partitions", "type": "integer", "minimum": 1 }, "price": { "description": "Price of `element`", "anyOf": [ { "type": "string", "enum": [ "not-available" ] }, { "type": "integer", "minimum": 0 } ] }, "abbreviation": { "description": "TODO", "type": "string" }, "upgradeElementIds": { "description": "The array of `element-ids` this element can be upgraded to", "type": "array", "items": { "type": "integer", "minimum": 0 } }, "isSpecialInstruction": { "description": "If this element has an element_tag = 16 (specialInstruction)", "type": "boolean" } }, "required": [ "id", "elementType", "lookupName", "displayName", "synonyms", "displayPlural", "categoryId", "price", "description", "lookupTags", "partitions", "comment", "customHints", "categoryReadbackName", "abbreviation", "liftElementId", "ocbData", "upgradeElementIds" ] }, "section": { "type": "object", "properties": { "id": { "description": "Unique ID within the containing `menu`", "type": "string", "minLength": 1 }, "label": { "description": "Name of `section`", "type": "string", "minLength": 1 }, "description": { "description": "Description of `section`", "type": "string" }, "items": { "description": "List of `item-ids` contained within the `section` defined by the `item` schema", "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "id", "label", "description" ] }, "location": { "type": "object", "properties": { "timezone": { "description": "Timezone of this location" }, "occasions": { "description": "List of `occasion`s part of this `location`", "type": "array", "items": { "$ref": "#/components/schemas/occasion" } }, "telephone": { "description": "Phone number of this `location`" }, "name": { "description": "Name of this `location`", "type": "string" }, "stateCode": { "description": "US state of this `location` in 2 letter code form", "type": "string", "maxLength": 3 }, "city": { "description": "City this `location` is in", "type": "string" }, "tenders": { "description": "List of `tender`s part of this `location`", "type": "array", "items": { "$ref": "#/components/schemas/tender" } }, "countryCode": { "description": "Country this `location` is in via code", "type": "string" }, "delivery": { "description": "Delivery details", "type": "object", "properties": { "estimatedTime": { "type": "integer" }, "fee": { "type": "integer" } } }, "longitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "postalCode": { "description": "postal code of this `location`", "type": "string" }, "id": { "description": "ID of this `location`", "type": "integer", "minimum": 1 }, "streetAddress": { "description": "Street address of this `location`.", "type": "string" }, "latitude": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "available": { "description": "Whether this location is available", "type": "boolean" }, "upsellsV2": { "description": "End of order upsell data for a location", "type": "array", "items": { "$ref": "#/components/schemas/upsellv2" } }, "rating": { "description": "Location rating", "type": "number" }, "links": { "description": "External links for this location", "type": "object", "properties": { "ordering": { "type": "string" }, "logoImage": { "type": "string" } } } }, "required": [ "id", "available", "name", "streetAddress", "city", "stateCode", "countryCode", "postalCode", "timezone", "telephone", "longitude", "latitude", "occasions", "tenders", "upsellsV2" ] }, "item": { "type": "object", "properties": { "objectId": { "description": "ID corresponding to the `object_id` field from the `entities` array", "type": "string", "minLength": 1 }, "label": { "description": "Name of the `item`", "type": "string", "minLength": 1 }, "description": { "description": "Description of `item`", "type": "string" }, "featured": { "description": "If `true`, `item` is featured, which highlights it visually", "anyOf": [ { "type": "string", "enum": [ "existing" ] }, { "type": "boolean" } ] } }, "required": [ "objectId", "label", "description", "featured" ] }, "special-instruction": { "type": "object", "properties": { "label": { "description": "Text describing the instruction", "type": "string", "minLength": 1 } }, "required": [ "label" ] }, "selection-request": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "quantity": { "description": "Number of times this entry was selected", "type": "integer", "minimum": 1 }, "partition": { "description": "Portion of item modifier is applied to; 0 is `whole`, non-0 meaning depends on item", "type": "integer", "minimum": 0 }, "children": { "description": "The children `selections` of this selection. Used for ticket resolution.", "type": "array", "items": { "$ref": "#/components/schemas/selection-request" } } }, "required": [ "selectionId", "quantity" ] }, "location-entity": { "type": "object", "properties": { "entityId": { "description": "entity-id corresponding to the `id` field from the `entities` table", "type": "string", "minLength": 1 }, "orderingId": { "description": "Per location. POS ID used during order validation", "type": "string", "minLength": 1 }, "available": { "description": "Per location. If `true`, `item` is currently available, otherwise `item` is currently eighty-sixed.", "anyOf": [ { "type": "string", "enum": [ "existing" ] }, { "type": "boolean" } ] }, "orderingData": { "description": "Per location POS specific content used during order validation or submission" } }, "required": [ "entityId" ] }, "selection-schedule": { "type": "object", "properties": { "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "type": "integer", "minimum": 1 }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "availableTo": { "description": "when this selection ends availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" }, "availableFrom": { "description": "when this selection starts availability", "type": "string", "pattern": "^(?:19|20|21)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ$" } }, "required": [ "availableTo", "availableFrom" ] } } }, "required": [ "selectionId", "schedules" ] }, "resolved-product": { "type": "object", "properties": { "id": { "description": "ID of the entity from pos_integration.entities corresponding to this entry", "type": "string", "pattern": "^(itm|opt)_[0-9|a-f|A-F]{32}$" }, "parentId": { "description": "ID referencing the parent's id within the resolved ticket", "anyOf": [ { "type": "string", "enum": [ "root" ] }, { "type": "string", "pattern": "^(itm|opt)_[0-9|a-f|A-F]{32}$" } ] }, "orderingId": { "description": "POS ID used during order validation", "type": "string", "minLength": 1 }, "label": { "description": "Name of resolved product", "type": "string", "minLength": 1 }, "selectionId": { "description": "ID of the selection from menu.element_selections_v2 corresponding to this entry", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "quantity": { "description": "Number of times this entry was selected", "type": "integer", "minimum": 1 }, "partition": { "description": "Portion of item modifier is applied to; 0 is `whole`, non-0 meaning depends on item", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "orderingData": {} }, "required": [ "id", "parentId", "orderingId", "label", "selectionId", "quantity", "partition", "orderingData" ] }, "ramsay.http.router.routes.menu.selections.schema.selection-response": { "$ref": "#/components/schemas/selection-response" }, "occasion-type": { "type": "string", "enum": [ "carry-out", "delivery", "curbside", "dispatch", "drive-thru", "dine-in", "chipotlane", "pick-up-window" ] }, "category": { "type": "object", "properties": { "description": { "description": "Description of the `category`", "type": "string" }, "proseHint": { "description": "TODO", "$ref": "#/components/schemas/prose-hint" }, "lookupName": { "description": "Lookup name of the `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "string" } ] }, "synonyms": { "description": "Synonyms of this `category`", "type": "array", "items": { "type": "string", "minLength": 1 } }, "displayPlural": { "description": "Pluralized display name of the `category`", "type": "string" }, "categoryId": { "description": "Unique ID for a `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "posId": { "description": "ID from the pos", "type": "string" }, "parentId": { "description": "ID of parent `category`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 0 } ] }, "displayName": { "description": "Display name of the `category`", "type": "string", "minLength": 1 }, "elementType": { "description": "The `type` of `element`", "type": "string", "enum": [ "modifier", "combo", "group", "menu-item", "organizational", "ingredient", "special-instruction" ] }, "selectionsPromptRepeat": { "description": "Whether to repeat the prompt", "type": "boolean" } }, "required": [ "categoryId", "elementType", "lookupName", "displayName", "synonyms", "displayPlural", "parentId", "description", "posId", "selectionsPromptRepeat" ] }, "entity": { "type": "object", "properties": { "id": { "description": "Unique ID describing a specific entity within a concept", "type": "string", "minLength": 1 }, "objectId": { "description": "ID which can be describing multiple entities of the same type. (IE. `Onions` as a modifier to multiple burgers)", "type": "string", "minLength": 1 }, "kind": { "description": "Type of `entity`", "type": "string", "enum": [ "item", "constraint", "option" ] }, "sortOrder": { "description": "Sort order of `entity` relative to siblings", "type": "integer", "minimum": 0 }, "hidden": { "description": "If `true`, `entity` is hidden from the menu.", "type": "boolean" }, "mappingId": { "description": "Universal id of `entity` used by automation team when mapping voice menu", "type": "string", "minLength": 1 }, "children": { "description": "List of children `entity`", "type": "array", "items": { "$ref": "#/components/schemas/entity" } } }, "required": [ "id", "objectId", "kind", "sortOrder", "hidden", "mappingId" ] }, "constraint": { "type": "object", "properties": { "description": { "description": "Description of the constraint", "type": "string" }, "objectId": { "description": "ID corresponding to the `object_id` field from the `entities` array", "type": "string", "minLength": 1 }, "maximumChoices": { "description": "Maximum number of choices user is allowed to make within `constraint`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "minimumChoices": { "description": "Minimum number of choices user must make within `constraint`", "type": "integer", "minimum": 0 }, "minimumChoiceQuantity": { "description": "Minimum quantity a user must set on a single `option` within `constraint`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "maximumChoiceQuantity": { "description": "Maximum quantity a user is allowed on a single `option` within `constraint`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] }, "minimumTotalQuantity": { "description": "Minimum total quantity across all `options` user must set within `constraint`", "anyOf": [ { "type": "string", "enum": [ "not-applicable" ] }, { "type": "integer", "minimum": 1 } ] }, "quantityIncrement": { "description": "Step size by which the quantity of a choice, allowing values other than 1", "type": "integer", "minimum": 1 }, "label": { "description": "Name of `constraint`", "type": "string", "minLength": 1 }, "required": { "description": "If `true`, user must choose at least 1 `option` within `constraint`", "type": "boolean" }, "maximumTotalQuantity": { "description": "Maximum total quantity across all `options` user is allowed to set within `constraint`", "anyOf": [ { "type": "string", "enum": [ "no-limit" ] }, { "type": "integer", "minimum": 1 } ] } }, "required": [ "objectId", "label", "description", "required", "minimumChoices", "maximumChoices", "minimumChoiceQuantity", "maximumChoiceQuantity", "minimumTotalQuantity", "maximumTotalQuantity", "quantityIncrement" ] } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "API key required to access the endpoints." } } }, "security": [ { "ApiKeyAuth": [] } ] }