id
stringlengths 53
86
| api_name
stringlengths 2
76
| api_description
stringlengths 1
500
⌀ | api_score
float64 0
10
⌀ | endpoint_name
stringlengths 1
190
| endpoint_description
stringlengths 0
500
| response_status_code
int64 100
505
| response_summary
stringlengths 1
68
⌀ | response_json
stringlengths 6
50k
| response_json_schema
stringlengths 14
150k
|
|---|---|---|---|---|---|---|---|---|---|
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/7aa899e0-c5be-46a7-8e55-d9b3e80373e4/4/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_garbageCollections | To get information about past garbage collections for a registry, send a GET request to /v2/registry/$REGISTRY_NAME/garbage-collections. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5d69054f-0049-4865-b647-cb771fbc3ced/0/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositoryTags | To list all tags in your container registry repository, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags.
Note that if your repository name contains / characters, it must be
URL-encoded in the request URL. For example, to list tags for
registry.digitalocean.com/example/my/repo, the path would be
/v2/registry/example/repositories/my%2Frepo/tags. | 200 | null | {"tags": [{"registry_name": "example", "repository": "repo-1", "tag": "latest", "manifest_digest": "sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221", "compressed_size_bytes": 2803255, "size_bytes": 5861888, "updated_at": "2020-04-09T23:54:25Z"}], "meta": {"total": 1}} | {"allOf": [{"type": "object", "properties": {"tags": {"type": "array", "items": {"type": "object", "properties": {"registry_name": {"type": "string", "description": "The name of the container registry."}, "repository": {"type": "string", "description": "The name of the repository."}, "tag": {"type": "string", "description": "The name of the tag."}, "manifest_digest": {"type": "string", "description": "The digest of the manifest associated with the tag."}, "compressed_size_bytes": {"type": "integer", "description": "The compressed size of the tag in bytes."}, "size_bytes": {"type": "integer", "description": "The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available)."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time the tag was last updated."}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5d69054f-0049-4865-b647-cb771fbc3ced/1/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositoryTags | To list all tags in your container registry repository, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags.
Note that if your repository name contains / characters, it must be
URL-encoded in the request URL. For example, to list tags for
registry.digitalocean.com/example/my/repo, the path would be
/v2/registry/example/repositories/my%2Frepo/tags. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5d69054f-0049-4865-b647-cb771fbc3ced/2/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositoryTags | To list all tags in your container registry repository, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags.
Note that if your repository name contains / characters, it must be
URL-encoded in the request URL. For example, to list tags for
registry.digitalocean.com/example/my/repo, the path would be
/v2/registry/example/repositories/my%2Frepo/tags. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5d69054f-0049-4865-b647-cb771fbc3ced/3/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositoryTags | To list all tags in your container registry repository, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags.
Note that if your repository name contains / characters, it must be
URL-encoded in the request URL. For example, to list tags for
registry.digitalocean.com/example/my/repo, the path would be
/v2/registry/example/repositories/my%2Frepo/tags. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/5d69054f-0049-4865-b647-cb771fbc3ced/4/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositoryTags | To list all tags in your container registry repository, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags.
Note that if your repository name contains / characters, it must be
URL-encoded in the request URL. For example, to list tags for
registry.digitalocean.com/example/my/repo, the path would be
/v2/registry/example/repositories/my%2Frepo/tags. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f066f12b-f159-4a07-ba1e-0c34146ae1c7/0/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositories | This endpoint has been deprecated in favor of the List All Container Registry Repositories [V2] endpoint.
To list all repositories in your container registry, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories. | 200 | null | {"repositories": [{"registry_name": "example", "name": "repo-1", "latest_tag": {"registry_name": "example", "repository": "repo-1", "tag": "latest", "manifest_digest": "sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221", "compressed_size_bytes": 2803255, "size_bytes": 5861888, "updated_at": "2020-04-09T23:54:25Z"}, "tag_count": 1}], "meta": {"total": 1}} | {"allOf": [{"type": "object", "properties": {"repositories": {"type": "array", "items": {"type": "object", "properties": {"registry_name": {"type": "string", "description": "The name of the container registry."}, "name": {"type": "string", "description": "The name of the repository."}, "latest_tag": {"type": "object", "properties": {"registry_name": {"type": "string", "description": "The name of the container registry."}, "repository": {"type": "string", "description": "The name of the repository."}, "tag": {"type": "string", "description": "The name of the tag."}, "manifest_digest": {"type": "string", "description": "The digest of the manifest associated with the tag."}, "compressed_size_bytes": {"type": "integer", "description": "The compressed size of the tag in bytes."}, "size_bytes": {"type": "integer", "description": "The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available)."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time the tag was last updated."}}}, "tag_count": {"type": "integer", "description": "The number of tags in the repository."}}}}}}, {"type": "object", "properties": {"links": {"type": "object", "properties": {"pages": {"anyOf": [{"allOf": [{"type": "object", "properties": {"last": {"description": "URI of the last page of the results.", "type": "string"}}}, {"type": "object", "properties": {"next": {"description": "URI of the next page of the results.", "type": "string"}}}]}, {"allOf": [{"type": "object", "properties": {"first": {"description": "URI of the first page of the results.", "type": "string"}}}, {"type": "object", "properties": {"prev": {"description": "URI of the previous page of the results.", "type": "string"}}}]}, {}]}}}}}, {"type": "object", "properties": {"meta": {"allOf": [{"type": "object", "description": "Information about the response itself.", "properties": {"total": {"description": "Number of objects returned by the request.", "type": "integer"}}}, {"required": ["total"]}]}}, "required": ["meta"]}]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f066f12b-f159-4a07-ba1e-0c34146ae1c7/1/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositories | This endpoint has been deprecated in favor of the List All Container Registry Repositories [V2] endpoint.
To list all repositories in your container registry, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories. | 404 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f066f12b-f159-4a07-ba1e-0c34146ae1c7/2/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositories | This endpoint has been deprecated in favor of the List All Container Registry Repositories [V2] endpoint.
To list all repositories in your container registry, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories. | 429 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f066f12b-f159-4a07-ba1e-0c34146ae1c7/3/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositories | This endpoint has been deprecated in favor of the List All Container Registry Repositories [V2] endpoint.
To list all repositories in your container registry, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories. | 500 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
d13d76eb-ec0a-49cd-8e23-b1fc4fe6f0c7/f066f12b-f159-4a07-ba1e-0c34146ae1c7/4/0 | Digital Ocean | Digital Ocean Public API | null | registry_list_repositories | This endpoint has been deprecated in favor of the List All Container Registry Repositories [V2] endpoint.
To list all repositories in your container registry, send a GET
request to /v2/registry/$REGISTRY_NAME/repositories. | 401 | null | {"id": "not_found", "message": "The resource you were accessing could not be found.", "request_id": "4d9d8375-3c56-4925-a3e7-eb137fed17e9"} | {"type": "object", "properties": {"id": {"description": "A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be \"not_found.\"", "type": "string"}, "message": {"description": "A message providing additional information about the error, including details to help resolve it when possible.", "type": "string"}, "request_id": {"description": "Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.", "type": "string"}}, "required": ["id", "message"]} |
5dee9bd8-53f5-4e9b-8f47-84facdade5c0/0616d9d9-a3be-4fab-8fa7-cb0c63726f7b/0/0 | Real Estate Property API | This api covers over 180+ Million properties in the US and Canada.
Our API is fast and easy to use, making it a valuable tool for anyone looking to create a real estate service. | 7 | Get Property Details by Id | This endpoint will show all property details by its Id.
Send a URL parameter named "id" with a number.
Example: ?id=1000 | 200 | New Example | {"property_id": 1, "streetNumber": "7850", "streetName": "Green Lake", "streetType": "Dr", "unitType": "#", "unitValue": "301", "directionalSuffix": "N", "directionalPrefix": "E", "assembledAddress": "7850 E Green Lake Dr N #301", "city": "Seattle", "state": "WA", "zip": "98103", "countryCode": "US", "latitude": 47.6857288, "longitude": -122.336433, "beds": 2, "baths": 2, "numFullBaths": 2, "homeStatusLabel": "Off Market", "yearBuilt": 1978, "sqFt": 1090, "apn": "288790011002", "fips": "53033", "avm": 687978, "countyName": "King County", "propertyTypeName": "Condo/Co-op", "sqFtFinished": 1090, "totalSqFt": 1090, "numStories": "4", "allTaxInfo": [{"taxableLandValue": 299400, "taxableImprovementValue": 335600, "rollYear": 2022, "taxesDue": 5798.67}, {"taxableLandValue": 299400, "taxableImprovementValue": 335600, "rollYear": 2021, "taxesDue": 5785.26}, {"taxableLandValue": 288500, "taxableImprovementValue": 313500, "rollYear": 2020, "taxesDue": 6426.21}, {"taxableLandValue": 201400, "taxableImprovementValue": 407600, "rollYear": 2019, "taxesDue": 5200.95}, {"taxableLandValue": 201400, "taxableImprovementValue": 407600, "rollYear": 2018, "taxesDue": 5050.29}, {"taxableLandValue": 157800, "taxableImprovementValue": 355200, "rollYear": 2017, "taxesDue": 4378}, {"taxableLandValue": 141500, "taxableImprovementValue": 317500, "rollYear": 2016, "taxesDue": 4220}, {"taxableLandValue": 130600, "taxableImprovementValue": 301400, "rollYear": 2015, "taxesDue": 3821}, {"taxableLandValue": 119700, "taxableImprovementValue": 280300, "rollYear": 2014, "taxesDue": 3133}, {"taxableLandValue": 108800, "taxableImprovementValue": 186200, "rollYear": 2013, "taxesDue": 3325.86}, {"taxableLandValue": 108800, "taxableImprovementValue": 199200, "rollYear": 2012, "taxesDue": 3480.52}, {"taxableLandValue": 114300, "taxableImprovementValue": 259700, "rollYear": 2011, "taxesDue": 3689.83}, {"taxableLandValue": 114300, "taxableImprovementValue": 235700, "rollYear": 2010, "taxesDue": 3232.96}, {"taxableLandValue": 92500, "taxableImprovementValue": 300500, "rollYear": 2009, "taxesDue": 3200.07}], "bounds": [{"lat": "47.6855445899536", "long": "-122.336254286273"}, {"lat": "47.6855682674276", "long": "-122.336312685837"}, {"lat": "47.6855906997248", "long": "-122.336372145823"}, {"lat": "47.6856118710401", "long": "-122.336432617043"}, {"lat": "47.6856445214099", "long": "-122.336536244578"}, {"lat": "47.6856734604376", "long": "-122.336642258139"}, {"lat": "47.6859989011279", "long": "-122.336641201484"}, {"lat": "47.6859188900931", "long": "-122.336292754432"}, {"lat": "47.6858031969448", "long": "-122.335963596395"}, {"lat": "47.6855445899536", "long": "-122.336254286273"}], "polygon": "POLYGON ((-122.336254286273 47.6855445899536, -122.336312685837 47.6855682674276, -122.336372145823 47.6855906997248, -122.336432617043 47.6856118710401, -122.336536244578 47.6856445214099, -122.336642258139 47.6856734604376, -122.336641201484 47.6859989011279, -122.336292754432 47.6859188900931, -122.335963596395 47.6858031969448, -122.336254286273 47.6855445899536))", "timeZone": "US/Pacific"} | {"type": "object", "properties": {"property_id": {"type": "string"}, "streetNumber": {"type": "string"}, "streetName": {"type": "string"}, "streetType": {"type": "string"}, "unitType": {"type": "string"}, "unitValue": {"type": "string"}, "directionalSuffix": {"type": "string"}, "directionalPrefix": {"type": "string"}, "assembledAddress": {"type": "string"}, "city": {"type": "string"}, "state": {"type": "string"}, "zip": {"type": "string"}, "countryCode": {"type": "string"}, "latitude": {"type": "string"}, "longitude": {"type": "string"}, "beds": {"type": "string"}, "baths": {"type": "string"}, "numFullBaths": {"type": "string"}, "homeStatusLabel": {"type": "string"}, "yearBuilt": {"type": "string"}, "sqFt": {"type": "string"}, "apn": {"type": "string"}, "fips": {"type": "string"}, "avm": {"type": "string"}, "countyName": {"type": "string"}, "propertyTypeName": {"type": "string"}, "sqFtFinished": {"type": "string"}, "totalSqFt": {"type": "string"}, "numStories": {"type": "string"}, "allTaxInfo": {"type": "string"}, "streetViewUrl": {"type": "string"}, "staticMapUrl": {"type": "string"}, "bounds": {"type": "string"}, "polygon": {"type": "string"}, "timeZone": {"type": "string"}}} |
5dee9bd8-53f5-4e9b-8f47-84facdade5c0/454aba05-ccb0-43f4-a78a-4ca0177e91a3/0/0 | Real Estate Property API | This api covers over 180+ Million properties in the US and Canada.
Our API is fast and easy to use, making it a valuable tool for anyone looking to create a real estate service. | 7 | Get Property Details by Address | This endpoint will show all property details by its Address.
Send a URL parameter named "assembledAddress".
Optional Parameters for accuracy:
city
state
zip | 200 | New Example | {"property_id": 1, "streetNumber": "7850", "streetName": "Green Lake", "streetType": "Dr", "unitType": "#", "unitValue": "301", "directionalSuffix": "N", "directionalPrefix": "E", "assembledAddress": "7850 E Green Lake Dr N #301", "city": "Seattle", "state": "WA", "zip": "98103", "countryCode": "US", "latitude": 47.6857288, "longitude": -122.336433, "beds": 2, "baths": 2, "numFullBaths": 2, "homeStatusLabel": "Off Market", "yearBuilt": 1978, "sqFt": 1090, "apn": "288790011002", "fips": "53033", "avm": 687978, "countyName": "King County", "propertyTypeName": "Condo/Co-op", "sqFtFinished": 1090, "totalSqFt": 1090, "numStories": "4", "allTaxInfo": [{"taxableLandValue": 299400, "taxableImprovementValue": 335600, "rollYear": 2022, "taxesDue": 5798.67}, {"taxableLandValue": 299400, "taxableImprovementValue": 335600, "rollYear": 2021, "taxesDue": 5785.26}, {"taxableLandValue": 288500, "taxableImprovementValue": 313500, "rollYear": 2020, "taxesDue": 6426.21}, {"taxableLandValue": 201400, "taxableImprovementValue": 407600, "rollYear": 2019, "taxesDue": 5200.95}, {"taxableLandValue": 201400, "taxableImprovementValue": 407600, "rollYear": 2018, "taxesDue": 5050.29}, {"taxableLandValue": 157800, "taxableImprovementValue": 355200, "rollYear": 2017, "taxesDue": 4378}, {"taxableLandValue": 141500, "taxableImprovementValue": 317500, "rollYear": 2016, "taxesDue": 4220}, {"taxableLandValue": 130600, "taxableImprovementValue": 301400, "rollYear": 2015, "taxesDue": 3821}, {"taxableLandValue": 119700, "taxableImprovementValue": 280300, "rollYear": 2014, "taxesDue": 3133}, {"taxableLandValue": 108800, "taxableImprovementValue": 186200, "rollYear": 2013, "taxesDue": 3325.86}, {"taxableLandValue": 108800, "taxableImprovementValue": 199200, "rollYear": 2012, "taxesDue": 3480.52}, {"taxableLandValue": 114300, "taxableImprovementValue": 259700, "rollYear": 2011, "taxesDue": 3689.83}, {"taxableLandValue": 114300, "taxableImprovementValue": 235700, "rollYear": 2010, "taxesDue": 3232.96}, {"taxableLandValue": 92500, "taxableImprovementValue": 300500, "rollYear": 2009, "taxesDue": 3200.07}], "bounds": [{"lat": "47.6855445899536", "long": "-122.336254286273"}, {"lat": "47.6855682674276", "long": "-122.336312685837"}, {"lat": "47.6855906997248", "long": "-122.336372145823"}, {"lat": "47.6856118710401", "long": "-122.336432617043"}, {"lat": "47.6856445214099", "long": "-122.336536244578"}, {"lat": "47.6856734604376", "long": "-122.336642258139"}, {"lat": "47.6859989011279", "long": "-122.336641201484"}, {"lat": "47.6859188900931", "long": "-122.336292754432"}, {"lat": "47.6858031969448", "long": "-122.335963596395"}, {"lat": "47.6855445899536", "long": "-122.336254286273"}], "polygon": "POLYGON ((-122.336254286273 47.6855445899536, -122.336312685837 47.6855682674276, -122.336372145823 47.6855906997248, -122.336432617043 47.6856118710401, -122.336536244578 47.6856445214099, -122.336642258139 47.6856734604376, -122.336641201484 47.6859989011279, -122.336292754432 47.6859188900931, -122.335963596395 47.6858031969448, -122.336254286273 47.6855445899536))", "timeZone": "US/Pacific"} | {"type": "object", "properties": {"property_id": {"type": "string"}, "streetNumber": {"type": "string"}, "streetName": {"type": "string"}, "streetType": {"type": "string"}, "unitType": {"type": "string"}, "unitValue": {"type": "string"}, "directionalSuffix": {"type": "string"}, "directionalPrefix": {"type": "string"}, "assembledAddress": {"type": "string"}, "city": {"type": "string"}, "state": {"type": "string"}, "zip": {"type": "string"}, "countryCode": {"type": "string"}, "latitude": {"type": "string"}, "longitude": {"type": "string"}, "beds": {"type": "string"}, "baths": {"type": "string"}, "numFullBaths": {"type": "string"}, "homeStatusLabel": {"type": "string"}, "yearBuilt": {"type": "string"}, "sqFt": {"type": "string"}, "apn": {"type": "string"}, "fips": {"type": "string"}, "avm": {"type": "string"}, "countyName": {"type": "string"}, "propertyTypeName": {"type": "string"}, "sqFtFinished": {"type": "string"}, "totalSqFt": {"type": "string"}, "numStories": {"type": "string"}, "allTaxInfo": {"type": "string"}, "streetViewUrl": {"type": "string"}, "staticMapUrl": {"type": "string"}, "bounds": {"type": "string"}, "polygon": {"type": "string"}, "timeZone": {"type": "string"}}} |
c8aa976d-7afe-484f-8d0c-7ebb62958ae7/2d7aa68d-d6b5-467e-9c3b-54e952f90c68/0/0 | CalendarEvents | Retrieve Google Calendar Events from a public calendar | 8.4 | Calendar Events | Retrieve Google Calendar Events from a public calendar | 200 | New Example | {"success": true, "data": {"kind": "calendar#events"}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "data": {"type": "object", "properties": {"kind": {"type": "string"}}, "required": ["kind"]}}, "required": ["data", "success"]} |
959c1c72-e14e-4095-8acd-77cc5d66536d/f1269195-f5df-4a3a-9dce-119cc275b8bc/0/0 | Florida Realty API | Find condos and townhouses in Florida (USA) and get access to the original listing service MLS with thousands of properties. | 8.4 | getListing | Use this endpoint to get detailed information about a single condominium or townhouse. | 404 | Not found error | {"@context": ["http://schema4i.org/SearchAction.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "Action", "ActionStatus": "FailedActionStatus", "Error": {"@type": "Thing", "Name": "An error occured.", "Description": "No listing found with ID M5215311859x. Please check your identifier."}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "ActionStatus": {"type": "string"}, "Error": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}}, "required": ["@type", "Description", "Name"]}}, "required": ["@context", "@type", "ActionStatus", "Error"]} |
959c1c72-e14e-4095-8acd-77cc5d66536d/f1269195-f5df-4a3a-9dce-119cc275b8bc/1/0 | Florida Realty API | Find condos and townhouses in Florida (USA) and get access to the original listing service MLS with thousands of properties. | 8.4 | getListing | Use this endpoint to get detailed information about a single condominium or townhouse. | 200 | Detailed property information | {"@context": ["http://schema4i.org/SearchAction.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/RealEstateListing.jsonld", "http://schema4i.org/WebPage.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/ItemList.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ContactPoint.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "SearchAction", "ActionStatus": "CompletedActionStatus", "Result": {"@type": "RealEstateListing", "DateModified": "2022-11-24T07:47:19Z", "Creator": {"@type": "Organization", "Name": "X-PLOR GmbH", "Address": {"@type": "PostalAddress", "StreetAddress": "Lindenstr. 48-52", "PostalCode": "40233", "AddressLocality": "Duesseldorf", "AddressCountry": "D"}, "ContactPoint": {"@type": "ContactPoint", "Name": "Sales", "EMail": "[email protected]"}, "SameAs": "https://www.x-plor.de"}, "Offers": [{"@context": ["http://schema4i.org/OfferForPurchase.jsonld", "http://schema4i.org/Offer.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/Person.jsonld", "http://schema4i.org/SingleFamilyResidence.jsonld", "http://schema4i.org/Apartment.jsonld", "http://schema4i.org/Accommodation.jsonld", "http://schema4i.org/Place.jsonld", "http://schema4i.org/LocationFeatureSpecification.jsonld", "http://schema4i.org/QuantitativeValue.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ImageObject.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/PriceSpecification.jsonld", "http://schema4i.org/Thing.jsonld"], "@id": "https://api.x-plor.de/data/listings/M5215311859", "@type": "OfferForPurchase", "Identifier": "M5215311859", "OfferedBy": {"@type": "Person", "Name": "Parker Keevican", "JobTitle": "Realtor", "WorksFor": {"@type": "Organization", "Name": "Keller Williams Realty Naples", "Telephone": "(239) 449-1000", "Image": {"@type": "ImageObject", "ContentUrl": "https://p.rdcpix.com/v02/o9b931700-c0s.gif"}}}, "Price": 220000, "PriceCurrency": "USD", "PriceSpecification": [{"@type": "PriceSpecification", "Identifier": "HOA", "Name": "Home Owners Association Fee", "Price": 446, "PriceCurrency": "USD"}], "Availability": "InStock", "AvailabilityStarts": "2022-11-21T13:24:37Z", "BusinessFunction": "http://purl.org/goodrelations/v1#Sell", "ItemOffered": {"@type": "SingleFamilyResidence", "@id": "#M5215311859", "YearBuilt": 1983, "FloorLevel": null, "AmenityFeature": [{"@type": "LocationFeatureSpecification", "Name": "Bedrooms", "Value": ["Bedrooms: 2", "Bedroom 1 Features: Master BR Upstairs, Split Bedrooms", "Bedroom 1 Description: 2 Bed"], "ValueReference": "Interior"}, {"@type": "LocationFeatureSpecification", "Name": "Bathrooms", "Value": ["Total Bathrooms: 1 / 1", "Full Bathrooms: 1", "1/2 Bathrooms: 1"], "ValueReference": "Interior"}, {"@type": "LocationFeatureSpecification", "Name": "Interior Features", "Value": ["Internet Available", "Walk-In Closet", "Furnished Description: Unfurnished", "Flooring: Tile, Vinyl", "Window Features: Single Hung"], "ValueReference": "Interior"}, {"@type": "LocationFeatureSpecification", "Name": "Appliances", "Value": ["Cooktop - Electric", "Dishwasher", "Dryer", "Microwave", "Range", "Refrigerator", "Washer/Dryer Hookup"], "ValueReference": "Interior"}, {"@type": "LocationFeatureSpecification", "Name": "Heating and Cooling", "Value": ["Cooling Features: Central Electric", "Heating Features: Central Electric"], "ValueReference": "Interior"}, {"@type": "LocationFeatureSpecification", "Name": "Garage and Parking", "Value": ["Carport Features: Detached", "Carport Spaces: 1", "Parking Features: 1 Assigned"], "ValueReference": "Exterior"}, {"@type": "LocationFeatureSpecification", "Name": "Land Info", "Value": ["Lot Description: Regular", "Lot Size Acres: 0.07", "Lot Size Square Feet: 3049"], "ValueReference": "Exterior"}, {"@type": "LocationFeatureSpecification", "Name": "Amenities and Community Features", "Value": ["Clubhouse", "Community Pool"], "ValueReference": "Community"}, {"@type": "LocationFeatureSpecification", "Name": "Homeowners Association", "Value": ["Association: Yes", "Association Fee: 446", "Association Fee Frequency: Monthly", "Association Fee Amenities: Non-Gated", "Calculated Total Monthly Association Fees: 446", "Pet Description: Limits"], "ValueReference": "Community"}, {"@type": "LocationFeatureSpecification", "Name": "Other Property Info", "Value": ["Source Listing Status: Pending With Contingencies", "County: Lee", "Ownership: Condo", "Source Property Type: Low Rise (1-3)", "Area: CC21 - Cape Coral Unit 3, 30, 44, 6", "Property Subtype: townhouse", "Source Neighborhood: CC21 - Cape Coral Unit 3, 30, 44, 6", "Parcel Number: 10-45-23-C3-00100.0010", "Source System Name: C2C"], "ValueReference": "Listing"}, {"@type": "LocationFeatureSpecification", "Name": "Farm Info", "Value": ["Irrigation Source: Assessment Paid, Central"], "ValueReference": "Listing"}, {"@type": "LocationFeatureSpecification", "Name": "Building and Construction", "Value": ["Total Square Feet Living: 886", "Year Built: 1983", "Construction Materials: Concrete Block", "Property Age: 39", "Roof: Shingle", "Levels or Stories: 2", "House Style: End-Unit", "Year Built Details: Resale Property"], "ValueReference": "Features"}, {"@type": "LocationFeatureSpecification", "Name": "Utilities", "Value": ["Sewer: Assessment Paid, Central", "Cable TV Expense: 1"], "ValueReference": "Features"}, {"@type": "LocationFeatureSpecification", "Name": "Legal and finance", "Value": ["HOA Frequency: Monthly/446", "HOA fee: $446"]}], "Keywords": ["CARPORT", "CENTRAL_AIR", "CENTRAL_HEAT", "COMMUNITY_CLUBHOUSE", "COMMUNITY_SECURITY_FEATURES", "DISHWASHER", "RECREATION_FACILITIES", "WASHER_DRYER", "COMMUNITY_SWIMMING_POOL", "TWO_OR_MORE_STORIES", "CLUBHOUSE", "HOA", "MAINTENANCE", "SHOPPING", "MULTI_STOREY"], "FloorSize": {"@type": "QuantitativeValue", "Name": "Size", "Value": 886, "UnitCode": "FTK", "UnitText": "sqft"}, "NumberOfBathroomsTotal": 2, "NumberOfBedrooms": 2, "NumberOfFullBathrooms": 1, "NumberOfPartialBathrooms": 1, "PermittedUsage": null, "PetsAllowed": " Limits", "Address": {"@type": "PostalAddress", "AddressCountry": "USA", "AddressRegion": "Lee", "AddressLocality": "Cape Coral", "PostalCode": "33914", "StreetAddress": "4520 SW 8th Pl Apt 1", "Name": "4520 SW 8th Pl Apt 1, Cape Coral, FL 33914, USA", "Description": "Neighborhood Pelican"}, "Latitude": 26.567657, "Longitude": -81.992067, "Photo": [{"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2627801851x.jpg", "Keywords": ["UNKNOWN", "HOUSE_VIEW", "ROAD_VIEW", "HOUSE_VIEW", "HOUSE_VIEW"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m520421214x.jpg", "Keywords": ["LIVING_ROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m3930521077x.jpg", "Keywords": ["LIVING_ROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2784205385x.jpg", "Keywords": ["DINING_ROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2805153354x.jpg", "Keywords": ["BEDROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m1669788787x.jpg", "Keywords": ["LIVING_ROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m277108223x.jpg", "Keywords": ["DINING_ROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m1967138062x.jpg", "Keywords": ["LAUNDRY_ROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m1275565182x.jpg", "Keywords": ["KITCHEN"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m943924063x.jpg", "Keywords": ["KITCHEN"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m3586811179x.jpg", "Keywords": ["BATHROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m298466941x.jpg", "Keywords": ["BEDROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m3632252195x.jpg", "Keywords": ["BEDROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m396567280x.jpg", "Keywords": ["BATHROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2846058102x.jpg", "Keywords": ["BEDROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2017357817x.jpg", "Keywords": ["BEDROOM"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m1034503956x.jpg", "Keywords": ["UNKNOWN", "POOL"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2983797785x.jpg", "Keywords": ["UNKNOWN", "HOUSE_VIEW", "ROAD_VIEW", "POOL", "HOUSE_VIEW"]}, {"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m1027347164x.jpg", "Keywords": ["UNKNOWN", "HOUSE_VIEW", "YARD", "HOUSE_VIEW", "HOUSE_VIEW", "HOUSE_VIEW"]}], "Identifier": "MLS 222083493", "MainEntityOfPage": "https://www.cape-voyager.com/listings/M5215311859", "Name": "2 Bed, 2 Bath, 886 sqft", "Description": "Welcome home to this beautifully appointed end unit townhouse. Its light and bright coastal style is perfect for permanent or seasonal residents looking to enjoy the laid back Florida lifestyle. This spacious 2bed 1.5bath townhome has been updated throughout including granite countertops, stainless steel Samsung appliances, and gorgeous vinyl plank flooring. It features covered parking, community pool, and clubhouse. The HOA allows pets and your monthly fees include building & flood insurance, lawn land maintenance & pest control, plus water and trash removal. Fantastic location only minutes to shopping and dining in downtown Cape Coral. This move-in ready updated townhome is waiting for its new owner.", "SameAs": "https://www.cape-voyager.com/listings/M5215311859"}}]}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "ActionStatus": {"type": "string"}, "Result": {"type": "object", "properties": {"@type": {"type": "string"}, "DateModified": {"type": "string"}, "Creator": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Address": {"type": "object", "properties": {"@type": {"type": "string"}, "StreetAddress": {"type": "string"}, "PostalCode": {"type": "string"}, "AddressLocality": {"type": "string"}, "AddressCountry": {"type": "string"}}, "required": ["@type", "AddressCountry", "AddressLocality", "PostalCode", "StreetAddress"]}, "ContactPoint": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "EMail": {"type": "string"}}, "required": ["@type", "EMail", "Name"]}, "SameAs": {"type": "string"}}, "required": ["@type", "Address", "ContactPoint", "Name", "SameAs"]}, "Offers": {"type": "array", "items": {"type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@id": {"type": "string"}, "@type": {"type": "string"}, "Identifier": {"type": "string"}, "OfferedBy": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "JobTitle": {"type": "string"}, "WorksFor": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Telephone": {"type": "string"}, "Image": {"type": "object", "properties": {"@type": {"type": "string"}, "ContentUrl": {"type": "string"}}, "required": ["@type", "ContentUrl"]}}, "required": ["@type", "Image", "Name", "Telephone"]}}, "required": ["@type", "JobTitle", "Name", "WorksFor"]}, "Price": {"type": "integer"}, "PriceCurrency": {"type": "string"}, "PriceSpecification": {"type": "array", "items": {"type": "object", "properties": {"@type": {"type": "string"}, "Identifier": {"type": "string"}, "Name": {"type": "string"}, "Price": {"type": "integer"}, "PriceCurrency": {"type": "string"}}, "required": ["@type", "Identifier", "Name", "Price", "PriceCurrency"]}}, "Availability": {"type": "string"}, "AvailabilityStarts": {"type": "string"}, "BusinessFunction": {"type": "string"}, "ItemOffered": {"type": "object", "properties": {"@type": {"type": "string"}, "@id": {"type": "string"}, "YearBuilt": {"type": "integer"}, "FloorLevel": {"type": "null"}, "AmenityFeature": {"type": "array", "items": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Value": {"type": "array", "items": {"type": "string"}}, "ValueReference": {"type": "string"}}, "required": ["@type", "Name", "Value"]}}, "Keywords": {"type": "array", "items": {"type": "string"}}, "FloorSize": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Value": {"type": "integer"}, "UnitCode": {"type": "string"}, "UnitText": {"type": "string"}}, "required": ["@type", "Name", "UnitCode", "UnitText", "Value"]}, "NumberOfBathroomsTotal": {"type": "integer"}, "NumberOfBedrooms": {"type": "integer"}, "NumberOfFullBathrooms": {"type": "integer"}, "NumberOfPartialBathrooms": {"type": "integer"}, "PermittedUsage": {"type": "null"}, "PetsAllowed": {"type": "string"}, "Address": {"type": "object", "properties": {"@type": {"type": "string"}, "AddressCountry": {"type": "string"}, "AddressRegion": {"type": "string"}, "AddressLocality": {"type": "string"}, "PostalCode": {"type": "string"}, "StreetAddress": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}}, "required": ["@type", "AddressCountry", "AddressLocality", "AddressRegion", "Description", "Name", "PostalCode", "StreetAddress"]}, "Latitude": {"type": "number"}, "Longitude": {"type": "number"}, "Photo": {"type": "array", "items": {"type": "object", "properties": {"@type": {"type": "string"}, "Url": {"type": "string"}, "Keywords": {"type": "array", "items": {"type": "string"}}}, "required": ["@type", "Keywords", "Url"]}}, "Identifier": {"type": "string"}, "MainEntityOfPage": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}, "SameAs": {"type": "string"}}, "required": ["@id", "@type", "Address", "AmenityFeature", "Description", "FloorLevel", "FloorSize", "Identifier", "Keywords", "Latitude", "Longitude", "MainEntityOfPage", "Name", "NumberOfBathroomsTotal", "NumberOfBedrooms", "NumberOfFullBathrooms", "NumberOfPartialBathrooms", "PermittedUsage", "PetsAllowed", "Photo", "SameAs", "YearBuilt"]}}, "required": ["@context", "@id", "@type", "Availability", "AvailabilityStarts", "BusinessFunction", "Identifier", "ItemOffered", "OfferedBy", "Price", "PriceCurrency", "PriceSpecification"]}}}, "required": ["@type", "Creator", "DateModified", "Offers"]}}, "required": ["@context", "@type", "ActionStatus", "Result"]} |
959c1c72-e14e-4095-8acd-77cc5d66536d/57d5d3b9-ea97-45e6-bf38-aa93a59e97cd/0/0 | Florida Realty API | Find condos and townhouses in Florida (USA) and get access to the original listing service MLS with thousands of properties. | 8.4 | getCities | Get a list of supported cities with some data about those cities like the number of residents, the latitude, longitude, altitude and a description and image of the city. | 200 | List Of Cities | {"@context": ["http://schema4i.org/SearchAction.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/RealEstateListing.jsonld", "http://schema4i.org/WebPage.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ContactPoint.jsonld", "http://schema4i.org/StructuredValue.jsonld", "http://schema4i.org/ImageObject.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "SearchAction", "ActionStatus": "CompletedActionStatus", "Result": [{"@type": "City", "Identifier": "CAPECORAL", "Name": "Cape Coral", "Latitude": 26.562855, "Longitude": -81.949532, "Altitude": {"@type": "QuantitativeValue", "UnitCode": "MTR", "Value": 2}, "Description": [{"@value": "Cape Coral ist eine im S\u00fcdwesten Floridas gelegene Stadt, die f\u00fcr ihre zahlreichen Kan\u00e4le bekannt ist. Im Sirenia Vista Park sind Seek\u00fche heimisch. Kajakrouten f\u00fchren von dort aus in das Naturschutzgebiet Matlacha Pass Aquatic Preserve, in dessen Mangroven Watv\u00f6gel leben. Im Museum der Cape Coral Historical Society wird die Geschichte der Stadt nachverfolgt. Zum Yacht Club Community Park geh\u00f6ren ein Strand und ein Pier am Caloosahatchee River. Im Norden lockt das Naturschutzgebiet Four Mile Cove Ecological Preserve Reiher und Ibisse an.", "@language": "de"}, {"@value": "Cape Coral is a southwest Florida city known for its many canals. Manatees are native to Sirenia Vista Park. Kayak routes lead from there into the Matlacha Pass Aquatic Preserve, where wading birds live in the mangroves. The Cape Coral Historical Society Museum traces the city's history. The Yacht Club Community Park features a beach and pier on the Caloosahatchee River. To the north, the Four Mile Cove Ecological Preserve attracts herons and ibis.", "@language": "en"}], "NumberOfResidents": 194016, "SameAs": "https://www.capecoral.gov", "Photo": {"@type": "ImageObject", "EncodingFormat": "image/jpg", "ContentUrl": "https://florida-realty-api1.p.rapidapi.com/realty/cities/images/capecoral.jpg"}, "Address": {"@type": "PostalAddress", "AddressRegion": "Southwest Florida"}}, {"@type": "City", "Identifier": "FORTMYERS", "Name": "Fort Myers", "Latitude": 26.614149, "Longitude": -81.825768, "Altitude": {"@type": "QuantitativeValue", "UnitCode": "MTR", "Value": 3}, "Description": [{"@value": "Fort Myers ist eine Stadt und zudem der County Seat des Lee County im US-Bundesstaat Florida. Das U.S. Census Bureau hat bei der Volksz\u00e4hlung 2020 eine Einwohnerzahl von 86.395 ermittelt.", "@language": "de"}, {"@value": "Fort Myers is a city and also the county seat of Lee County in the US state of Florida. The US The Census Bureau recorded a population of 86,395 as of the 2020 census.", "@language": "en"}], "NumberOfResidents": 86395, "SameAs": "https://www.cityftmyers.com", "Photo": {"@type": "ImageObject", "EncodingFormat": "image/jpg", "ContentUrl": "https://florida-realty-api1.p.rapidapi.com/realty/cities/images/fortmyers.jpg"}, "Address": {"@type": "PostalAddress", "AddressRegion": "Southwest Florida"}}, {"@type": "City", "Identifier": "NAPLES", "Name": "Naples", "Latitude": 26.142036, "Longitude": -81.794807, "Altitude": {"@type": "QuantitativeValue", "UnitCode": "MTR", "Value": 1}, "Description": [{"@value": "Naples ist eine Stadt am Golf von Mexiko im S\u00fcdwesten von Florida, die f\u00fcr exklusive Gesch\u00e4fte und Golfpl\u00e4tze bekannt ist. Der Naples Pier, der im Jahr 1888 erbaut wurde, ist das Wahrzeichen der Stadt und ein beliebter Ort zum Angeln und zum Beobachten von Delfinen. Er ist von kilometerlangen Str\u00e4nden mit ruhigem Wasser und Puderzuckersand umgeben, darunter die Str\u00e4nde im Clam Pass Park und im Delnor-Wiggins Pass State Park.", "@language": "de"}, {"@value": "Naples is a Gulf of Mexico city in Southwest Florida known for upscale shopping and golf courses. The Naples Pier, built in 1888, is the city's landmark and a popular spot for fishing and dolphin watching. It is surrounded by miles of calm water beaches and powdered sugar sand, including beaches at Clam Pass Park and Delnor-Wiggins Pass State Park.", "@language": "en"}], "NumberOfResidents": 19115, "SameAs": "https://www.naplesgov.com", "Photo": {"@type": "ImageObject", "EncodingFormat": "image/jpg", "ContentUrl": "https://florida-realty-api1.p.rapidapi.com/realty/cities/images/naples.jpg"}, "Address": {"@type": "PostalAddress", "AddressRegion": "Southwest Florida"}}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "ActionStatus": {"type": "string"}, "Result": {"type": "array", "items": {"type": "object", "properties": {"@type": {"type": "string"}, "Identifier": {"type": "string"}, "Name": {"type": "string"}, "Latitude": {"type": "number"}, "Longitude": {"type": "number"}, "Altitude": {"type": "object", "properties": {"@type": {"type": "string"}, "UnitCode": {"type": "string"}, "Value": {"type": "integer"}}, "required": ["@type", "UnitCode", "Value"]}, "Description": {"type": "array", "items": {"type": "object", "properties": {"@value": {"type": "string"}, "@language": {"type": "string"}}, "required": ["@language", "@value"]}}, "NumberOfResidents": {"type": "integer"}, "SameAs": {"type": "string"}, "Photo": {"type": "object", "properties": {"@type": {"type": "string"}, "EncodingFormat": {"type": "string"}, "ContentUrl": {"type": "string"}}, "required": ["@type", "ContentUrl", "EncodingFormat"]}, "Address": {"type": "object", "properties": {"@type": {"type": "string"}, "AddressRegion": {"type": "string"}}, "required": ["@type", "AddressRegion"]}}, "required": ["@type", "Address", "Altitude", "Description", "Identifier", "Latitude", "Longitude", "Name", "NumberOfResidents", "Photo", "SameAs"]}}}, "required": ["@context", "@type", "ActionStatus", "Result"]} |
959c1c72-e14e-4095-8acd-77cc5d66536d/3dd8a79a-a25a-4d55-9dc5-106f35aa35ba/0/0 | Florida Realty API | Find condos and townhouses in Florida (USA) and get access to the original listing service MLS with thousands of properties. | 8.4 | getListings | Use this endpoint to retrieve a list of condominiums and townhouses in Southwest Florida and on the East Coast. | 400 | Unsupported cities | {"@context": ["http://schema4i.org/SearchAction.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "Action", "ActionStatus": "FailedActionStatus", "Error": {"@type": "Thing", "Name": "An error occured.", "Description": "Supported cities CAPE CORAL,FORT MYERS,WEST PALM BEACH,LAKE WORTH,LANTANA,BOYNTON BEACH,DELRAY BEACH,BOCA RATON,POMPANO BEACH,FORT LAUDERDALE."}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "ActionStatus": {"type": "string"}, "Error": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}}, "required": ["@type", "Description", "Name"]}}, "required": ["@context", "@type", "ActionStatus", "Error"]} |
959c1c72-e14e-4095-8acd-77cc5d66536d/3dd8a79a-a25a-4d55-9dc5-106f35aa35ba/1/0 | Florida Realty API | Find condos and townhouses in Florida (USA) and get access to the original listing service MLS with thousands of properties. | 8.4 | getListings | Use this endpoint to retrieve a list of condominiums and townhouses in Southwest Florida and on the East Coast. | 200 | List of properties with 1 item | {"@context": ["http://schema4i.org/SearchAction.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/RealEstateListing.jsonld", "http://schema4i.org/WebPage.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ContactPoint.jsonld", "http://schema4i.org/StructuredValue.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "SearchAction", "ActionStatus": "CompletedActionStatus", "Result": {"@type": "RealEstateListing", "Creator": {"@type": "Organization", "Name": "X-PLOR GmbH", "Address": {"@type": "PostalAddress", "StreetAddress": "Lindenstr. 48-52", "PostalCode": "40233", "AddressLocality": "Duesseldorf", "AddressCountry": "D"}, "ContactPoint": {"@type": "ContactPoint", "Name": "Sales", "EMail": "[email protected]"}, "SameAs": "https://www.x-plor.de"}, "Offers": [{"@context": ["http://schema4i.org/OfferForPurchase.jsonld", "http://schema4i.org/Offer.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/Person.jsonld", "http://schema4i.org/SingleFamilyResidence.jsonld", "http://schema4i.org/Apartment.jsonld", "http://schema4i.org/Accommodation.jsonld", "http://schema4i.org/Place.jsonld", "http://schema4i.org/LocationFeatureSpecification.jsonld", "http://schema4i.org/QuantitativeValue.jsonld", "http://schema4i.org/StructuredValue.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ImageObject.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "OfferForPurchase", "@id": "https://api.x-plor.de/data/listings/M5215311859", "Identifier": "M5215311859", "OfferedBy": {"@type": "Person", "Name": "Parker Keevican", "JobTitle": "Realtor", "WorksFor": {"@type": "Organization", "Name": "Keller Williams Realty Naples"}}, "Price": 220000, "PriceCurrency": "USD", "Availability": "InStock", "BusinessFunction": "http://purl.org/goodrelations/v1#Sell", "ItemOffered": {"@type": "SingleFamilyResidence", "@id": "#M5215311859", "FloorLevel": null, "AmenityFeature": [], "FloorSize": {"@type": "QuantitativeValue", "Name": "Size", "Value": 886, "UnitCode": "FTK", "UnitText": "sqft"}, "NumberOfBathroomsTotal": 2, "NumberOfBedrooms": 2, "NumberOfFullBathrooms": 1, "NumberOfPartialBathrooms": 1, "PetsAllowed": null, "Address": {"@type": "PostalAddress", "AddressCountry": "USA", "AddressRegion": "Lee", "AddressLocality": "Cape Coral", "PostalCode": "33914", "StreetAddress": "4520 SW 8th Pl Apt 1", "Name": "4520 SW 8th Pl Apt 1, Cape Coral, FL 33914, USA", "Description": "Neighborhood Pelican"}, "Latitude": 26.567657, "Longitude": -81.992067, "Photo": [{"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2627801851x.jpg"}], "Identifier": "MLS 222083493", "Name": "2 Bed, 2 Bath, 886 sqft", "SameAs": "https://www.cape-voyager.com/listings/M5215311859"}, "PotentialAction": [{"@context": ["http://schema4i.org/Thing.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/SearchAction", "http://schema4i.org/EntryPoint.jsonld"], "@type": "SearchAction", "Identifier": "getProperty", "Name": "Get listing by ID", "Description": "Returns a single listing by its id.", "Target": {"@type": "EntryPoint", "URLTemplate": "https://api.x-plor.de/data/listings/2950154673", "HTTPMethod": "GET", "ContentType": "application/ld+json"}}]}]}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "ActionStatus": {"type": "string"}, "Result": {"type": "object", "properties": {"@type": {"type": "string"}, "Creator": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Address": {"type": "object", "properties": {"@type": {"type": "string"}, "StreetAddress": {"type": "string"}, "PostalCode": {"type": "string"}, "AddressLocality": {"type": "string"}, "AddressCountry": {"type": "string"}}, "required": ["@type", "AddressCountry", "AddressLocality", "PostalCode", "StreetAddress"]}, "ContactPoint": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "EMail": {"type": "string"}}, "required": ["@type", "EMail", "Name"]}, "SameAs": {"type": "string"}}, "required": ["@type", "Address", "ContactPoint", "Name", "SameAs"]}, "Offers": {"type": "array", "items": {"type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "@id": {"type": "string"}, "Identifier": {"type": "string"}, "OfferedBy": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "JobTitle": {"type": "string"}, "WorksFor": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}}, "required": ["@type", "Name"]}}, "required": ["@type", "JobTitle", "Name", "WorksFor"]}, "Price": {"type": "integer"}, "PriceCurrency": {"type": "string"}, "Availability": {"type": "string"}, "BusinessFunction": {"type": "string"}, "ItemOffered": {"type": "object", "properties": {"@type": {"type": "string"}, "@id": {"type": "string"}, "FloorLevel": {"type": "null"}, "AmenityFeature": {"type": "array"}, "FloorSize": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Value": {"type": "integer"}, "UnitCode": {"type": "string"}, "UnitText": {"type": "string"}}, "required": ["@type", "Name", "UnitCode", "UnitText", "Value"]}, "NumberOfBathroomsTotal": {"type": "integer"}, "NumberOfBedrooms": {"type": "integer"}, "NumberOfFullBathrooms": {"type": "integer"}, "NumberOfPartialBathrooms": {"type": "integer"}, "PetsAllowed": {"type": "null"}, "Address": {"type": "object", "properties": {"@type": {"type": "string"}, "AddressCountry": {"type": "string"}, "AddressRegion": {"type": "string"}, "AddressLocality": {"type": "string"}, "PostalCode": {"type": "string"}, "StreetAddress": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}}, "required": ["@type", "AddressCountry", "AddressLocality", "AddressRegion", "Description", "Name", "PostalCode", "StreetAddress"]}, "Latitude": {"type": "number"}, "Longitude": {"type": "number"}, "Photo": {"type": "array", "items": {"type": "object", "properties": {"@type": {"type": "string"}, "Url": {"type": "string"}}, "required": ["@type", "Url"]}}, "Identifier": {"type": "string"}, "Name": {"type": "string"}, "SameAs": {"type": "string"}}, "required": ["@id", "@type", "Address", "AmenityFeature", "FloorLevel", "FloorSize", "Identifier", "Latitude", "Longitude", "Name", "NumberOfBathroomsTotal", "NumberOfBedrooms", "NumberOfFullBathrooms", "NumberOfPartialBathrooms", "PetsAllowed", "Photo", "SameAs"]}, "PotentialAction": {"type": "array", "items": {"type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "Identifier": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}, "Target": {"type": "object", "properties": {"@type": {"type": "string"}, "URLTemplate": {"type": "string"}, "HTTPMethod": {"type": "string"}, "ContentType": {"type": "string"}}, "required": ["@type", "ContentType", "HTTPMethod", "URLTemplate"]}}, "required": ["@context", "@type", "Description", "Identifier", "Name", "Target"]}}}, "required": ["@context", "@id", "@type", "Availability", "BusinessFunction", "Identifier", "ItemOffered", "OfferedBy", "PotentialAction", "Price", "PriceCurrency"]}}}, "required": ["@type", "Creator", "Offers"]}}, "required": ["@context", "@type", "ActionStatus", "Result"]} |
959c1c72-e14e-4095-8acd-77cc5d66536d/3dd8a79a-a25a-4d55-9dc5-106f35aa35ba/1/1 | Florida Realty API | Find condos and townhouses in Florida (USA) and get access to the original listing service MLS with thousands of properties. | 8.4 | getListings | Use this endpoint to retrieve a list of condominiums and townhouses in Southwest Florida and on the East Coast. | 200 | List of properties with 2 items | {"@context": ["http://schema4i.org/SearchAction.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/RealEstateListing.jsonld", "http://schema4i.org/WebPage.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ContactPoint.jsonld", "http://schema4i.org/StructuredValue.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "SearchAction", "ActionStatus": "CompletedActionStatus", "Result": {"@type": "RealEstateListing", "Creator": {"@type": "Organization", "Name": "X-PLOR GmbH", "Address": {"@type": "PostalAddress", "StreetAddress": "Lindenstr. 48-52", "PostalCode": "40233", "AddressLocality": "Duesseldorf", "AddressCountry": "D"}, "ContactPoint": {"@type": "ContactPoint", "Name": "Sales", "EMail": "[email protected]"}, "SameAs": "https://www.x-plor.de"}, "Offers": [{"@context": ["http://schema4i.org/OfferForPurchase.jsonld", "http://schema4i.org/Offer.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/Person.jsonld", "http://schema4i.org/SingleFamilyResidence.jsonld", "http://schema4i.org/Apartment.jsonld", "http://schema4i.org/Accommodation.jsonld", "http://schema4i.org/Place.jsonld", "http://schema4i.org/LocationFeatureSpecification.jsonld", "http://schema4i.org/QuantitativeValue.jsonld", "http://schema4i.org/StructuredValue.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ImageObject.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "OfferForPurchase", "@id": "https://api.x-plor.de/data/listings/M5215311859", "Identifier": "M5215311859", "OfferedBy": {"@type": "Person", "Name": "Parker Keevican", "JobTitle": "Realtor", "WorksFor": {"@type": "Organization", "Name": "Keller Williams Realty Naples"}}, "Price": 220000, "PriceCurrency": "USD", "Availability": "InStock", "BusinessFunction": "http://purl.org/goodrelations/v1#Sell", "ItemOffered": {"@type": "SingleFamilyResidence", "@id": "#M5215311859", "FloorLevel": null, "AmenityFeature": [], "FloorSize": {"@type": "QuantitativeValue", "Name": "Size", "Value": 886, "UnitCode": "FTK", "UnitText": "sqft"}, "NumberOfBathroomsTotal": 2, "NumberOfBedrooms": 2, "NumberOfFullBathrooms": 1, "NumberOfPartialBathrooms": 1, "PetsAllowed": null, "Address": {"@type": "PostalAddress", "AddressCountry": "USA", "AddressRegion": "Lee", "AddressLocality": "Cape Coral", "PostalCode": "33914", "StreetAddress": "4520 SW 8th Pl Apt 1", "Name": "4520 SW 8th Pl Apt 1, Cape Coral, FL 33914, USA", "Description": "Neighborhood Pelican"}, "Latitude": 26.567657, "Longitude": -81.992067, "Photo": [{"@type": "ImageObject", "Url": "https://ap.rdcpix.com/0070e60adaff0f26e903ad5d31844a07l-m2627801851x.jpg"}], "Identifier": "MLS 222083493", "Name": "2 Bed, 2 Bath, 886 sqft", "SameAs": "https://www.cape-voyager.com/listings/M5215311859"}, "PotentialAction": [{"@context": ["http://schema4i.org/Thing.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/SearchAction", "http://schema4i.org/EntryPoint.jsonld"], "@type": "SearchAction", "Identifier": "getProperty", "Name": "Get listing by ID", "Description": "Returns a single listing by its id.", "Target": {"@type": "EntryPoint", "URLTemplate": "https://api.x-plor.de/data/listings/2950154673", "HTTPMethod": "GET", "ContentType": "application/ld+json"}}]}, {"@context": ["http://schema4i.org/OfferForPurchase.jsonld", "http://schema4i.org/Offer.jsonld", "http://schema4i.org/Organization.jsonld", "http://schema4i.org/Person.jsonld", "http://schema4i.org/SingleFamilyResidence.jsonld", "http://schema4i.org/Apartment.jsonld", "http://schema4i.org/Accommodation.jsonld", "http://schema4i.org/Place.jsonld", "http://schema4i.org/LocationFeatureSpecification.jsonld", "http://schema4i.org/QuantitativeValue.jsonld", "http://schema4i.org/StructuredValue.jsonld", "http://schema4i.org/PostalAddress.jsonld", "http://schema4i.org/ImageObject.jsonld", "http://schema4i.org/CreativeWork.jsonld", "http://schema4i.org/Thing.jsonld"], "@type": "OfferForPurchase", "@id": "https://api.x-plor.de/data/listings/M5810593900", "Identifier": "M5810593900", "OfferedBy": {"@type": "Person", "Name": "Rene Ferrell", "JobTitle": "Realtor", "WorksFor": {"@type": "Organization", "Name": "EXP Realty, LLC"}}, "Price": 200000, "PriceCurrency": "USD", "Availability": "LimitedAvailability", "BusinessFunction": "http://purl.org/goodrelations/v1#Sell", "ItemOffered": {"@type": "Apartment", "@id": "#M5810593900", "FloorLevel": null, "AmenityFeature": [], "FloorSize": {"@type": "QuantitativeValue", "Name": "Size", "Value": 953, "UnitCode": "FTK", "UnitText": "sqft"}, "NumberOfBathroomsTotal": 2, "NumberOfBedrooms": 2, "NumberOfFullBathrooms": 2, "PetsAllowed": null, "Address": {"@type": "PostalAddress", "AddressCountry": "USA", "AddressRegion": "Lee", "AddressLocality": "Cape Coral", "PostalCode": "33914", "StreetAddress": "1510 SW Courtyards Ln Apt 151", "Name": "1510 SW Courtyards Ln Apt 151, Cape Coral, FL 33914, USA", "Description": "Neighborhood Pelican"}, "Latitude": 26.556339, "Longitude": -82.004648, "Photo": [{"@type": "ImageObject", "Url": "https://ap.rdcpix.com/fadbef68ba2a21f3e39459a5e2d39865l-m3509830493x.jpg"}], "Identifier": "MLS 222080695", "Name": "2 Bed, 2 Bath, 953 sqft", "SameAs": "https://www.cape-voyager.com/listings/M5810593900"}, "PotentialAction": [{"@context": ["http://schema4i.org/Thing.jsonld", "http://schema4i.org/Action.jsonld", "http://schema4i.org/SearchAction", "http://schema4i.org/EntryPoint.jsonld"], "@type": "SearchAction", "Identifier": "getProperty", "Name": "Get listing by ID", "Description": "Returns a single listing by its id.", "Target": {"@type": "EntryPoint", "URLTemplate": "https://api.x-plor.de/data/listings/2950100335", "HTTPMethod": "GET", "ContentType": "application/ld+json"}}]}]}} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "ActionStatus": {"type": "string"}, "Result": {"type": "object", "properties": {"@type": {"type": "string"}, "Creator": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Address": {"type": "object", "properties": {"@type": {"type": "string"}, "StreetAddress": {"type": "string"}, "PostalCode": {"type": "string"}, "AddressLocality": {"type": "string"}, "AddressCountry": {"type": "string"}}, "required": ["@type", "AddressCountry", "AddressLocality", "PostalCode", "StreetAddress"]}, "ContactPoint": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "EMail": {"type": "string"}}, "required": ["@type", "EMail", "Name"]}, "SameAs": {"type": "string"}}, "required": ["@type", "Address", "ContactPoint", "Name", "SameAs"]}, "Offers": {"type": "array", "items": {"type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "@id": {"type": "string"}, "Identifier": {"type": "string"}, "OfferedBy": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "JobTitle": {"type": "string"}, "WorksFor": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}}, "required": ["@type", "Name"]}}, "required": ["@type", "JobTitle", "Name", "WorksFor"]}, "Price": {"type": "integer"}, "PriceCurrency": {"type": "string"}, "Availability": {"type": "string"}, "BusinessFunction": {"type": "string"}, "ItemOffered": {"type": "object", "properties": {"@type": {"type": "string"}, "@id": {"type": "string"}, "FloorLevel": {"type": "null"}, "AmenityFeature": {"type": "array"}, "FloorSize": {"type": "object", "properties": {"@type": {"type": "string"}, "Name": {"type": "string"}, "Value": {"type": "integer"}, "UnitCode": {"type": "string"}, "UnitText": {"type": "string"}}, "required": ["@type", "Name", "UnitCode", "UnitText", "Value"]}, "NumberOfBathroomsTotal": {"type": "integer"}, "NumberOfBedrooms": {"type": "integer"}, "NumberOfFullBathrooms": {"type": "integer"}, "NumberOfPartialBathrooms": {"type": "integer"}, "PetsAllowed": {"type": "null"}, "Address": {"type": "object", "properties": {"@type": {"type": "string"}, "AddressCountry": {"type": "string"}, "AddressRegion": {"type": "string"}, "AddressLocality": {"type": "string"}, "PostalCode": {"type": "string"}, "StreetAddress": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}}, "required": ["@type", "AddressCountry", "AddressLocality", "AddressRegion", "Description", "Name", "PostalCode", "StreetAddress"]}, "Latitude": {"type": "number"}, "Longitude": {"type": "number"}, "Photo": {"type": "array", "items": {"type": "object", "properties": {"@type": {"type": "string"}, "Url": {"type": "string"}}, "required": ["@type", "Url"]}}, "Identifier": {"type": "string"}, "Name": {"type": "string"}, "SameAs": {"type": "string"}}, "required": ["@id", "@type", "Address", "AmenityFeature", "FloorLevel", "FloorSize", "Identifier", "Latitude", "Longitude", "Name", "NumberOfBathroomsTotal", "NumberOfBedrooms", "NumberOfFullBathrooms", "PetsAllowed", "Photo", "SameAs"]}, "PotentialAction": {"type": "array", "items": {"type": "object", "properties": {"@context": {"type": "array", "items": {"type": "string"}}, "@type": {"type": "string"}, "Identifier": {"type": "string"}, "Name": {"type": "string"}, "Description": {"type": "string"}, "Target": {"type": "object", "properties": {"@type": {"type": "string"}, "URLTemplate": {"type": "string"}, "HTTPMethod": {"type": "string"}, "ContentType": {"type": "string"}}, "required": ["@type", "ContentType", "HTTPMethod", "URLTemplate"]}}, "required": ["@context", "@type", "Description", "Identifier", "Name", "Target"]}}}, "required": ["@context", "@id", "@type", "Availability", "BusinessFunction", "Identifier", "ItemOffered", "OfferedBy", "PotentialAction", "Price", "PriceCurrency"]}}}, "required": ["@type", "Creator", "Offers"]}}, "required": ["@context", "@type", "ActionStatus", "Result"]} |
b96049f2-a1e2-44b1-89aa-5d27f5916eed/34988639-3d7f-4b0d-96a3-fc8af04b7e18/3/0 | NY Times - Times wire | NY Times - Times wire | null | /content/{source}/{section}.json | 200 | null | {"status": "", "copyright": "", "num_results": 0, "results": [{"section": "", "subsection": "", "title": "", "abstract": "", "uri": "", "url": "", "short_url": "", "byline": "", "thumbnail_standard": "", "item_type": "", "source": "", "updated_date": "", "created_date": "", "published_date": "", "material_type_facet": "", "kicker": "", "headline": "", "des_facet": [], "org_facet": "", "per_facet": [], "geo_facet": [], "blog_name": "", "related_urls": [{"suggested_link_text": "", "url": ""}], "multimedia": [{"url": "", "format": "", "height": 0, "width": 0, "type": "", "subtype": "", "caption": "", "copyright": ""}]}]} | {"type": "object", "properties": {"status": {"type": "string"}, "copyright": {"type": "string"}, "num_results": {"type": "integer"}, "results": {"type": "array", "items": {"type": "object", "properties": {"section": {"type": "string"}, "subsection": {"type": "string"}, "title": {"description": "Article headline.", "type": "string"}, "abstract": {"description": "Article summary.", "type": "string"}, "uri": {"description": "Uniquely identifies an article.", "type": "string"}, "url": {"description": "Article URL.", "type": "string"}, "short_url": {"type": "string"}, "byline": {"type": "string"}, "thumbnail_standard": {"type": "string"}, "item_type": {"type": "string"}, "source": {"type": "string"}, "updated_date": {"type": "string"}, "created_date": {"type": "string"}, "published_date": {"type": "string"}, "material_type_facet": {"type": "string"}, "kicker": {"type": "string"}, "headline": {"type": "string"}, "des_facet": {"type": "array", "items": {"type": "string"}}, "org_facet": {"type": "string"}, "per_facet": {"type": "array", "items": {"type": "string"}}, "geo_facet": {"type": "array", "items": {"type": "string"}}, "blog_name": {"type": "string"}, "related_urls": {"type": "array", "items": {"type": "object", "properties": {"suggested_link_text": {"type": "string"}, "url": {"type": "string"}}}}, "multimedia": {"type": "array", "items": {"type": "object", "properties": {"url": {"type": "string"}, "format": {"type": "string"}, "height": {"type": "integer"}, "width": {"type": "integer"}, "type": {"type": "string"}, "subtype": {"type": "string"}, "caption": {"type": "string"}, "copyright": {"type": "string"}}}}}}}}} |
|
b96049f2-a1e2-44b1-89aa-5d27f5916eed/37c7b8c4-437f-4877-9805-e8e23b6a836a/2/0 | NY Times - Times wire | NY Times - Times wire | null | /content/section-list.json | 200 | null | {"status": "", "copyright": "", "num_results": 0, "results": [{"section": "", "display_name": ""}]} | {"type": "object", "properties": {"status": {"type": "string"}, "copyright": {"type": "string"}, "num_results": {"type": "integer"}, "results": {"type": "array", "items": {"type": "object", "properties": {"section": {"type": "string"}, "display_name": {"type": "string"}}}}}} |
|
b96049f2-a1e2-44b1-89aa-5d27f5916eed/a70f6d48-7a4e-463a-8621-209e71b836fc/1/0 | NY Times - Times wire | NY Times - Times wire | null | /content.json | 200 | null | {"status": "", "copyright": "", "num_results": 0, "results": [{"section": "", "subsection": "", "title": "", "abstract": "", "uri": "", "url": "", "short_url": "", "byline": "", "thumbnail_standard": "", "item_type": "", "source": "", "updated_date": "", "created_date": "", "published_date": "", "material_type_facet": "", "kicker": "", "headline": "", "des_facet": [], "org_facet": "", "per_facet": [], "geo_facet": [], "blog_name": "", "related_urls": [{"suggested_link_text": "", "url": ""}], "multimedia": [{"url": "", "format": "", "height": 0, "width": 0, "type": "", "subtype": "", "caption": "", "copyright": ""}]}]} | {"type": "object", "properties": {"status": {"type": "string"}, "copyright": {"type": "string"}, "num_results": {"type": "integer"}, "results": {"type": "array", "items": {"type": "object", "properties": {"section": {"type": "string"}, "subsection": {"type": "string"}, "title": {"description": "Article headline.", "type": "string"}, "abstract": {"description": "Article summary.", "type": "string"}, "uri": {"description": "Uniquely identifies an article.", "type": "string"}, "url": {"description": "Article URL.", "type": "string"}, "short_url": {"type": "string"}, "byline": {"type": "string"}, "thumbnail_standard": {"type": "string"}, "item_type": {"type": "string"}, "source": {"type": "string"}, "updated_date": {"type": "string"}, "created_date": {"type": "string"}, "published_date": {"type": "string"}, "material_type_facet": {"type": "string"}, "kicker": {"type": "string"}, "headline": {"type": "string"}, "des_facet": {"type": "array", "items": {"type": "string"}}, "org_facet": {"type": "string"}, "per_facet": {"type": "array", "items": {"type": "string"}}, "geo_facet": {"type": "array", "items": {"type": "string"}}, "blog_name": {"type": "string"}, "related_urls": {"type": "array", "items": {"type": "object", "properties": {"suggested_link_text": {"type": "string"}, "url": {"type": "string"}}}}, "multimedia": {"type": "array", "items": {"type": "object", "properties": {"url": {"type": "string"}, "format": {"type": "string"}, "height": {"type": "integer"}, "width": {"type": "integer"}, "type": {"type": "string"}, "subtype": {"type": "string"}, "caption": {"type": "string"}, "copyright": {"type": "string"}}}}}}}}} |
|
09c4e766-38a8-475f-8617-82569f06fd97/b03115aa-14c4-41ed-98ab-c08e0bd3f9dc/0/0 | Etsy | The Etsy API provides a simple RESTful interface with lightweight JSON-formatted responses to use many of Etsy's website features, including public profiles | null | getListingImages | Retrieves all listing image resources for a listing with a specific listing ID. | 200 | Response | {"count": 10, "results": [{"listing_id": 1005174422, "listing_image_id": 3129369537, "hex_code": "775F52", "red": 119, "green": 95, "blue": 82, "hue": 21, "saturation": 31, "brightness": 46, "is_black_and_white": false, "creation_tsz": 1621001750, "rank": 1, "url_75x75": "https://i.etsystatic.com/18372436/c/2552/2029/21/545/il/b3f6a2/3129369537/il_75x75.3129369537_sa9s.jpg", "url_170x135": "https://i.etsystatic.com/18372436/c/2552/2029/21/545/il/b3f6a2/3129369537/il_170x135.3129369537_sa9s.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/b3f6a2/3129369537/il_570xN.3129369537_sa9s.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/b3f6a2/3129369537/il_fullxfull.3129369537_sa9s.jpg", "full_height": 2808, "full_width": 2808}, {"listing_id": 1005174422, "listing_image_id": 3081641204, "hex_code": "9C9289", "red": 156, "green": 146, "blue": 137, "hue": 28, "saturation": 12, "brightness": 61, "is_black_and_white": false, "creation_tsz": 1621001750, "rank": 2, "url_75x75": "https://i.etsystatic.com/18372436/r/il/414919/3081641204/il_75x75.3081641204_7ydz.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/414919/3081641204/il_170x135.3081641204_7ydz.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/414919/3081641204/il_570xN.3081641204_7ydz.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/414919/3081641204/il_fullxfull.3081641204_7ydz.jpg", "full_height": 3000, "full_width": 3000}, {"listing_id": 1005174422, "listing_image_id": 3129368529, "hex_code": "BBB6A5", "red": 187, "green": 182, "blue": 165, "hue": 46, "saturation": 11, "brightness": 73, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 3, "url_75x75": "https://i.etsystatic.com/18372436/r/il/ca7841/3129368529/il_75x75.3129368529_nd2a.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/ca7841/3129368529/il_170x135.3129368529_nd2a.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/ca7841/3129368529/il_570xN.3129368529_nd2a.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/ca7841/3129368529/il_fullxfull.3129368529_nd2a.jpg", "full_height": 3000, "full_width": 3000}, {"listing_id": 1005174422, "listing_image_id": 3129368561, "hex_code": "B8AEA0", "red": 184, "green": 174, "blue": 160, "hue": 35, "saturation": 13, "brightness": 72, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 4, "url_75x75": "https://i.etsystatic.com/18372436/r/il/0512a3/3129368561/il_75x75.3129368561_yjyg.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/0512a3/3129368561/il_170x135.3129368561_yjyg.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/0512a3/3129368561/il_570xN.3129368561_yjyg.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/0512a3/3129368561/il_fullxfull.3129368561_yjyg.jpg", "full_height": 2812, "full_width": 2812}, {"listing_id": 1005174422, "listing_image_id": 3129368857, "hex_code": "7B6557", "red": 123, "green": 101, "blue": 87, "hue": 23, "saturation": 29, "brightness": 48, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 5, "url_75x75": "https://i.etsystatic.com/18372436/r/il/e4a3fc/3129368857/il_75x75.3129368857_auqv.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/e4a3fc/3129368857/il_170x135.3129368857_auqv.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/e4a3fc/3129368857/il_570xN.3129368857_auqv.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/e4a3fc/3129368857/il_fullxfull.3129368857_auqv.jpg", "full_height": 3000, "full_width": 3000}, {"listing_id": 1005174422, "listing_image_id": 3129368863, "hex_code": "897667", "red": 137, "green": 118, "blue": 103, "hue": 26, "saturation": 24, "brightness": 53, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 6, "url_75x75": "https://i.etsystatic.com/18372436/r/il/51a364/3129368863/il_75x75.3129368863_qric.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/51a364/3129368863/il_170x135.3129368863_qric.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/51a364/3129368863/il_570xN.3129368863_qric.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/51a364/3129368863/il_fullxfull.3129368863_qric.jpg", "full_height": 2722, "full_width": 2722}, {"listing_id": 1005174422, "listing_image_id": 3129369011, "hex_code": "939697", "red": 147, "green": 150, "blue": 151, "hue": 195, "saturation": 2, "brightness": 59, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 7, "url_75x75": "https://i.etsystatic.com/18372436/r/il/7f634a/3129369011/il_75x75.3129369011_3zcu.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/7f634a/3129369011/il_170x135.3129369011_3zcu.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/7f634a/3129369011/il_570xN.3129369011_3zcu.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/7f634a/3129369011/il_fullxfull.3129369011_3zcu.jpg", "full_height": 2616, "full_width": 2616}, {"listing_id": 1005174422, "listing_image_id": 3081642344, "hex_code": "A6945C", "red": 166, "green": 148, "blue": 92, "hue": 45, "saturation": 44, "brightness": 65, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 8, "url_75x75": "https://i.etsystatic.com/18372436/r/il/01bd34/3081642344/il_75x75.3081642344_n1cf.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/01bd34/3081642344/il_170x135.3081642344_n1cf.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/01bd34/3081642344/il_570xN.3081642344_n1cf.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/01bd34/3081642344/il_fullxfull.3081642344_n1cf.jpg", "full_height": 3000, "full_width": 3000}, {"listing_id": 1005174422, "listing_image_id": 3081642424, "hex_code": "BE8F76", "red": 190, "green": 143, "blue": 118, "hue": 21, "saturation": 37, "brightness": 74, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 9, "url_75x75": "https://i.etsystatic.com/18372436/r/il/503ad0/3081642424/il_75x75.3081642424_ibfo.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/503ad0/3081642424/il_170x135.3081642424_ibfo.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/503ad0/3081642424/il_570xN.3081642424_ibfo.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/503ad0/3081642424/il_fullxfull.3081642424_ibfo.jpg", "full_height": 3000, "full_width": 3000}, {"listing_id": 1005174422, "listing_image_id": 3081642244, "hex_code": "8E827E", "red": 142, "green": 130, "blue": 126, "hue": 15, "saturation": 11, "brightness": 55, "is_black_and_white": false, "creation_tsz": 1621001751, "rank": 10, "url_75x75": "https://i.etsystatic.com/18372436/r/il/00ff30/3081642244/il_75x75.3081642244_tq6l.jpg", "url_170x135": "https://i.etsystatic.com/18372436/r/il/00ff30/3081642244/il_170x135.3081642244_tq6l.jpg", "url_570xN": "https://i.etsystatic.com/18372436/r/il/00ff30/3081642244/il_570xN.3081642244_tq6l.jpg", "url_fullxfull": "https://i.etsystatic.com/18372436/r/il/00ff30/3081642244/il_fullxfull.3081642244_tq6l.jpg", "full_height": 2336, "full_width": 2336}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"count": {"type": "integer"}, "results": {"type": "array", "items": {"type": "object", "properties": {"listing_id": {"type": "integer"}, "listing_image_id": {"type": "integer"}, "hex_code": {"type": "string"}, "red": {"type": "integer"}, "green": {"type": "integer"}, "blue": {"type": "integer"}, "hue": {"type": "integer"}, "saturation": {"type": "integer"}, "brightness": {"type": "integer"}, "is_black_and_white": {"type": "boolean"}, "creation_tsz": {"type": "integer"}, "rank": {"type": "integer"}, "url_75x75": {"type": "string"}, "url_170x135": {"type": "string"}, "url_570xN": {"type": "string"}, "url_fullxfull": {"type": "string"}, "full_height": {"type": "integer"}, "full_width": {"type": "integer"}}, "required": ["blue", "brightness", "creation_tsz", "full_height", "full_width", "green", "hex_code", "hue", "is_black_and_white", "listing_id", "listing_image_id", "rank", "red", "saturation", "url_170x135", "url_570xN", "url_75x75", "url_fullxfull"]}}}, "required": ["count", "results"]} |
09c4e766-38a8-475f-8617-82569f06fd97/59cb1ce5-fdc8-45dd-a48a-15df65cd41f1/0/0 | Etsy | The Etsy API provides a simple RESTful interface with lightweight JSON-formatted responses to use many of Etsy's website features, including public profiles | null | getPropertiesByTaxonomyId | Retrieves a list of product properties, with applicable scales and values, supported for a specific seller taxonomy ID. | 200 | Response | {"count": 21, "results": [{"property_id": 200, "name": "Primary color", "display_name": "Primary color", "scales": [], "is_required": false, "supports_attributes": true, "supports_variations": true, "is_multivalued": false, "possible_values": [{"value_id": 1213, "name": "Beige", "scale_id": null, "equal_to": []}, {"value_id": 1, "name": "Black", "scale_id": null, "equal_to": []}, {"value_id": 2, "name": "Blue", "scale_id": null, "equal_to": []}, {"value_id": 1216, "name": "Bronze", "scale_id": null, "equal_to": []}, {"value_id": 3, "name": "Brown", "scale_id": null, "equal_to": []}, {"value_id": 1219, "name": "Clear", "scale_id": null, "equal_to": []}, {"value_id": 1218, "name": "Copper", "scale_id": null, "equal_to": []}, {"value_id": 1214, "name": "Gold", "scale_id": null, "equal_to": []}, {"value_id": 5, "name": "Gray", "scale_id": null, "equal_to": []}, {"value_id": 4, "name": "Green", "scale_id": null, "equal_to": []}, {"value_id": 6, "name": "Orange", "scale_id": null, "equal_to": []}, {"value_id": 7, "name": "Pink", "scale_id": null, "equal_to": []}, {"value_id": 8, "name": "Purple", "scale_id": null, "equal_to": []}, {"value_id": 1220, "name": "Rainbow", "scale_id": null, "equal_to": []}, {"value_id": 9, "name": "Red", "scale_id": null, "equal_to": []}, {"value_id": 1217, "name": "Rose gold", "scale_id": null, "equal_to": []}, {"value_id": 1215, "name": "Silver", "scale_id": null, "equal_to": []}, {"value_id": 10, "name": "White", "scale_id": null, "equal_to": []}, {"value_id": 11, "name": "Yellow", "scale_id": null, "equal_to": []}], "selected_values": []}, {"property_id": 52047899002, "name": "Secondary color", "display_name": "Secondary color", "scales": [], "is_required": false, "supports_attributes": true, "supports_variations": true, "is_multivalued": false, "possible_values": [{"value_id": 1213, "name": "Beige", "scale_id": null, "equal_to": []}, {"value_id": 1, "name": "Black", "scale_id": null, "equal_to": []}, {"value_id": 2, "name": "Blue", "scale_id": null, "equal_to": []}, {"value_id": 1216, "name": "Bronze", "scale_id": null, "equal_to": []}, {"value_id": 3, "name": "Brown", "scale_id": null, "equal_to": []}, {"value_id": 1219, "name": "Clear", "scale_id": null, "equal_to": []}, {"value_id": 1218, "name": "Copper", "scale_id": null, "equal_to": []}, {"value_id": 1214, "name": "Gold", "scale_id": null, "equal_to": []}, {"value_id": 5, "name": "Gray", "scale_id": null, "equal_to": []}, {"value_id": 4, "name": "Green", "scale_id": null, "equal_to": []}, {"value_id": 6, "name": "Orange", "scale_id": null, "equal_to": []}, {"value_id": 7, "name": "Pink", "scale_id": null, "equal_to": []}, {"value_id": 8, "name": "Purple", "scale_id": null, "equal_to": []}, {"value_id": 1220, "name": "Rainbow", "scale_id": null, "equal_to": []}, {"value_id": 9, "name": "Red", "scale_id": null, "equal_to": []}, {"value_id": 1217, "name": "Rose gold", "scale_id": null, "equal_to": []}, {"value_id": 1215, "name": "Silver", "scale_id": null, "equal_to": []}, {"value_id": 10, "name": "White", "scale_id": null, "equal_to": []}, {"value_id": 11, "name": "Yellow", "scale_id": null, "equal_to": []}], "selected_values": []}, {"property_id": 46803063641, "name": "Occasion", "display_name": "Occasion", "scales": [], "is_required": false, "supports_attributes": true, "supports_variations": false, "is_multivalued": false, "possible_values": [{"value_id": 2773, "name": "1st birthday", "scale_id": null, "equal_to": [19]}, {"value_id": 12, "name": "Anniversary", "scale_id": null, "equal_to": []}, {"value_id": 13, "name": "Baby shower", "scale_id": null, "equal_to": []}, {"value_id": 14, "name": "Bachelor party", "scale_id": null, "equal_to": []}, {"value_id": 15, "name": "Bachelorette party", "scale_id": null, "equal_to": []}, {"value_id": 16, "name": "Back to school", "scale_id": null, "equal_to": []}, {"value_id": 17, "name": "Baptism", "scale_id": null, "equal_to": []}, {"value_id": 18, "name": "Bar & Bat Mitzvah", "scale_id": null, "equal_to": []}, {"value_id": 19, "name": "Birthday", "scale_id": null, "equal_to": []}, {"value_id": 20, "name": "Bridal shower", "scale_id": null, "equal_to": []}, {"value_id": 21, "name": "Confirmation", "scale_id": null, "equal_to": []}, {"value_id": 26, "name": "Divorce & breakup", "scale_id": null, "equal_to": []}, {"value_id": 22, "name": "Engagement", "scale_id": null, "equal_to": []}, {"value_id": 23, "name": "First Communion", "scale_id": null, "equal_to": []}, {"value_id": 24, "name": "Graduation", "scale_id": null, "equal_to": []}, {"value_id": 25, "name": "Grief & mourning", "scale_id": null, "equal_to": []}, {"value_id": 27, "name": "Housewarming", "scale_id": null, "equal_to": []}, {"value_id": 2774, "name": "LGBTQ pride", "scale_id": null, "equal_to": []}, {"value_id": 50, "name": "Moving", "scale_id": null, "equal_to": []}, {"value_id": 28, "name": "Pet loss", "scale_id": null, "equal_to": []}, {"value_id": 29, "name": "Prom", "scale_id": null, "equal_to": []}, {"value_id": 30, "name": "Quincea\u00f1era & Sweet 16", "scale_id": null, "equal_to": []}, {"value_id": 31, "name": "Retirement", "scale_id": null, "equal_to": []}, {"value_id": 32, "name": "Wedding", "scale_id": null, "equal_to": []}], "selected_values": []}, {"property_id": 46803063659, "name": "Holiday", "display_name": "Holiday", "scales": [], "is_required": false, "supports_attributes": true, "supports_variations": false, "is_multivalued": false, "possible_values": [{"value_id": 33, "name": "April Fools'", "scale_id": null, "equal_to": []}, {"value_id": 35, "name": "Christmas", "scale_id": null, "equal_to": []}, {"value_id": 36, "name": "Cinco de Mayo", "scale_id": null, "equal_to": []}, {"value_id": 37, "name": "Easter", "scale_id": null, "equal_to": []}, {"value_id": 38, "name": "Father's Day", "scale_id": null, "equal_to": []}, {"value_id": 39, "name": "Halloween", "scale_id": null, "equal_to": []}, {"value_id": 40, "name": "Hanukkah", "scale_id": null, "equal_to": []}, {"value_id": 41, "name": "Independence Day", "scale_id": null, "equal_to": []}, {"value_id": 42, "name": "Kwanzaa", "scale_id": null, "equal_to": []}, {"value_id": 34, "name": "Lunar New Year", "scale_id": null, "equal_to": []}, {"value_id": 43, "name": "Mother's Day", "scale_id": null, "equal_to": []}, {"value_id": 44, "name": "New Year's", "scale_id": null, "equal_to": []}, {"value_id": 47, "name": "Passover", "scale_id": null, "equal_to": []}, {"value_id": 45, "name": "St Patrick's Day", "scale_id": null, "equal_to": []}, {"value_id": 46, "name": "Thanksgiving", "scale_id": null, "equal_to": []}, {"value_id": 48, "name": "Valentine's Day", "scale_id": null, "equal_to": []}, {"value_id": 49, "name": "Veterans Day", "scale_id": null, "equal_to": []}], "selected_values": []}, {"property_id": 504, "name": "Diameter", "display_name": "Diameter", "scales": [{"scale_id": 341, "display_name": "Inches", "description": "Inches"}, {"scale_id": 342, "display_name": "Centimeters", "description": "Centimeters"}, {"scale_id": 343, "display_name": "Other", "description": "Other"}], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 501, "name": "Dimensions", "display_name": "Dimensions", "scales": [{"scale_id": 344, "display_name": "Inches", "description": "Inches"}, {"scale_id": 345, "display_name": "Centimeters", "description": "Centimeters"}, {"scale_id": 346, "display_name": "Other", "description": "Other"}], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 502, "name": "Fabric", "display_name": "Fabric", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 500, "name": "Finish", "display_name": "Finish", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 503, "name": "Flavor", "display_name": "Flavor", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 505, "name": "Height", "display_name": "Height", "scales": [{"scale_id": 347, "display_name": "Inches", "description": "Inches"}, {"scale_id": 348, "display_name": "Centimeters", "description": "Centimeters"}, {"scale_id": 349, "display_name": "Other", "description": "Other"}], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 506, "name": "Length", "display_name": "Length", "scales": [{"scale_id": 350, "display_name": "Inches", "description": "Inches"}, {"scale_id": 351, "display_name": "Centimeters", "description": "Centimeters"}, {"scale_id": 352, "display_name": "Other", "description": "Other"}], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 507, "name": "Material", "display_name": "Material", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 508, "name": "Pattern", "display_name": "Pattern", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 509, "name": "Scent", "display_name": "Scent", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 100, "name": "TeeShirtSize", "display_name": "Size", "scales": [{"scale_id": 301, "display_name": "Alpha", "description": "Alpha"}, {"scale_id": 327, "display_name": "Inches", "description": "Inches"}, {"scale_id": 328, "display_name": "Centimeters", "description": "Centimeters"}, {"scale_id": 335, "display_name": "Fluid Ounces", "description": "Fluid Ounces"}, {"scale_id": 336, "display_name": "Millilitres", "description": "Millilitres"}, {"scale_id": 337, "display_name": "Litres", "description": "Litres"}, {"scale_id": 329, "display_name": "Other", "description": "Other"}], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [{"value_id": null, "name": "XXS", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "XS", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "S", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "M", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "L", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "XL", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "XXL", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "3XL", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "4XL", "scale_id": 301, "equal_to": []}, {"value_id": null, "name": "5XL", "scale_id": 301, "equal_to": []}], "selected_values": []}, {"property_id": 510, "name": "Style", "display_name": "Style", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 511, "name": "Weight", "display_name": "Weight", "scales": [{"scale_id": 332, "display_name": "Pounds", "description": "Pounds"}, {"scale_id": 331, "display_name": "Ounces", "description": "Ounces"}, {"scale_id": 333, "display_name": "Grams", "description": "Grams"}, {"scale_id": 334, "display_name": "Kilograms", "description": "Kilograms"}], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 512, "name": "Width", "display_name": "Width", "scales": [{"scale_id": 338, "display_name": "Inches", "description": "Inches"}, {"scale_id": 339, "display_name": "Centimeters", "description": "Centimeters"}, {"scale_id": 340, "display_name": "Other", "description": "Other"}], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 515, "name": "Device", "display_name": "Device", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [{"value_id": null, "name": "iPad", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "iPad Mini", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "iPhone 5", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "iPhone 4/4S", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "Kindle Fire HD", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "Kindle Fire HD 8.9\"", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "Kindle Paperwhite", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "Samsung Galaxy S4", "scale_id": null, "equal_to": []}, {"value_id": null, "name": "Samsung Galaxy S3", "scale_id": null, "equal_to": []}], "selected_values": []}, {"property_id": 513, "name": "Custom1", "display_name": "Custom Property", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}, {"property_id": 514, "name": "Custom2", "display_name": "Custom Property", "scales": [], "is_required": false, "supports_attributes": false, "supports_variations": true, "is_multivalued": false, "possible_values": [], "selected_values": []}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"count": {"type": "integer"}, "results": {"type": "array", "items": {"type": "object", "properties": {"property_id": {"type": "integer"}, "name": {"type": "string"}, "display_name": {"type": "string"}, "scales": {"type": "array", "items": {"type": "object", "properties": {"scale_id": {"type": "integer"}, "display_name": {"type": "string"}, "description": {"type": "string"}}, "required": ["description", "display_name", "scale_id"]}}, "is_required": {"type": "boolean"}, "supports_attributes": {"type": "boolean"}, "supports_variations": {"type": "boolean"}, "is_multivalued": {"type": "boolean"}, "possible_values": {"type": "array", "items": {"type": "object", "properties": {"value_id": {"type": ["integer", "null"]}, "name": {"type": "string"}, "scale_id": {"type": ["integer", "null"]}, "equal_to": {"type": "array", "items": {"type": "integer"}}}, "required": ["equal_to", "name", "scale_id", "value_id"]}}, "selected_values": {"type": "array"}}, "required": ["display_name", "is_multivalued", "is_required", "name", "possible_values", "property_id", "scales", "selected_values", "supports_attributes", "supports_variations"]}}}, "required": ["count", "results"]} |
22f3b61d-af3a-4244-be8c-47e5b74a7932/4d4d6343-b0a3-4c3c-abb5-f92121f0c231/0/0 | Scrape Phone Email Social Media Account Company Address | Get business information :
- Phone number
- Contact Email address
- Social media account (facebook, instagram, linkedIn, twitter)
- Company postal address | 7.3 | Get business information | Scrape Phone Email Social Media Account Company Address | 200 | Response | {"companyNames": [], "countryCode": "US", "domainName": "google.com", "emails": [], "meta": {"description": "", "title": "Google"}, "phones": [], "postalAddresses": [], "socialLinks": {"facebook": "", "instagram": "", "linkedIn": "", "twitter": ""}, "websiteResponded": true} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"companyNames": {"type": "array"}, "countryCode": {"type": "string"}, "domainName": {"type": "string"}, "emails": {"type": "array"}, "meta": {"type": "object", "properties": {"description": {"type": "string"}, "title": {"type": "string"}}, "required": ["description", "title"]}, "phones": {"type": "array"}, "postalAddresses": {"type": "array"}, "socialLinks": {"type": "object", "properties": {"facebook": {"type": "string"}, "instagram": {"type": "string"}, "linkedIn": {"type": "string"}, "twitter": {"type": "string"}}, "required": ["facebook", "instagram", "linkedIn", "twitter"]}, "websiteResponded": {"type": "boolean"}}, "required": ["companyNames", "countryCode", "domainName", "emails", "meta", "phones", "postalAddresses", "socialLinks", "websiteResponded"]} |
1baaa2de-0c64-46ed-921c-d3a52674cc43/e15d0eb4-8d65-4753-9b63-8c614406c751/0/0 | Available Domain Name Generator | This generator will find available short domain names using URL extensions .COM and .NET. | 0.3 | Generator | This will generate available short .com and .net domain names! | 200 | Response | [{"Domain": "VEHYJ.com"}, {"Domain1": "BREUB.com"}, {"Domain2": "UORIR.com"}, {"Domain3": "UBVAX.com"}, {"Domain4": "YEHUQ.com"}] | {"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"Domain": {"type": "string"}, "Domain1": {"type": "string"}, "Domain2": {"type": "string"}, "Domain3": {"type": "string"}, "Domain4": {"type": "string"}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/d24d1a98-3f14-4176-9d0e-d4bc2d2f7d1a/0/0 | Grafterr | APIs | null | /order/create | Order Sync API is designed to store the order details sent by the user. User can send the order details as per the menu created though the Menu Sync API. The order details saved through this API can be seen on EPOS Admin panel. Here for the understanding purpose, the API JSON Schema is divided into few parts explaining about its purpose and details. | 200 | null | {"status": 200, "message": "Data saved successfully!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data saved successfully!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/d24d1a98-3f14-4176-9d0e-d4bc2d2f7d1a/1/0 | Grafterr | APIs | null | /order/create | Order Sync API is designed to store the order details sent by the user. User can send the order details as per the menu created though the Menu Sync API. The order details saved through this API can be seen on EPOS Admin panel. Here for the understanding purpose, the API JSON Schema is divided into few parts explaining about its purpose and details. | 403 | null | {"status": 403, "message": "Please check the credentials and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 403, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the credentials and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/d24d1a98-3f14-4176-9d0e-d4bc2d2f7d1a/2/0 | Grafterr | APIs | null | /order/create | Order Sync API is designed to store the order details sent by the user. User can send the order details as per the menu created though the Menu Sync API. The order details saved through this API can be seen on EPOS Admin panel. Here for the understanding purpose, the API JSON Schema is divided into few parts explaining about its purpose and details. | 404 | null | {"status": 404, "message": "Something went wrong. Please try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 404, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Something went wrong. Please try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/d24d1a98-3f14-4176-9d0e-d4bc2d2f7d1a/3/0 | Grafterr | APIs | null | /order/create | Order Sync API is designed to store the order details sent by the user. User can send the order details as per the menu created though the Menu Sync API. The order details saved through this API can be seen on EPOS Admin panel. Here for the understanding purpose, the API JSON Schema is divided into few parts explaining about its purpose and details. | 400 | null | {"status": 400, "message": "Please check the input and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 400, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the input and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/0/0 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 400 | null | {"status": 400, "message": "Please check the input and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 400, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the input and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/1/0 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 403 | null | {"status": 403, "message": "Please check the credentials and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 403, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the credentials and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/2/0 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 404 | null | {"status": 404, "message": "Something went wrong. Please try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 404, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Something went wrong. Please try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/0 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567893", "address": {"flat": "1/15", "street": "kingsknowe court", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API108", "order-type": "eat_in", "order-status": "placed", "total-tax": 2, "total-discount": 10, "total-amount": 12, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "item_00006", "size-plu": "item_multi_0006", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 2, "type": "item", "topping-style": "", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00007", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.3, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.7, "tax-percentage": 20}], "options": []}, {"plu": "mod_00006", "size-plu": "mod_multi_00008", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.2, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.8, "tax-percentage": 20}], "options": []}]}]}], "payment": [{"type": "cash", "amount": 40, "change": 10, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 7.5, "change": 0, "payment-id": "123456773sfcsdvd", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 10}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/1 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567893", "address": {"flat": "1/15", "street": "kingsknowe court", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API106", "order-type": "eat_in", "order-status": "placed", "total-tax": 10, "total-discount": 5, "total-amount": 41, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "pizaa_00009", "size-plu": "pizza_multi_00001", "quantity": 2, "price": 4, "discount-amount": 0, "tax-amount": 3, "total-with-tax": 2, "type": "pizza", "topping-style": "regular", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 2, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}], "payment": [{"type": "cash", "amount": 24.5, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 19, "change": 0, "payment-id": "123456773", "card-4-digit": "4321", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/2 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567893", "address": {"flat": "1/15", "street": "kingsknowe court", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API105", "order-type": "eat_in", "order-status": "placed", "total-tax": 16, "total-discount": 5, "total-amount": 68, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "pizaa_00009", "size-plu": "pizza_multi_00001", "quantity": 2, "price": 4, "discount-amount": 0, "tax-amount": 3, "total-with-tax": 2, "type": "pizza", "topping-style": "half_and_half", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 2, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}], "payment": [{"type": "cash", "amount": 24.5, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 46, "change": 0, "payment-id": "123456773", "card-4-digit": "4321", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/3 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567812", "address": {"flat": "1/15", "street": "1/15 kingsknow court edinburgh", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API153", "order-type": "take_away", "order-status": "placed", "total-tax": 16, "total-discount": 5, "total-amount": 78, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "item_00001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 2, "type": "query-meal-deal", "topping-style": "", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "mod_00002", "size-plu": "mod_multi_00004", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}], "options": []}, {"plu": "mod_00004", "size-plu": "mod_multi_00004", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}], "options": []}]}, {"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "pizza", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}]}], "payment": [{"type": "cash", "amount": 22, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 58.5, "change": 0, "payment-id": "123456773", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/4 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567812", "address": {"flat": "1/15", "street": "1/15 kingsknow court edinburgh", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API154", "order-type": "take_away", "order-status": "placed", "total-tax": 16, "total-discount": 5, "total-amount": 75, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "query-meal-deal", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}, {"type": "item", "data": [{"plu": "I-PA-eb26", "size-plu": "", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "mod_00001", "size-plu": "mod_multi_00001", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}]}], "payment": [{"type": "cash", "amount": 22, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 55.5, "change": 0, "payment-id": "123456773", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/5 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567812", "address": {"flat": "1/15", "street": "1/15 kingsknowe courtedinburghEH14 2JS", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API149", "order-type": "take_away", "order-status": "placed", "total-tax": 16, "total-discount": 10, "total-amount": 78, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "deal_00001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "type": "meal-deal", "topping-style": "", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}], "options": [{"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "pizza", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}, {"type": "item", "data": [{"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 0, "split-part": "", "discount-amount": 0, "tax-amount": 0, "total-with-tax": 2, "type": "item", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}]}, {"plu": "mod_00006", "size-plu": "mod_multi_00008vdf", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}]}]}]}]}]}], "payment": [{"type": "cash", "amount": 30, "change": 6, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "cash", "amount": 29, "change": 0, "payment-id": "123456772", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 20.5, "change": 0, "payment-id": "123456773sfcsdvd", "card-4-digit": "1234", "card-type": "master"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 10}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/6 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567893", "address": {"flat": "1/15", "street": "kingsknowe court", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API103", "order-type": "eat_in", "order-status": "placed", "total-tax": 35, "total-discount": 5, "total-amount": 160, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "mix_and_match_0001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 0, "total-with-tax": 1.99, "type": "mix-and-match", "topping-style": "", "taxes": [], "options": [{"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 4, "discount-amount": 0, "tax-amount": 3, "total-with-tax": 2, "type": "pizza", "topping-style": "half_and_half", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 2, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}, {"type": "item", "data": [{"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 2, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.7, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.3, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.15, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.85, "tax-percentage": 20}]}, {"plu": "mod_00006", "size-plu": "mod_multi_00008", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.4, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.6, "tax-percentage": 20}]}]}]}]}, {"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 4, "discount-amount": 0, "tax-amount": 3, "total-with-tax": 2, "type": "pizza", "topping-style": "half_and_half", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 2, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}]}], "payment": [{"type": "cash", "amount": 24.5, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 138, "change": 0, "payment-id": "123456773", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/7 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567812", "address": {"flat": "1/15", "street": "1/15 kingsknowe court edinburgh", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API117", "order-type": "eat_in", "order-status": "placed", "total-tax": 22, "total-discount": 5, "total-amount": 104, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "mix_and_match_0001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 0, "type": "mix-and-match", "topping-style": "", "taxes": [], "options": [{"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 4, "discount-amount": 0, "tax-amount": 3, "total-with-tax": 2, "type": "pizza", "topping-style": "half_and_half", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 2, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}, {"type": "item", "data": [{"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 2, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.7, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.3, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 1, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.15, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.85, "tax-percentage": 20}], "options": []}, {"plu": "mod_00006", "size-plu": "mod_multi_00008", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.4, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.6, "tax-percentage": 20}], "options": []}]}]}]}]}, {"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 3, "type": "item", "topping-style": "", "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 2, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.7, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.3, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 1, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.15, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.85, "tax-percentage": 20}], "options": []}, {"plu": "mod_00006", "size-plu": "mod_multi_00008", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.4, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.6, "tax-percentage": 20}], "options": []}]}]}], "payment": [{"type": "cash", "amount": 24.5, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 82, "change": 0, "payment-id": "123456773", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/8 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "2413682"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567893", "address": {"flat": "1/15", "street": "kingsknowe court", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API119", "order-type": "eat_in", "order-status": "placed", "total-tax": 52, "total-discount": 5, "total-amount": 245, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "deal_00001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "type": "meal-deal", "topping-style": "", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}], "options": [{"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "pizza", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}, {"type": "item", "data": [{"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 0, "split-part": "", "discount-amount": 0, "tax-amount": 0, "total-with-tax": 2, "type": "item", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}]}, {"plu": "mod_00006", "size-plu": "mod_multi_00008vdf", "quantity": 1, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}]}]}]}]}]}, {"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "query-meal-deal", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}, {"type": "item", "data": [{"plu": "I-PA-eb26", "size-plu": "", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": [{"type": "modifier", "data": []}]}]}]}], "payment": [{"type": "cash", "amount": 24.5, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 223, "change": 0, "payment-id": "123456773", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/9 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567893", "address": {"flat": "1/15", "street": "kingsknowe court", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API119", "order-type": "eat_in", "total-tax": 52, "total-discount": 5, "total-amount": 245, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "deal_00001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "type": "meal-deal", "topping-style": "", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}], "options": [{"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "pizza", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}, {"type": "item", "data": [{"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 0, "split-part": "", "discount-amount": 0, "tax-amount": 0, "total-with-tax": 2, "type": "item", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}]}, {"plu": "mod_00006", "size-plu": "mod_multi_00008vdf", "quantity": 1, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}]}]}]}]}]}, {"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "query-meal-deal", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}, {"type": "item", "data": [{"plu": "I-PA-eb26", "size-plu": "", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": [{"type": "modifier", "data": []}]}]}]}], "payment": [{"type": "cash", "amount": 24.5, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 223, "change": 0, "payment-id": "123456773", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/f246fded-01d5-49a5-9dbe-4b693d9ec73c/3/10 | Grafterr | APIs | null | /order/read | Order Upstream API is designed to fetch the order details. The orders may be generated through different platforms such as Web app, mobile app, operator app, self checkout etc. So the details of these orders will be sent through this API. | 200 | null | {"status": 200, "message": "Data fetched successfully!", "order_data": {"business-details": {"business-id": "123456"}, "customer": {"name": "John Doe", "email": "[email protected]", "phone": "01234567893", "address": {"flat": "1/15", "street": "kingsknowe court", "city": "edinburgh", "postcode": "EH14 2JS"}}, "order": {"details": {"order-id": "API127", "order-type": "eat_in", "order-status": "placed", "total-tax": 49, "total-discount": 5, "total-amount": 230, "tip-amount": 2, "delivery-charges": 3.5}, "items": [{"plu": "deal_00001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "type": "meal-deal", "topping-style": "", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}], "options": [{"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "pizza_multi_00001", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "pizza", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}, {"type": "item", "data": [{"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 0, "split-part": "", "discount-amount": 0, "tax-amount": 0, "total-with-tax": 2, "type": "item", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}]}, {"plu": "mod_00006", "size-plu": "mod_multi_00008vdf", "quantity": 1, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.65, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.35, "tax-percentage": 20}]}]}]}]}]}, {"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 0, "discount-amount": 0, "tax-amount": 0, "type": "query-meal-deal", "topping-style": "half_and_half", "taxes": [], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}, {"type": "item", "data": [{"plu": "I-PA-eb26", "size-plu": "", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": [{"type": "modifier", "data": []}]}]}]}, {"plu": "mix_and_match_0001", "size-plu": "", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 0, "total-with-tax": 1.99, "type": "mix-and-match", "topping-style": "", "taxes": [], "options": [{"type": "pizza", "data": [{"plu": "pizaa_00009", "size-plu": "ps_sf45", "quantity": 2, "price": 4, "discount-amount": 0, "tax-amount": 3, "total-with-tax": 2, "type": "pizza", "topping-style": "half_and_half", "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 2, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "M-DE-2b36", "size-plu": "M-MP-SM-5230-1", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.1, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.9, "tax-percentage": 20}], "options": []}, {"plu": "M-TH-5a07", "size-plu": "M-MP-SM-17ca-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-OT-6bad", "size-plu": "M-MP-SM-25d0-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-HA-7af0", "size-plu": "M-MP-SM-6d59-1", "quantity": 3, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-d50d", "size-plu": "M-MP-SM-d8f8-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-SP-0e73", "size-plu": "M-MP-SM-a303-1", "quantity": 3, "price": 3, "split-part": "left", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}, {"plu": "M-MU-921b", "size-plu": "M-MP-SM-3465-1", "quantity": 3, "price": 3, "split-part": "right", "discount-amount": 0, "tax-amount": 2, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 1.5, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.5, "tax-percentage": 20}], "options": []}]}]}]}, {"type": "item", "data": [{"plu": "item_00006", "size-plu": "item_multi_0008", "quantity": 2, "price": 3, "split-part": "", "discount-amount": 0, "tax-amount": 1, "total-with-tax": 2, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.7, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.3, "tax-percentage": 20}], "options": [{"type": "modifier", "data": [{"plu": "mod_00006", "size-plu": "mod_multi_00009", "quantity": 2, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.15, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.85, "tax-percentage": 20}]}, {"plu": "mod_00006", "size-plu": "mod_multi_00008", "quantity": 1, "price": 3, "discount-amount": 0, "tax-amount": 1, "total-with-tax": 1.99, "taxes": [{"tax-plu": "tax_00001", "tax-amount": 0.4, "tax-percentage": 20}, {"tax-plu": "tax_00001", "tax-amount": 0.6, "tax-percentage": 20}]}]}]}]}]}], "payment": [{"type": "cash", "amount": 24.5, "change": 2, "payment-id": "1234567781", "card-4-digit": "", "card-type": ""}, {"type": "card", "amount": 208, "change": 0, "payment-id": "123456773", "card-4-digit": "1234", "card-type": "visa"}], "discount": [{"plu": "mix_and_match_0001", "type": "promo_code", "amount": 5}]}}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "order_data": {"type": "object", "description": "It contains the fetched order data", "properties": {"business-details": {"title": "Business-details", "type": "object", "description": "This include the 'business-id' key. Every business registered with us has a unique random business ID. The Integration partner will only have access to it.", "properties": {"business-id": {"title": "Business-id", "type": "string", "description": "Unique ID of the business"}}}, "customer": {"title": "Customer", "type": "object", "description": "In this block the primary information of the customer information who has put the order need to be added here.", "properties": {"name": {"title": "Name", "type": "string", "description": "Name of the customer"}, "email": {"title": "Email", "type": "string", "description": "Email ID of the customer"}, "phone": {"title": "Phone", "type": "string", "description": "Phone number of the customer"}, "address": {"title": "Address", "type": "object", "description": "It contains the customer address details", "properties": {"flat": {"title": "Flat", "type": "string", "description": "Customer's flat details", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "street": {"title": "Street", "type": "string", "description": "Customer's street name", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "city": {"title": "City", "type": "string", "description": "Customer's city name", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "postcode": {"title": "Postcode", "type": "string", "description": "Customer's postcode", "default": "", "pattern": "", "minLength": 3, "maxLength": 10}}}}}, "order": {"title": "Order", "type": "object", "description": "This section contains multiple subsections like details, items, payment and discount which hold the relevant information about the order's details.", "properties": {"details": {"title": "Details", "type": "object", "description": "It contains the primary information about the given order like its id, type, total amount, its tax, discount, tip and delivery charges.", "properties": {"order-id": {"title": "Order-id", "type": "string", "description": "Order ID of the given order", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "order-type": {"title": "Order-type", "type": "string", "description": "Order type of the given order.", "pattern": "", "enum": ["eat_in", "take_away", "delivery", "drive_thru", "collection"]}, "order-status": {"title": "Order-status", "type": "string", "description": "Status of the order", "pattern": "", "enum": ["placed", "completed", "cancelled", "test_order"]}, "total-tax": {"title": "Total-tax", "type": "number", "description": "The total-tax amount will be equal to the summation of all the individual items' and their modifiers' 'tax_amount'", "default": 0, "minimum": 0}, "total-discount": {"title": "Total-discount", "type": "number", "description": "It will be equal to 'amount' mentioned in 'discount' section. It is the discount amount given for that order.", "default": 0, "minimum": 0}, "total-amount": {"title": "Total-amount", "type": "number", "description": "It will be equal to the summation of all the individual items' (price*quantity) and their modifiers' (price*quantity) amount.", "default": 0, "minimum": 0}, "tip-amount": {"title": "Tip-amount", "type": "number", "description": "This amount is tip given for the current order.", "default": 0, "minimum": 0}, "delivery-charges": {"title": "Delivery-charges", "type": "number", "description": "Charges collected for delivery", "default": 0, "minimum": 0}}}, "items": {"title": "Items", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "description": "This section contains the item details. Items may be treated as regular items of type 'item' or 'pizza' or combo items like 'meal-deal',' 'mix-and-match' or 'query-meal' etc. Each item may have modifiers. Combo items will definitely have items of type 'item'.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the given item", "default": "", "pattern": "", "minLength": 1, "maxLength": 50}, "size-plu": {"title": "Size-plu", "type": "string", "description": "Size PLU of the given item. For the combo item, the keep size-plu will be empty string \"\".", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "quantity": {"title": "Quantity", "type": "integer", "description": "Quntity of the item", "default": 0, "minimum": 0}, "price": {"title": "Price", "type": "number", "description": "Price of the item", "default": 0, "minimum": 0}, "tax-amount": {"title": "Tax-amount", "type": "number", "description": "Tax amoiunt for the item", "default": 0, "minimum": 0}, "type": {"title": "Type", "type": "string", "description": "Type of the current item.", "pattern": "", "enum": ["item", "pizza", "meal-deal", "query-meal-deal", "mix-and-match"]}, "topping-style": {"title": "Topping-style", "type": "string", "description": "If the item 'type' is 'pizza' then the value will be either 'half_and_half' or 'regular'. Otheriwse will be an empty string \"\".", "pattern": "", "enum": ["half_and_half,", "regular,", ""]}, "taxes": {"title": "Taxes", "type": "array", "description": "If the value 'tax-amount' for the given item is greater than zero (0), then the tax items will be present in taxes array.", "items": {"title": "Items", "type": "object", "properties": {"tax-plu": {"description": "**Omitted**"}, "tax-amount": {"description": "**Omitted**"}, "tax-percentage": {"description": "**Omitted**"}}}}, "options": {"title": "Options", "type": "array", "description": "If the 'type' of the current item is 'item' or 'pizza' then 'options' will contain modifiers for that item. If the current item 'type' is of combo meal, then the options will contain the items of that combo meal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"type": {"description": "**Omitted**"}, "data": {"description": "**Omitted**"}}}}}}}, "payment": {"title": "Payment", "type": "array", "description": "It contains the payment information of the order", "default": [], "items": {"title": "Items", "type": "object", "minItems": 0, "properties": {"type": {"title": "Type", "type": "string", "description": "Type of the payment", "pattern": "", "enum": ["cash", "card", "third_party"]}, "amount": {"title": "Amount", "type": "number", "description": "Payment amount", "default": 0, "minimum": 0}, "change": {"title": "Change", "type": "number", "description": "Change amount", "default": 0, "minimum": 0}, "payment-id": {"title": "Payment-id", "type": "string", "description": "Unique ID of the payment", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "card-4-digit": {"title": "Card-4-digit", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 4}, "card-type": {"title": "Card-type", "type": "string", "description": "Enter the last 4 digits of the card if payment 'type' is 'card'. Otherwise keep it blank.", "minLength": 0, "maxLength": 25}}}}, "discount": {"title": "Discount", "type": "array", "description": "The order may have multiple discounts and they will be shown here. If not,then it will be an empty array [].", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "plu", "type": "string", "description": "PLU of the discount", "default": "", "pattern": "", "minLength": 3, "maxLength": 50}, "type": {"title": "type", "type": "string", "description": "Type of the discount offered", "pattern": "", "enum": ["promo_code", "staff_discount", "discount_on_bill"]}, "amount": {"title": "Amount", "type": "number", "description": "Discount amount", "default": 0, "minimum": 0}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/9ae1dfa7-8f09-4d02-8df9-c5b182ebd971/0/0 | Grafterr | APIs | null | /catalogue | Menu sync helps developers to sync their existing menu into Grafterr POS. We have a menu structure that's defined and used throuqueryghout our product range. Once a menu is synced developers can easily access the menu from epos, self-checkout, online orders, and mobile apps. | 404 | null | {"status": 404, "message": "Something went wrong. Please try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 404, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Something went wrong. Please try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/9ae1dfa7-8f09-4d02-8df9-c5b182ebd971/1/0 | Grafterr | APIs | null | /catalogue | Menu sync helps developers to sync their existing menu into Grafterr POS. We have a menu structure that's defined and used throuqueryghout our product range. Once a menu is synced developers can easily access the menu from epos, self-checkout, online orders, and mobile apps. | 400 | null | {"status": 400, "message": "Please check the input and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 400, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the input and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/9ae1dfa7-8f09-4d02-8df9-c5b182ebd971/2/0 | Grafterr | APIs | null | /catalogue | Menu sync helps developers to sync their existing menu into Grafterr POS. We have a menu structure that's defined and used throuqueryghout our product range. Once a menu is synced developers can easily access the menu from epos, self-checkout, online orders, and mobile apps. | 200 | null | {"status": 200, "message": "Data saved successfully!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data saved successfully!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/9ae1dfa7-8f09-4d02-8df9-c5b182ebd971/3/0 | Grafterr | APIs | null | /catalogue | Menu sync helps developers to sync their existing menu into Grafterr POS. We have a menu structure that's defined and used throuqueryghout our product range. Once a menu is synced developers can easily access the menu from epos, self-checkout, online orders, and mobile apps. | 403 | null | {"status": 403, "message": "Please check the credentials and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 403, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the credentials and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/0/0 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 400 | null | {"status": 400, "message": "Please check the input and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 400, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the input and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/1/0 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 404 | null | {"status": 404, "message": "Something went wrong. Please try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 404, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Something went wrong. Please try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/2/0 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 403 | null | {"status": 403, "message": "Please check the credentials and try again!"} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 403, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Please check the credentials and try again!"}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/0 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-09-06", "end_date": "2029-09-06"}, "image_url": "", "sort_sno": 0}, {"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}, {"plu": "MN-SA-A739-3", "name": "Saher Test", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": ""}, {"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}, {"plu": "MN-MC-SA-0DDB-3", "menu_plu": "MN-SA-A739-3", "name": "Sahercattest", "status": "active", "course_sno": 0, "print_order": 0, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}, {"plu": "GS-S1-5FAC-4", "size": "S1"}, {"plu": "GS-S2-F6A5-5", "size": "S2"}, {"plu": "GS-S3-C8B2-6", "size": "S3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}, {"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-2FA5-3", "name": "ModCatSauce", "status": "active", "type": "sauce"}, {"plu": "MO-MC-MO-5148-4", "name": "ModCatCheese", "status": "active", "type": "cheese"}, {"plu": "MO-MC-EX-A171-5", "name": "Extra Toppings", "status": "active", "type": "none"}, {"plu": "MO-MC-EX-9ED3-6", "name": "Extra", "status": "active", "type": "none"}], "modifier_options": [{"plu": "M-MP-GS-59e8-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-17ff"}, {"plu": "M-MP-GS-8179-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-17ff"}, {"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-89d7-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-17ee"}, {"plu": "M-MP-GS-761e-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-17ee"}, {"plu": "M-MP-GS-c9c8-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-0d03-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-3bf3-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-8a48-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-d83a-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-842a-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-2230-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-0775-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-S1-34bc-1", "sale_price": 0, "cost_price": 0, "size": "GS-S1-5FAC-4", "modifier_plu": "M-MO-c8f3"}, {"plu": "M-MP-S2-e4d9-2", "sale_price": 0, "cost_price": 0, "size": "GS-S2-F6A5-5", "modifier_plu": "M-MO-c8f3"}, {"plu": "M-MP-S3-3eab-3", "sale_price": 0, "cost_price": 0, "size": "GS-S3-C8B2-6", "modifier_plu": "M-MO-c8f3"}, {"plu": "M-MP-S1-aaf2-1", "sale_price": 0, "cost_price": 0, "size": "GS-S1-5FAC-4", "modifier_plu": "M-MO-469a"}, {"plu": "M-MP-S2-4948-2", "sale_price": 0, "cost_price": 0, "size": "GS-S2-F6A5-5", "modifier_plu": "M-MO-469a"}, {"plu": "M-MP-S3-97e4-3", "sale_price": 0, "cost_price": 0, "size": "GS-S3-C8B2-6", "modifier_plu": "M-MO-469a"}, {"plu": "M-MP-S1-3554-1", "sale_price": 1, "cost_price": 0, "size": "GS-S1-5FAC-4", "modifier_plu": "M-MO-306d"}, {"plu": "M-MP-S2-fbf7-2", "sale_price": 1, "cost_price": 0, "size": "GS-S2-F6A5-5", "modifier_plu": "M-MO-306d"}, {"plu": "M-MP-S3-fa62-3", "sale_price": 1, "cost_price": 0, "size": "GS-S3-C8B2-6", "modifier_plu": "M-MO-306d"}], "modifiers": [{"plu": "M-MO-7461", "name": "Mod1-NoMod-SinglePrice", "description": "", "modifier_cat_plu": "", "sale_price": 10, "cost_price": 5, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": [], "allergen_type": "specific", "allergens": [5, 4], "status": "active", "image_url": ""}, {"plu": "M-MO-17ff", "name": "Mod2-NoMod-GlobalPrice", "description": "", "modifier_cat_plu": "", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-59e8-1", "M-MP-GS-8179-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-1b01", "name": "Mod3-ModCatNone-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-17ee", "name": "Mod6-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-89d7-1", "M-MP-GS-761e-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-ef86", "name": "Mod7-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-c9c8-1", "M-MP-GS-0d03-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-143e", "name": "Mod8-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-3bf3-1", "M-MP-GS-8a48-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-6061", "name": "Mod9-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-d83a-1", "M-MP-GS-842a-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-c471", "name": "Mod10-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-2230-1", "M-MP-GS-0775-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-60db", "name": "Mod1-NoModCat-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "specific", "allergens": [4, 5], "status": "active", "image_url": ""}, {"plu": "M-MO-60db594", "name": "Mod1-NoModCat-SinglePrice_rahul", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "specific", "allergens": [4, 5], "status": "active", "image_url": ""}, {"plu": "M-MO-c8f3", "name": "Mod1 S", "description": "", "modifier_cat_plu": "MO-MC-EX-A171-5", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-S1-34bc-1", "M-MP-S2-e4d9-2", "M-MP-S3-3eab-3"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-469a", "name": "Mod2 S", "description": "", "modifier_cat_plu": "MO-MC-EX-A171-5", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-S1-aaf2-1", "M-MP-S2-4948-2", "M-MP-S3-97e4-3"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-306d", "name": "Mod3 S", "description": "", "modifier_cat_plu": "MO-MC-EX-A171-5", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-S1-3554-1", "M-MP-S2-fbf7-2", "M-MP-S3-fa62-3"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "MO-MO-8687-17", "name": "Mod4 S", "description": "", "modifier_cat_plu": "MO-MC-EX-9ED3-6", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "MO-MO-0A48-18", "name": "Mod5 S", "description": "", "modifier_cat_plu": "MO-MC-EX-9ED3-6", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-ea2c-1", "title": "ModGroupTitle1 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-ffee-2", "title": "ModGroupTitle2 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-79ff-1", "title": "Option", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}], "min_cnt": 0, "max_cnt": 1, "included_cnt": 0}, {"plu": "MG-MO-d538-1", "title": "ModGroupTitle1 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "is_default": 0}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-d39d-2", "title": "ModGroupTitle2 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "is_default": 0}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-EX-eb9d-1", "title": "Extra Toppings", "modifiers": [{"plu": "M-MO-c8f3", "modifier_option_plu": "M-MP-S1-34bc-1", "is_default": 0}, {"plu": "M-MO-c8f3", "modifier_option_plu": "M-MP-S2-e4d9-2", "is_default": 0}, {"plu": "M-MO-c8f3", "modifier_option_plu": "M-MP-S3-3eab-3", "is_default": 0}, {"plu": "M-MO-469a", "modifier_option_plu": "M-MP-S1-aaf2-1", "is_default": 0}, {"plu": "M-MO-469a", "modifier_option_plu": "M-MP-S2-4948-2", "is_default": 0}, {"plu": "M-MO-469a", "modifier_option_plu": "M-MP-S3-97e4-3", "is_default": 0}, {"plu": "M-MO-306d", "modifier_option_plu": "M-MP-S1-3554-1", "is_default": 0}, {"plu": "M-MO-306d", "modifier_option_plu": "M-MP-S2-fbf7-2", "is_default": 0}, {"plu": "M-MO-306d", "modifier_option_plu": "M-MP-S3-fa62-3", "is_default": 0}], "min_cnt": 0, "max_cnt": 0, "included_cnt": 0}, {"plu": "MG-EX-c73b-1", "title": "Extras", "modifiers": [{"plu": "MO-MO-8687-17", "modifier_option_plu": "", "is_default": 0}, {"plu": "MO-MO-0A48-18", "modifier_option_plu": "", "is_default": 0}], "min_cnt": 0, "max_cnt": 0, "included_cnt": 0}, {"plu": "MG-MO-d790-1", "title": "ModGroupTitle1 - Item6-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-7461", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-17ff", "modifier_option_plu": "M-MP-GS-59e8-1", "is_default": 0}, {"plu": "M-MO-17ff", "modifier_option_plu": "M-MP-GS-8179-2", "is_default": 0}], "min_cnt": 0, "max_cnt": 2, "included_cnt": 0}], "item_options": [{"plu": "MP-SM-e745-1", "sale_price": 6, "cost_price": 3, "size": "", "size_name": "small"}, {"plu": "MP-ME-6245-2", "sale_price": 9, "cost_price": 4, "size": "", "size_name": "medium"}, {"plu": "MP-SM-4bba-1", "sale_price": 10, "cost_price": 5, "size": "", "size_name": "small"}, {"plu": "MP-ME-b99d-2", "sale_price": 15, "cost_price": 7, "size": "", "size_name": "medium"}, {"plu": "IT-GS-GS-D3E9-5", "sale_price": 12, "cost_price": 6, "size": "GS-GS-013F-1", "size_name": ""}, {"plu": "IT-GS-GS-F2B2-7", "sale_price": 14, "cost_price": 7, "size": "GS-GS-2EBE-2", "size_name": ""}, {"plu": "M-MP-S1-fe10-global_id01", "sale_price": 7.99, "cost_price": 0, "size": "GS-S1-5FAC-4", "size_name": ""}, {"plu": "M-MP-S2-2f53-global_id11", "sale_price": 8.99, "cost_price": 0, "size": "GS-S2-F6A5-5", "size_name": ""}, {"plu": "M-MP-S3-4b6b-global_id21", "sale_price": 9.99, "cost_price": 0, "size": "GS-S3-C8B2-6", "size_name": ""}], "pizza_topping_combos": [{"plu": "PZ-TC-CR-B850-5", "category_type": "crust", "modifier_category_plu": "MO-MC-MO-47EB-2", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 0, "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-11a7-2", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-89d7-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-761e-2", "price_type": "included", "is_default": 0, "split": "no"}]}, {"plu": "PZ-TC-SA-4A3A-6", "category_type": "sauce", "modifier_category_plu": "MO-MC-MO-2FA5-3", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-0d03-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-3bf3-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-8a48-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-TP-2D83-7", "category_type": "cheese", "modifier_category_plu": "MO-MC-MO-5148-4", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-CH-D902-8", "category_type": "none", "modifier_category_plu": "MO-MC-MO-0DCF-1", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 1, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "price_type": "included", "is_default": 0, "split": "yes"}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "price_type": "included", "is_default": 0, "split": "yes"}]}], "pizza_options": [{"plu": "PZ-GS-GS-50D5-17", "price": 4, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-013F-1"}, {"plu": "PZ-GS-GS-01CE-18", "price": 8, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-2EBE-2"}], "items": [{"plu": "I-IT-55bd", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item1-NoMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2025-01-30", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "I-IT-af79", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item2-NoMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [2, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-e745-1", "MP-ME-6245-2"], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2024-09-26", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "I-IT-c7be", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item3-WithMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "none", "allergens": [], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": ["MG-MO-ea2c-1", "MG-MO-ffee-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "I-IT-af0a", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item4-WithMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [7, 9, 11, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-4bba-1", "MP-ME-b99d-2"], "modifier_groups_plu": ["MG-MO-79ff-1"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "MP-SM-4bba-1", "service_type_prices": [{"eat_in": 10}, {"take_away": 10}, {"delivery": 10}, {"drive_thru": 10}, {"collection": 10}]}, {"size_plu": "MP-ME-b99d-2", "service_type_prices": [{"eat_in": 15}, {"take_away": 15}, {"delivery": 15}, {"drive_thru": 15}, {"collection": 15}]}]}, {"plu": "I-IT-761d", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item5-WithMod-GlobalPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["IT-GS-GS-D3E9-5", "IT-GS-GS-F2B2-7"], "modifier_groups_plu": ["MG-MO-d538-1", "MG-MO-d39d-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "GS-GS-013F-1", "service_type_prices": [{"eat_in": 12}, {"take_away": 12}, {"delivery": 12}, {"drive_thru": 12}, {"collection": 12}]}, {"size_plu": "GS-GS-2EBE-2", "service_type_prices": [{"eat_in": 14}, {"take_away": 14}, {"delivery": 14}, {"drive_thru": 14}, {"collection": 14}]}]}, {"plu": "I-IT-ab0b", "menu_plu": "MN-SA-A739-3", "category_plu": "MN-MC-SA-0DDB-3", "type": "item", "name": "ItemwithMPandGSandMod", "course_sno": 0, "description": "", "ingredients": "", "allergen_type": "none", "allergens": [], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["M-MP-S1-fe10-global_id01", "M-MP-S2-2f53-global_id11", "M-MP-S3-4b6b-global_id21"], "modifier_groups_plu": ["MG-EX-eb9d-1"], "status": "active", "vat_flag": 0, "taxes": [], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "I-IT-d95a", "menu_plu": "MN-SA-A739-3", "category_plu": "MN-MC-SA-0DDB-3", "type": "item", "name": "Item Comb", "course_sno": 0, "description": "", "ingredients": "", "allergen_type": "none", "allergens": [], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 2.99, "cost_price": 0, "item_options_plu": [], "modifier_groups_plu": ["MG-EX-c73b-1"], "status": "active", "vat_flag": 0, "taxes": [], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "I-IT-92d3", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item6-WithMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [5], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": ["MG-MO-d790-1"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "PZ-PI-21E3-1", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "pizza", "name": "Pizza1", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [5, 6], "included_toppings": 2, "allowed_toppings": 8, "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "topping_combos": ["PZ-TC-CR-B850-5", "PZ-TC-SA-4A3A-6", "PZ-TC-TP-2D83-7", "PZ-TC-CH-D902-8"], "sale_price": 0, "cost_price": 0, "pizza_options_plu": ["PZ-GS-GS-50D5-17", "PZ-GS-GS-01CE-18"], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "PZ-GS-GS-50D5-17", "service_type_prices": [{"eat_in": 4}, {"take_away": 4}, {"delivery": 4}, {"drive_thru": 4}, {"collection": 4}]}, {"size_plu": "PZ-GS-GS-01CE-18", "service_type_prices": [{"eat_in": 8}, {"take_away": 8}, {"delivery": 8}, {"drive_thru": 8}, {"collection": 8}]}]}], "query_meal_combos": [{"plu": "QM-QC-QM-7442-6", "qty": 1, "combination_title": "QMComboTitle1 - QueryMeal3", "item_details": [{"plu": "I-IT-761d", "option_plu": "IT-GS-GS-F2B2-7"}]}, {"plu": "QM-QC-IT-7A74-9", "qty": 1, "combination_title": "Item", "item_details": [{"plu": "I-IT-d95a", "option_plu": ""}]}, {"plu": "QM-QC-QM-C7DF-10", "qty": 1, "combination_title": "QMComboTitle1 - QueryMeal2", "item_details": [{"plu": "I-IT-af0a", "option_plu": "MP-SM-4bba-1"}]}, {"plu": "QM-QC-QM-5ABD-21", "qty": 1, "combination_title": "QMComboTitle1 - QueryMeal1", "item_details": [{"plu": "I-IT-761d", "option_plu": "IT-GS-GS-D3E9-5"}, {"plu": "I-IT-af0a", "option_plu": "MP-SM-4bba-1"}, {"plu": "I-IT-55bd", "option_plu": ""}]}], "query_meal": [{"plu": "QM-QU-5B00-1", "name": "QueryMeal1", "label": "", "price": 5, "status": "active", "item_details": {"plu": "I-IT-af0a", "item_option_plu": "MP-ME-b99d-2"}, "query_meal_combos_plu": ["QM-QC-QM-5ABD-21"], "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 1, "service_wise_price_details": {"eat_in": 5, "take_away": 5, "delivery": 5, "drive_thru": 5, "collection": 5}}, {"plu": "QM-QU-9D94-2", "name": "QueryMeal2.", "label": "", "price": 7, "status": "active", "item_details": {"plu": "PZ-PI-21E3-1", "item_option_plu": "PZ-GS-GS-50D5-17"}, "query_meal_combos_plu": ["QM-QC-QM-C7DF-10"], "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 0, "service_wise_price_details": {}}, {"plu": "QM-QU-6C85-3", "name": "QueryMeal3", "label": "", "price": 8, "status": "active", "item_details": {"plu": "I-IT-761d", "item_option_plu": "IT-GS-GS-D3E9-5"}, "query_meal_combos_plu": ["QM-QC-QM-7442-6"], "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 0, "service_wise_price_details": {}}, {"plu": "QM-S -4B8D-5", "name": "S Make it a Meal", "label": "", "price": 10.99, "status": "active", "item_details": {"plu": "I-IT-ab0b", "item_option_plu": "M-MP-S1-fe10-global_id01"}, "query_meal_combos_plu": ["QM-QC-IT-7A74-9"], "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 0, "service_wise_price_details": {}}], "meal_combos": [{"plu": "MDC-MD-c40c-1", "title": "MDcomboTitle1 - MealDeal1", "qty": 2, "items": [{"plu": "I-IT-af0a", "option_plu": "MP-SM-4bba-1"}]}, {"plu": "MDC-MD-3bab-2", "title": "MDcomboTitle2 - MealDeal1", "qty": 2, "items": [{"plu": "I-IT-c7be", "option_plu": ""}, {"plu": "I-IT-761d", "option_plu": "IT-GS-GS-D3E9-5"}]}, {"plu": "MDC-MD-643f-3", "title": "MDcomboTitle3 - MealDeal1", "qty": 1, "items": [{"plu": "PZ-PI-21E3-1", "option_plu": "PZ-GS-GS-50D5-17"}, {"plu": "PZ-PI-21E3-1", "option_plu": "PZ-GS-GS-01CE-18"}]}], "meal_deals": [{"plu": "MD-ME-b1ec", "name": "MealDeal1", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "description": "", "label": "", "price": 11, "status": "active", "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "combo_plu": ["MDC-MD-c40c-1", "MDC-MD-3bab-2", "MDC-MD-643f-3"], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 1, "service_wise_price_details": {"eat_in": 11, "take_away": 11, "delivery": 11, "drive_thru": 11, "collection": 11}}], "mix_and_match": [{"plu": "PR-MM-MI-BBED-1", "offer_title": "MixAndMatch1", "menu_plu": "MN-ME-ACE8-1", "promo_cat_plu": "PR-PC-PR-D400-1", "cat_plu": "MN-MC-ME-9B38-1", "buy_qty": 1, "get_qty": 1, "label": "", "discount_by": {"type": "free", "value": 0}, "buy_items": [{"plu": "I-IT-af0a", "item_option_plu": "MP-SM-4bba-1"}], "get_items": [{"plu": "I-IT-761d", "item_option_plu": "IT-GS-GS-F2B2-7"}, {"plu": "PZ-PI-21E3-1", "item_option_plu": "PZ-GS-GS-01CE-18"}], "status": "active", "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}}, {"plu": "PR-MM-MI-5DA6-2", "offer_title": "MixAndMatch2", "menu_plu": "MN-ME-B386-2", "promo_cat_plu": "PR-PC-PR-D400-1", "cat_plu": "MN-MC-ME-5638-2", "buy_qty": 1, "get_qty": 1, "label": "", "discount_by": {"type": "free", "value": 0}, "buy_items": [{"plu": "PZ-PI-21E3-1", "item_option_plu": "PZ-GS-GS-01CE-18"}], "get_items": [{"plu": "I-IT-55bd", "item_option_plu": ""}, {"plu": "I-IT-c7be", "item_option_plu": ""}, {"plu": "I-IT-761d", "item_option_plu": "IT-GS-GS-D3E9-5"}], "status": "active", "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/1 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-1-10", "end_date": "2029-9-11"}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": "https://www.grafterr.com/images/item.png"}], "global_sizes": [], "modifier_categories": [], "modifier_options": [], "modifiers": [], "modifier_groups": [], "item_options": [], "items": [{"plu": "I-IT-55bd", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item1-NoMod-SinglePrice", "course_sno": 1, "description": "This is description of an item", "ingredients": "milk, curd, ghee, chilli", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "https://www.grafterr.com/images/item.png", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2025-01-30", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/2 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-1-10", "end_date": "2029-9-11"}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": "https://www.grafterr.com/images/item.png"}], "global_sizes": [], "modifier_categories": [], "modifier_options": [], "modifiers": [], "modifier_groups": [], "item_options": [{"plu": "MP-SM-e745-1", "sale_price": 6, "cost_price": 3, "size": "", "size_name": "small"}, {"plu": "MP-ME-6245-2", "sale_price": 9, "cost_price": 4, "size": "", "size_name": "medium"}], "items": [{"plu": "I-IT-af79", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item2-NoMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [2, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-e745-1", "MP-ME-6245-2"], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2024-09-26", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/3 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-2FA5-3", "name": "ModCatSauce", "status": "active", "type": "sauce"}], "modifier_options": [{"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-c9c8-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-0d03-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-ef86"}], "modifiers": [{"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-ef86", "name": "Mod7-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-c9c8-1", "M-MP-GS-0d03-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-ea2c-1", "title": "ModGroupTitle1 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-ffee-2", "title": "ModGroupTitle2 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}], "item_options": [{"plu": "MP-SM-e745-1", "sale_price": 6, "cost_price": 3, "size": "", "size_name": "small"}, {"plu": "MP-ME-6245-2", "sale_price": 9, "cost_price": 4, "size": "", "size_name": "medium"}], "items": [{"plu": "I-IT-c7be", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item3-WithMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "none", "allergens": [], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": ["MG-MO-ea2c-1", "MG-MO-ffee-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/4 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}], "modifier_options": [{"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}], "modifiers": [{"plu": "M-MO-1b01", "name": "Mod3-ModCatNone-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-79ff-1", "title": "Option", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}], "min_cnt": 0, "max_cnt": 1, "included_cnt": 0}], "item_options": [{"plu": "MP-SM-4bba-1", "sale_price": 10, "cost_price": 5, "size": "", "size_name": "small"}, {"plu": "MP-ME-b99d-2", "sale_price": 15, "cost_price": 7, "size": "", "size_name": "medium"}], "items": [{"plu": "I-IT-af0a", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item4-WithMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [7, 9, 11, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-4bba-1", "MP-ME-b99d-2"], "modifier_groups_plu": ["MG-MO-79ff-1"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "MP-SM-4bba-1", "service_type_prices": [{"eat_in": 10}, {"take_away": 10}, {"delivery": 10}, {"drive_thru": 10}, {"collection": 10}]}, {"size_plu": "MP-ME-b99d-2", "service_type_prices": [{"eat_in": 15}, {"take_away": 15}, {"delivery": 15}, {"drive_thru": 15}, {"collection": 15}]}]}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/5 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}, {"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-5148-4", "name": "ModCatCheese", "status": "active", "type": "cheese"}], "modifier_options": [{"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-d83a-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-842a-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-2230-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-0775-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-c471"}], "modifiers": [{"plu": "M-MO-1b01", "name": "Mod3-ModCatNone-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-6061", "name": "Mod9-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-d83a-1", "M-MP-GS-842a-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-c471", "name": "Mod10-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-2230-1", "M-MP-GS-0775-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-d538-1", "title": "ModGroupTitle1 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "is_default": 0}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-d39d-2", "title": "ModGroupTitle2 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "is_default": 0}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}], "item_options": [{"plu": "IT-GS-GS-D3E9-5", "sale_price": 12, "cost_price": 6, "size": "GS-GS-013F-1", "size_name": ""}, {"plu": "IT-GS-GS-F2B2-7", "sale_price": 14, "cost_price": 7, "size": "GS-GS-2EBE-2", "size_name": ""}], "items": [{"plu": "I-IT-761d", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item5-WithMod-GlobalPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["IT-GS-GS-D3E9-5", "IT-GS-GS-F2B2-7"], "modifier_groups_plu": ["MG-MO-d538-1", "MG-MO-d39d-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "GS-GS-013F-1", "service_type_prices": [{"eat_in": 12}, {"take_away": 12}, {"delivery": 12}, {"drive_thru": 12}, {"collection": 12}]}, {"size_plu": "GS-GS-2EBE-2", "service_type_prices": [{"eat_in": 14}, {"take_away": 14}, {"delivery": 14}, {"drive_thru": 14}, {"collection": 14}]}]}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/6 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-09-06", "end_date": "2029-09-06"}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}, {"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-2FA5-3", "name": "ModCatSauce", "status": "active", "type": "sauce"}, {"plu": "MO-MC-MO-5148-4", "name": "ModCatCheese", "status": "active", "type": "cheese"}], "modifier_options": [{"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-89d7-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-17ee"}, {"plu": "M-MP-GS-761e-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-17ee"}, {"plu": "M-MP-GS-c9c8-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-0d03-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-3bf3-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-8a48-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-d83a-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-842a-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-2230-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-0775-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}], "modifiers": [{"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-17ee", "name": "Mod6-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-89d7-1", "M-MP-GS-761e-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-ef86", "name": "Mod7-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-c9c8-1", "M-MP-GS-0d03-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-143e", "name": "Mod8-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-3bf3-1", "M-MP-GS-8a48-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-6061", "name": "Mod9-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-d83a-1", "M-MP-GS-842a-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-c471", "name": "Mod10-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-2230-1", "M-MP-GS-0775-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [], "item_options": [], "pizza_options": [{"plu": "PZ-GS-GS-50D5-17", "price": 4, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-013F-1"}, {"plu": "PZ-GS-GS-01CE-18", "price": 8, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-2EBE-2"}], "pizza_topping_combos": [{"plu": "PZ-TC-CR-B850-5", "category_type": "crust", "modifier_category_plu": "MO-MC-MO-47EB-2", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 0, "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-11a7-2", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-89d7-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-761e-2", "price_type": "included", "is_default": 0, "split": "no"}]}, {"plu": "PZ-TC-SA-4A3A-6", "category_type": "sauce", "modifier_category_plu": "MO-MC-MO-2FA5-3", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-0d03-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-3bf3-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-8a48-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-TP-2D83-7", "category_type": "cheese", "modifier_category_plu": "MO-MC-MO-5148-4", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-CH-D902-8", "category_type": "none", "modifier_category_plu": "MO-MC-MO-0DCF-1", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 1, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "price_type": "included", "is_default": 0, "split": "yes"}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "price_type": "included", "is_default": 0, "split": "yes"}]}], "items": [{"plu": "PZ-PI-21E3-1", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "pizza", "name": "Pizza1", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [5, 6], "included_toppings": 2, "allowed_toppings": 8, "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "topping_combos": ["PZ-TC-CR-B850-5", "PZ-TC-SA-4A3A-6", "PZ-TC-TP-2D83-7", "PZ-TC-CH-D902-8"], "sale_price": 0, "cost_price": 0, "pizza_options_plu": ["PZ-GS-GS-50D5-17", "PZ-GS-GS-01CE-18"], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "PZ-GS-GS-50D5-17", "service_type_prices": [{"eat_in": 4}, {"take_away": 4}, {"delivery": 4}, {"drive_thru": 4}, {"collection": 4}]}, {"size_plu": "PZ-GS-GS-01CE-18", "service_type_prices": [{"eat_in": 8}, {"take_away": 8}, {"delivery": 8}, {"drive_thru": 8}, {"collection": 8}]}]}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/7 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-09-06", "end_date": "2029-09-06"}, "image_url": "", "sort_sno": 0}, {"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": ""}, {"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}, {"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-5148-4", "name": "ModCatCheese", "status": "active", "type": "cheese"}], "modifier_options": [{"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-d83a-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-842a-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-2230-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-0775-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-c471"}], "modifiers": [{"plu": "M-MO-1b01", "name": "Mod3-ModCatNone-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-6061", "name": "Mod9-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-d83a-1", "M-MP-GS-842a-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-c471", "name": "Mod10-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-2230-1", "M-MP-GS-0775-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-d538-1", "title": "ModGroupTitle1 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "is_default": 0}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-79ff-1", "title": "Option", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}], "min_cnt": 0, "max_cnt": 1, "included_cnt": 0}, {"plu": "MG-MO-d39d-2", "title": "ModGroupTitle2 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "is_default": 0}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}], "item_options": [{"plu": "MP-SM-4bba-1", "sale_price": 10, "cost_price": 5, "size": "", "size_name": "small"}, {"plu": "MP-ME-b99d-2", "sale_price": 15, "cost_price": 7, "size": "", "size_name": "medium"}, {"plu": "IT-GS-GS-D3E9-5", "sale_price": 12, "cost_price": 6, "size": "GS-GS-013F-1", "size_name": ""}, {"plu": "IT-GS-GS-F2B2-7", "sale_price": 14, "cost_price": 7, "size": "GS-GS-2EBE-2", "size_name": ""}], "pizza_options": [], "pizza_topping_combos": [], "items": [{"plu": "I-IT-af0a", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item4-WithMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [7, 9, 11, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-4bba-1", "MP-ME-b99d-2"], "modifier_groups_plu": ["MG-MO-79ff-1"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "MP-SM-4bba-1", "service_type_prices": [{"eat_in": 10}, {"take_away": 10}, {"delivery": 10}, {"drive_thru": 10}, {"collection": 10}]}, {"size_plu": "MP-ME-b99d-2", "service_type_prices": [{"eat_in": 15}, {"take_away": 15}, {"delivery": 15}, {"drive_thru": 15}, {"collection": 15}]}]}, {"plu": "I-IT-761d", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item5-WithMod-GlobalPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["IT-GS-GS-D3E9-5", "IT-GS-GS-F2B2-7"], "modifier_groups_plu": ["MG-MO-d538-1", "MG-MO-d39d-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "GS-GS-013F-1", "service_type_prices": [{"eat_in": 12}, {"take_away": 12}, {"delivery": 12}, {"drive_thru": 12}, {"collection": 12}]}, {"size_plu": "GS-GS-2EBE-2", "service_type_prices": [{"eat_in": 14}, {"take_away": 14}, {"delivery": 14}, {"drive_thru": 14}, {"collection": 14}]}]}, {"plu": "I-IT-55bd", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item1-NoMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2025-01-30", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}], "query_meal_combos": [{"plu": "QM-QC-QM-5ABD-21", "qty": 1, "combination_title": "QMComboTitle1 - QueryMeal1", "item_details": [{"plu": "I-IT-761d", "option_plu": "IT-GS-GS-D3E9-5"}, {"plu": "I-IT-af0a", "option_plu": "MP-SM-4bba-1"}, {"plu": "I-IT-55bd", "option_plu": ""}]}], "query_meal": [{"plu": "QM-QU-5B00-1", "name": "QueryMeal1", "label": "", "price": 5, "status": "active", "item_details": {"plu": "I-IT-af0a", "item_option_plu": "MP-ME-b99d-2"}, "query_meal_combos_plu": ["QM-QC-QM-5ABD-21"], "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 1, "service_wise_price_details": {"eat_in": 5, "take_away": 5, "delivery": 5, "drive_thru": 5, "collection": 5}}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/8 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-09-06", "end_date": "2029-09-06"}, "image_url": "", "sort_sno": 0}, {"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": ""}, {"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}, {"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-5148-4", "name": "ModCatCheese", "status": "active", "type": "cheese"}, {"plu": "MO-MC-MO-2FA5-3", "name": "ModCatSauce", "status": "active", "type": "sauce"}], "modifier_options": [{"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-d83a-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-842a-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-2230-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-0775-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-c9c8-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-0d03-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-3bf3-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-8a48-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-89d7-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-17ee"}, {"plu": "M-MP-GS-761e-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-17ee"}], "modifiers": [{"plu": "M-MO-1b01", "name": "Mod3-ModCatNone-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-6061", "name": "Mod9-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-d83a-1", "M-MP-GS-842a-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-c471", "name": "Mod10-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-2230-1", "M-MP-GS-0775-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-17ee", "name": "Mod6-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-89d7-1", "M-MP-GS-761e-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-ef86", "name": "Mod7-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-c9c8-1", "M-MP-GS-0d03-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-143e", "name": "Mod8-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-3bf3-1", "M-MP-GS-8a48-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-d538-1", "title": "ModGroupTitle1 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "is_default": 0}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-79ff-1", "title": "Option", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}], "min_cnt": 0, "max_cnt": 1, "included_cnt": 0}, {"plu": "MG-MO-d39d-2", "title": "ModGroupTitle2 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "is_default": 0}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}], "item_options": [{"plu": "MP-SM-4bba-1", "sale_price": 10, "cost_price": 5, "size": "", "size_name": "small"}, {"plu": "MP-ME-b99d-2", "sale_price": 15, "cost_price": 7, "size": "", "size_name": "medium"}, {"plu": "IT-GS-GS-D3E9-5", "sale_price": 12, "cost_price": 6, "size": "GS-GS-013F-1", "size_name": ""}, {"plu": "IT-GS-GS-F2B2-7", "sale_price": 14, "cost_price": 7, "size": "GS-GS-2EBE-2", "size_name": ""}], "pizza_topping_combos": [{"plu": "PZ-TC-CR-B850-5", "category_type": "crust", "modifier_category_plu": "MO-MC-MO-47EB-2", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 0, "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-11a7-2", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-89d7-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-761e-2", "price_type": "included", "is_default": 0, "split": "no"}]}, {"plu": "PZ-TC-SA-4A3A-6", "category_type": "sauce", "modifier_category_plu": "MO-MC-MO-2FA5-3", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-0d03-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-3bf3-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-8a48-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-TP-2D83-7", "category_type": "cheese", "modifier_category_plu": "MO-MC-MO-5148-4", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-CH-D902-8", "category_type": "none", "modifier_category_plu": "MO-MC-MO-0DCF-1", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 1, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "price_type": "included", "is_default": 0, "split": "yes"}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "price_type": "included", "is_default": 0, "split": "yes"}]}], "pizza_options": [{"plu": "PZ-GS-GS-50D5-17", "price": 4, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-013F-1"}, {"plu": "PZ-GS-GS-01CE-18", "price": 8, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-2EBE-2"}], "items": [{"plu": "I-IT-af0a", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item4-WithMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [7, 9, 11, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-4bba-1", "MP-ME-b99d-2"], "modifier_groups_plu": ["MG-MO-79ff-1"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "MP-SM-4bba-1", "service_type_prices": [{"eat_in": 10}, {"take_away": 10}, {"delivery": 10}, {"drive_thru": 10}, {"collection": 10}]}, {"size_plu": "MP-ME-b99d-2", "service_type_prices": [{"eat_in": 15}, {"take_away": 15}, {"delivery": 15}, {"drive_thru": 15}, {"collection": 15}]}]}, {"plu": "I-IT-761d", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item5-WithMod-GlobalPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["IT-GS-GS-D3E9-5", "IT-GS-GS-F2B2-7"], "modifier_groups_plu": ["MG-MO-d538-1", "MG-MO-d39d-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "GS-GS-013F-1", "service_type_prices": [{"eat_in": 12}, {"take_away": 12}, {"delivery": 12}, {"drive_thru": 12}, {"collection": 12}]}, {"size_plu": "GS-GS-2EBE-2", "service_type_prices": [{"eat_in": 14}, {"take_away": 14}, {"delivery": 14}, {"drive_thru": 14}, {"collection": 14}]}]}, {"plu": "I-IT-55bd", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item1-NoMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2025-01-30", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "PZ-PI-21E3-1", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "pizza", "name": "Pizza1", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [5, 6], "included_toppings": 2, "allowed_toppings": 8, "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "topping_combos": ["PZ-TC-CR-B850-5", "PZ-TC-SA-4A3A-6", "PZ-TC-TP-2D83-7", "PZ-TC-CH-D902-8"], "sale_price": 0, "cost_price": 0, "pizza_options_plu": ["PZ-GS-GS-50D5-17", "PZ-GS-GS-01CE-18"], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "PZ-GS-GS-50D5-17", "service_type_prices": [{"eat_in": 4}, {"take_away": 4}, {"delivery": 4}, {"drive_thru": 4}, {"collection": 4}]}, {"size_plu": "PZ-GS-GS-01CE-18", "service_type_prices": [{"eat_in": 8}, {"take_away": 8}, {"delivery": 8}, {"drive_thru": 8}, {"collection": 8}]}]}], "query_meal_combos": [{"plu": "QM-QC-QM-C7DF-10", "qty": 1, "combination_title": "QMComboTitle1 - QueryMeal2", "item_details": [{"plu": "I-IT-af0a", "option_plu": "MP-SM-4bba-1"}]}], "query_meal": [{"plu": "QM-QU-9D94-2", "name": "QueryMeal2.", "label": "", "price": 7, "status": "active", "item_details": {"plu": "PZ-PI-21E3-1", "item_option_plu": "PZ-GS-GS-50D5-17"}, "query_meal_combos_plu": ["QM-QC-QM-C7DF-10"], "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 0, "service_wise_price_details": {}}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/9 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 123456, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-09-06", "end_date": "2029-09-06"}, "image_url": "", "sort_sno": 0}, {"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": ""}, {"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}, {"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-5148-4", "name": "ModCatCheese", "status": "active", "type": "cheese"}, {"plu": "MO-MC-MO-2FA5-3", "name": "ModCatSauce", "status": "active", "type": "sauce"}], "modifier_options": [{"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-d83a-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-842a-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-2230-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-0775-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-c9c8-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-0d03-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-3bf3-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-8a48-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-89d7-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-17ee"}, {"plu": "M-MP-GS-761e-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-17ee"}], "modifiers": [{"plu": "M-MO-1b01", "name": "Mod3-ModCatNone-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-6061", "name": "Mod9-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-d83a-1", "M-MP-GS-842a-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-c471", "name": "Mod10-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-2230-1", "M-MP-GS-0775-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-17ee", "name": "Mod6-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-89d7-1", "M-MP-GS-761e-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-ef86", "name": "Mod7-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-c9c8-1", "M-MP-GS-0d03-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-143e", "name": "Mod8-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-3bf3-1", "M-MP-GS-8a48-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-ea2c-1", "title": "ModGroupTitle1 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-ffee-2", "title": "ModGroupTitle2 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-d538-1", "title": "ModGroupTitle1 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "is_default": 0}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-79ff-1", "title": "Option", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}], "min_cnt": 0, "max_cnt": 1, "included_cnt": 0}, {"plu": "MG-MO-d39d-2", "title": "ModGroupTitle2 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "is_default": 0}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}], "item_options": [{"plu": "MP-SM-4bba-1", "sale_price": 10, "cost_price": 5, "size": "", "size_name": "small"}, {"plu": "MP-ME-b99d-2", "sale_price": 15, "cost_price": 7, "size": "", "size_name": "medium"}, {"plu": "IT-GS-GS-D3E9-5", "sale_price": 12, "cost_price": 6, "size": "GS-GS-013F-1", "size_name": ""}, {"plu": "IT-GS-GS-F2B2-7", "sale_price": 14, "cost_price": 7, "size": "GS-GS-2EBE-2", "size_name": ""}], "pizza_topping_combos": [{"plu": "PZ-TC-CR-B850-5", "category_type": "crust", "modifier_category_plu": "MO-MC-MO-47EB-2", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 0, "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-11a7-2", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-89d7-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-761e-2", "price_type": "included", "is_default": 0, "split": "no"}]}, {"plu": "PZ-TC-SA-4A3A-6", "category_type": "sauce", "modifier_category_plu": "MO-MC-MO-2FA5-3", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-0d03-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-3bf3-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-8a48-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-TP-2D83-7", "category_type": "cheese", "modifier_category_plu": "MO-MC-MO-5148-4", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-CH-D902-8", "category_type": "none", "modifier_category_plu": "MO-MC-MO-0DCF-1", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 1, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "price_type": "included", "is_default": 0, "split": "yes"}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "price_type": "included", "is_default": 0, "split": "yes"}]}], "pizza_options": [{"plu": "PZ-GS-GS-50D5-17", "price": 4, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-013F-1"}, {"plu": "PZ-GS-GS-01CE-18", "price": 8, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-2EBE-2"}], "items": [{"plu": "I-IT-c7be", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item3-WithMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "none", "allergens": [], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": ["MG-MO-ea2c-1", "MG-MO-ffee-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "I-IT-af0a", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item4-WithMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [7, 9, 11, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-4bba-1", "MP-ME-b99d-2"], "modifier_groups_plu": ["MG-MO-79ff-1"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "MP-SM-4bba-1", "service_type_prices": [{"eat_in": 10}, {"take_away": 10}, {"delivery": 10}, {"drive_thru": 10}, {"collection": 10}]}, {"size_plu": "MP-ME-b99d-2", "service_type_prices": [{"eat_in": 15}, {"take_away": 15}, {"delivery": 15}, {"drive_thru": 15}, {"collection": 15}]}]}, {"plu": "I-IT-761d", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item5-WithMod-GlobalPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["IT-GS-GS-D3E9-5", "IT-GS-GS-F2B2-7"], "modifier_groups_plu": ["MG-MO-d538-1", "MG-MO-d39d-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "GS-GS-013F-1", "service_type_prices": [{"eat_in": 12}, {"take_away": 12}, {"delivery": 12}, {"drive_thru": 12}, {"collection": 12}]}, {"size_plu": "GS-GS-2EBE-2", "service_type_prices": [{"eat_in": 14}, {"take_away": 14}, {"delivery": 14}, {"drive_thru": 14}, {"collection": 14}]}]}, {"plu": "I-IT-55bd", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item1-NoMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2025-01-30", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "PZ-PI-21E3-1", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "pizza", "name": "Pizza1", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [5, 6], "included_toppings": 2, "allowed_toppings": 8, "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "topping_combos": ["PZ-TC-CR-B850-5", "PZ-TC-SA-4A3A-6", "PZ-TC-TP-2D83-7", "PZ-TC-CH-D902-8"], "sale_price": 0, "cost_price": 0, "pizza_options_plu": ["PZ-GS-GS-50D5-17", "PZ-GS-GS-01CE-18"], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "PZ-GS-GS-50D5-17", "service_type_prices": [{"eat_in": 4}, {"take_away": 4}, {"delivery": 4}, {"drive_thru": 4}, {"collection": 4}]}, {"size_plu": "PZ-GS-GS-01CE-18", "service_type_prices": [{"eat_in": 8}, {"take_away": 8}, {"delivery": 8}, {"drive_thru": 8}, {"collection": 8}]}]}], "query_meal_combos": [], "query_meal": [], "meal_combos": [{"plu": "MDC-MD-c40c-1", "title": "MDcomboTitle1 - MealDeal1", "qty": 2, "items": [{"plu": "I-IT-af0a", "option_plu": "MP-SM-4bba-1"}]}, {"plu": "MDC-MD-3bab-2", "title": "MDcomboTitle2 - MealDeal1", "qty": 2, "items": [{"plu": "I-IT-c7be", "option_plu": ""}, {"plu": "I-IT-761d", "option_plu": "IT-GS-GS-D3E9-5"}]}, {"plu": "MDC-MD-643f-3", "title": "MDcomboTitle3 - MealDeal1", "qty": 1, "items": [{"plu": "PZ-PI-21E3-1", "option_plu": "PZ-GS-GS-50D5-17"}, {"plu": "PZ-PI-21E3-1", "option_plu": "PZ-GS-GS-01CE-18"}]}], "meal_deals": [{"plu": "MD-ME-b1ec", "name": "MealDeal1", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "description": "", "label": "", "price": 11, "status": "active", "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "combo_plu": ["MDC-MD-c40c-1", "MDC-MD-3bab-2", "MDC-MD-643f-3"], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "is_service_type_price_applicable": 1, "service_wise_price_details": {"eat_in": 11, "take_away": 11, "delivery": 11, "drive_thru": 11, "collection": 11}}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
d14c071e-db93-4c71-821b-9ad7ed8b576d/ba3b718b-150e-4c22-a427-c484c240a395/3/10 | Grafterr | APIs | null | /menu/read | Here user can get menu data through json | 200 | null | {"status": 200, "message": "Data fetched successfully!", "menu_data": {"business_detail": {"business_id": 4572747, "vat_type": "including"}, "tax_list": [{"plu": "TX-TA-C531-1", "name": "Tax1", "tax_number": "TaxNo1"}], "menu": [{"plu": "MN-ME-ACE8-1", "name": "Menu1", "status": "active", "is_festive_menu": 1, "festive_menu_details": {"start_date": "2023-09-06", "end_date": "2029-09-06"}, "image_url": "", "sort_sno": 0}, {"plu": "MN-ME-B386-2", "name": "Menu2", "status": "active", "is_festive_menu": 0, "festive_menu_details": {}, "image_url": "", "sort_sno": 0}], "categories": [{"plu": "MN-MC-ME-9B38-1", "menu_plu": "MN-ME-ACE8-1", "name": "MenuCat1", "status": "active", "course_sno": 1, "print_order": 1, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2029-09-06", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "image_url": ""}, {"plu": "MN-MC-ME-5638-2", "menu_plu": "MN-ME-B386-2", "name": "MenuCat2", "status": "active", "course_sno": 1, "print_order": 2, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1}, "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "image_url": ""}], "global_sizes": [{"plu": "GS-GS-013F-1", "size": "gsize1"}, {"plu": "GS-GS-2EBE-2", "size": "gsize2"}, {"plu": "GS-GI-3C09-3", "size": "gisze3"}], "modifier_categories": [{"plu": "MO-MC-MO-0DCF-1", "name": "ModCatNone", "status": "active", "type": "none"}, {"plu": "MO-MC-MO-47EB-2", "name": "ModCatCrust", "status": "active", "type": "crust"}, {"plu": "MO-MC-MO-5148-4", "name": "ModCatCheese", "status": "active", "type": "cheese"}, {"plu": "MO-MC-MO-2FA5-3", "name": "ModCatSauce", "status": "active", "type": "sauce"}], "modifier_options": [{"plu": "M-MP-GS-6dbc-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-fea3-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-8023"}, {"plu": "M-MP-GS-b45b-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-11a7-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-bf24"}, {"plu": "M-MP-GS-d83a-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-842a-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-6061"}, {"plu": "M-MP-GS-2230-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-0775-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-c471"}, {"plu": "M-MP-GS-c9c8-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-0d03-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-ef86"}, {"plu": "M-MP-GS-3bf3-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-8a48-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-143e"}, {"plu": "M-MP-GS-89d7-1", "sale_price": 4, "cost_price": 2, "size": "GS-GS-013F-1", "modifier_plu": "M-MO-17ee"}, {"plu": "M-MP-GS-761e-2", "sale_price": 6, "cost_price": 3, "size": "GS-GS-2EBE-2", "modifier_plu": "M-MO-17ee"}], "modifiers": [{"plu": "M-MO-1b01", "name": "Mod3-ModCatNone-SinglePrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 10, "cost_price": 5, "vat_flag": 0, "taxes": [], "modifier_options_plu": [], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-8023", "name": "Mod4-ModCatNone-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-0DCF-1", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-6dbc-1", "M-MP-GS-fea3-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-bf24", "name": "Mod5-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-b45b-1", "M-MP-GS-11a7-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-6061", "name": "Mod9-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-d83a-1", "M-MP-GS-842a-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-c471", "name": "Mod10-ModCatCheese-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-5148-4", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-2230-1", "M-MP-GS-0775-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-17ee", "name": "Mod6-ModCatCrust-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-47EB-2", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-89d7-1", "M-MP-GS-761e-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-ef86", "name": "Mod7-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "modifier_options_plu": ["M-MP-GS-c9c8-1", "M-MP-GS-0d03-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}, {"plu": "M-MO-143e", "name": "Mod8-ModCatSauce-GlobalPrice", "description": "", "modifier_cat_plu": "MO-MC-MO-2FA5-3", "sale_price": 0, "cost_price": 0, "vat_flag": 0, "taxes": [], "modifier_options_plu": ["M-MP-GS-3bf3-1", "M-MP-GS-8a48-2"], "allergen_type": "none", "allergens": [], "status": "active", "image_url": ""}], "modifier_groups": [{"plu": "MG-MO-ea2c-1", "title": "ModGroupTitle1 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-ffee-2", "title": "ModGroupTitle2 - Item3-WithMod-SinglePrice", "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-d538-1", "title": "ModGroupTitle1 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "is_default": 0}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}, {"plu": "MG-MO-79ff-1", "title": "Option", "modifiers": [{"plu": "M-MO-1b01", "modifier_option_plu": "", "is_default": 0}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "is_default": 0}], "min_cnt": 0, "max_cnt": 1, "included_cnt": 0}, {"plu": "MG-MO-d39d-2", "title": "ModGroupTitle2 - Item5-WithMod-GlobalPrice", "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "is_default": 0}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "is_default": 0}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "is_default": 0}], "min_cnt": 1, "max_cnt": 2, "included_cnt": 0}], "item_options": [{"plu": "MP-SM-4bba-1", "sale_price": 10, "cost_price": 5, "size": "", "size_name": "small"}, {"plu": "MP-ME-b99d-2", "sale_price": 15, "cost_price": 7, "size": "", "size_name": "medium"}, {"plu": "IT-GS-GS-D3E9-5", "sale_price": 12, "cost_price": 6, "size": "GS-GS-013F-1", "size_name": ""}, {"plu": "IT-GS-GS-F2B2-7", "sale_price": 14, "cost_price": 7, "size": "GS-GS-2EBE-2", "size_name": ""}], "pizza_topping_combos": [{"plu": "PZ-TC-CR-B850-5", "category_type": "crust", "modifier_category_plu": "MO-MC-MO-47EB-2", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 0, "modifiers": [{"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-b45b-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-bf24", "modifier_option_plu": "M-MP-GS-11a7-2", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-89d7-1", "price_type": "included", "is_default": 0, "split": "no"}, {"plu": "M-MO-17ee", "modifier_option_plu": "M-MP-GS-761e-2", "price_type": "included", "is_default": 0, "split": "no"}]}, {"plu": "PZ-TC-SA-4A3A-6", "category_type": "sauce", "modifier_category_plu": "MO-MC-MO-2FA5-3", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-c9c8-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-ef86", "modifier_option_plu": "M-MP-GS-0d03-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-3bf3-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-143e", "modifier_option_plu": "M-MP-GS-8a48-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-TP-2D83-7", "category_type": "cheese", "modifier_category_plu": "MO-MC-MO-5148-4", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 0, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-d83a-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-6061", "modifier_option_plu": "M-MP-GS-842a-2", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-2230-1", "price_type": "excluded", "is_default": 0, "split": "yes"}, {"plu": "M-MO-c471", "modifier_option_plu": "M-MP-GS-0775-2", "price_type": "excluded", "is_default": 0, "split": "yes"}]}, {"plu": "PZ-TC-CH-D902-8", "category_type": "none", "modifier_category_plu": "MO-MC-MO-0DCF-1", "max_toppings_choose_cnt": 1, "is_included_in_toppings": 1, "buy_more_than_max_qty": 1, "modifiers": [{"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-6dbc-1", "price_type": "included", "is_default": 0, "split": "yes"}, {"plu": "M-MO-8023", "modifier_option_plu": "M-MP-GS-fea3-2", "price_type": "included", "is_default": 0, "split": "yes"}]}], "pizza_options": [{"plu": "PZ-GS-GS-50D5-17", "price": 4, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-013F-1"}, {"plu": "PZ-GS-GS-01CE-18", "price": 8, "extra_topping_price": 0, "purchase_option": "both", "size": "GS-GS-2EBE-2"}], "items": [{"plu": "I-IT-c7be", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item3-WithMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "none", "allergens": [], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": ["MG-MO-ea2c-1", "MG-MO-ffee-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "I-IT-af0a", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item4-WithMod-MultiPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [7, 9, 11, 6], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["MP-SM-4bba-1", "MP-ME-b99d-2"], "modifier_groups_plu": ["MG-MO-79ff-1"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "MP-SM-4bba-1", "service_type_prices": [{"eat_in": 10}, {"take_away": 10}, {"delivery": 10}, {"drive_thru": 10}, {"collection": 10}]}, {"size_plu": "MP-ME-b99d-2", "service_type_prices": [{"eat_in": 15}, {"take_away": 15}, {"delivery": 15}, {"drive_thru": 15}, {"collection": 15}]}]}, {"plu": "I-IT-761d", "menu_plu": "MN-ME-B386-2", "category_plu": "MN-MC-ME-5638-2", "type": "item", "name": "Item5-WithMod-GlobalPrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 0, "cost_price": 0, "item_options_plu": ["IT-GS-GS-D3E9-5", "IT-GS-GS-F2B2-7"], "modifier_groups_plu": ["MG-MO-d538-1", "MG-MO-d39d-2"], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "GS-GS-013F-1", "service_type_prices": [{"eat_in": 12}, {"take_away": 12}, {"delivery": 12}, {"drive_thru": 12}, {"collection": 12}]}, {"size_plu": "GS-GS-2EBE-2", "service_type_prices": [{"eat_in": 14}, {"take_away": 14}, {"delivery": 14}, {"drive_thru": 14}, {"collection": 14}]}]}, {"plu": "I-IT-55bd", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "item", "name": "Item1-NoMod-SinglePrice", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [3, 9], "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "sale_price": 10, "cost_price": 5, "item_options_plu": [], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "specific", "start_date": "2023-09-06", "end_date": "2025-01-30", "day_settings": {"mon": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "tue": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "wed": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "thu": {"from_time": "12:00 AM", "to_time": "11:30 PM"}, "fri": {"from_time": "12:00 AM", "to_time": "11:30 PM"}}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 0, "service_wise_price_details": []}, {"plu": "PZ-PI-21E3-1", "menu_plu": "MN-ME-ACE8-1", "category_plu": "MN-MC-ME-9B38-1", "type": "pizza", "name": "Pizza1", "course_sno": 1, "description": "", "ingredients": "", "allergen_type": "specific", "allergens": [5, 6], "included_toppings": 2, "allowed_toppings": 8, "consent_available": 0, "consent_message": "", "label": "", "query_meal_question": "Would you like to have a meal with this item?", "topping_combos": ["PZ-TC-CR-B850-5", "PZ-TC-SA-4A3A-6", "PZ-TC-TP-2D83-7", "PZ-TC-CH-D902-8"], "sale_price": 0, "cost_price": 0, "pizza_options_plu": ["PZ-GS-GS-50D5-17", "PZ-GS-GS-01CE-18"], "modifier_groups_plu": [], "status": "active", "vat_flag": 1, "taxes": [{"tax_plu": "TX-TA-C531-1", "take_away": 10, "delivery": 10, "drive_thru": 10, "collection": 10}], "image_url": "", "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}, "sale": {"pos_status": 1, "web_status": 1, "mob_status": 1, "cless_status": 1, "urbanpiper_status": 0}, "is_service_type_price_applicable": 1, "service_wise_price_details": [{"size_plu": "PZ-GS-GS-50D5-17", "service_type_prices": [{"eat_in": 4}, {"take_away": 4}, {"delivery": 4}, {"drive_thru": 4}, {"collection": 4}]}, {"size_plu": "PZ-GS-GS-01CE-18", "service_type_prices": [{"eat_in": 8}, {"take_away": 8}, {"delivery": 8}, {"drive_thru": 8}, {"collection": 8}]}]}], "query_meal_combos": [], "query_meal": [], "meal_combos": [], "meal_deals": [], "mix_and_match": [{"plu": "PR-MM-MI-BBED-1", "offer_title": "MixAndMatch1", "menu_plu": "MN-ME-ACE8-1", "promo_cat_plu": "PR-PC-PR-D400-1", "cat_plu": "MN-MC-ME-9B38-1", "buy_qty": 1, "get_qty": 1, "label": "", "discount_by": {"type": "free", "value": 0}, "buy_items": [{"plu": "I-IT-af0a", "item_option_plu": "MP-SM-4bba-1"}], "get_items": [{"plu": "I-IT-761d", "item_option_plu": "IT-GS-GS-F2B2-7"}, {"plu": "PZ-PI-21E3-1", "item_option_plu": "PZ-GS-GS-01CE-18"}], "status": "active", "offer_applicable_services": ["eat_in", "take_away", "delivery", "drive_thru", "collection"], "availability_settings": {"type": "all", "start_date": "", "end_date": "", "day_settings": {}}}]}} | {"type": "object", "properties": {"status": {"type": "integer", "description": "status code of the response", "format": "int32", "default": 200, "minimum": -2147483648, "maximum": 2147483647}, "message": {"type": "string", "description": "response message", "default": "Data fetched successfully!"}, "menu_data": {"type": "object", "description": "It contains the fetched menu data", "properties": {"business_detail": {"title": "Business_detail", "type": "object", "properties": {"business_id": {"title": "business_id", "type": "integer", "description": "Unique ID of each business", "minimum": 0}, "vat_type": {"title": "Vat_type", "type": "string", "description": "Vat type of the business", "default": "including", "enum": ["including", "excluding"]}}}, "tax_list": {"title": "Tax_list", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the tax", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the tax", "minLength": 1, "maxLength": 50}, "tax_number": {"title": "Tax_number", "type": "string", "description": "Tax Number", "minLength": 1, "maxLength": 50}}}}, "menu": {"title": "Menu", "type": "array", "description": "It contains the details about the menu", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the menu", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu", "enum": ["active", "inactive"]}, "is_festive_menu": {"title": "Is_festive_menu", "type": "integer", "description": "Festive menu status of the menu. Value 1 denotes the current menu as a festive menu and is mostly likely to available only for a particular time period mentioned. Value 0 will make this menu available on all dates.", "default": 0, "enum": [0, 1]}, "festive_menu_details": {"title": "Festive_menu_details", "type": "object", "description": "It holds the start_date and end_date for the festive menu.", "properties": {"start_date": {"title": "Start_date", "type": "string", "default": ""}, "end_date": {"title": "End_date", "type": "string", "default": ""}}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the menu", "default": "", "maxLength": 255}, "sort_sno": {"title": "Sort_sno", "type": "integer", "description": "Sort serial number will sort the given menu in the desired order", "default": 0, "minimum": 0}}}}, "categories": {"title": "Categories", "type": "array", "description": "Menus can be further divided into multiple categories. For example, the menu 'Breakfast' can have categories like 'Veg', 'NonVeg' etc. Categories help to further segregate the food items inside a particular menu.", "default": [], "items": {"properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the category", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which this category belongs", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the menu category", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation status of the menu category", "default": "", "enum": ["active", "inactive"]}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "It contains the course number for the given category is associated. O means it is not associate with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "print_order": {"title": "Print_order", "type": "integer", "description": "Print order will decide the printing order of the category items on print receipt.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30]}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}}}}, "global_sizes": {"title": "Global_sizes", "type": "array", "description": "Global sizes can be defined by the user and used them for categorizing the items, modifiers etc according to various sizes. For example, 'small', 'medium', 'large' etc. Instead of everytime creating new size for each item or modifiers, existing gloval sizes can be used.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the global size", "minLength": 1, "maxLength": 50}, "size": {"title": "Size", "type": "string", "description": "PLU of the size", "minLength": 1, "maxLength": 50}}}}, "modifier_categories": {"title": "Modifier_categories", "type": "array", "description": "Modifier categories allows the to add multiple variations to the food items. Suppose you are having a Pizza item. And it can have multiple variation categories such crust, topping, sauce etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "status": {"title": "Status", "type": "string", "description": "Activation of the modifier category", "enum": ["active", "inactive"]}, "type": {"title": "Type", "type": "string", "description": "If the modifier category is related with the pizza items, the possible values are - 'crust', 'sauce', 'cheese'. Else, value will be 'none'.", "enum": ["none", "crust", "sauce", "cheese"]}}}}, "modifier_options": {"title": "Modifier_options", "type": "array", "description": "Every modifier can have a multiple modifier options. These are like variations to the given modifier. Modifier options hold the information about sale price, cost price, global size etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_plu": {"title": "Modifier_plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}}}}, "modifiers": {"title": "Modifiers", "type": "array", "description": "Modifiers are the actual variations of the item. Previously we have added modifier categories and now we can add modifiers belonging to these modifier categories. For example. if we have added 'Crust' modifier category, then we can have the modifiers to it like 'Wheat Grain', 'Multi Grain' etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the modifier", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "modifier_cat_plu": {"title": "Modifier_cat_plu", "type": "string", "description": "PLU of the modifier category to which modifier belongs. It may be empty as well.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the modifier", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the modifier", "default": 0, "minimum": 0}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the modifier or not. If its value is 1, then tax is application and if value is 0, then is not applicable.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "description": "It holds the information about the applicable taxes on the modifier. Taxes are need to inserted if value of 'vat_flag' is 1. It is an array containing objects.", "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_options_plu": {"title": "Modifier_options_plu", "type": "array", "description": "It contains the modifier option PLUs", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "allergen_type": {"title": "Allergen_type", "type": "string", "description": "It denotes the status of the allergen. 'ask_staff' means contact the staff to get the allergen info. \"none\" if no allergens present and \"specific\" means allergens are present and mention their code in the in ''allergens\" attribute.", "enum": ["specific", "none", "ask_staff"]}, "allergens": {"title": "Allergent", "type": "array", "description": "This array is having numerical code of the allergens which are already created. Meaning of each code allergens are--> {1:Papad, 2:Gluten, 3:Nuts, 4: Crustaceans, 5:Egg, 6:Fish, 7:Peanuts, 8:Soybeans, 9:Mustard, 10: Sesame, 11: Milk, 12: Celery, 13: Sulphur dioxide}", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "status": {"title": "Status", "type": "string", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "default": "", "maxLength": 500}}}}, "modifier_groups": {"title": "Modifier_groups", "type": "array", "description": "As a name suggest they are the collection of the various modifiers. Modifier group is having attributes like min count and max count which define how many minimum and maximum number of modifiers can be selected by the customer from particular modifier group. Also included count defines how many modifiers are included in a price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the modifier group", "default": "", "minLength": 1, "maxLength": 50}, "modifiers": {"title": "Modifiers", "type": "array", "description": "This is the array containing modifier objects. Modifier object contains the modifier information.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "PLU of the modifier option", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 1 means the given option will be selected as a default modifier for the given group.", "default": 0, "enum": [0, 1]}}}}, "min_cnt": {"title": "Min_cnt", "type": "integer", "description": "This attribute indicated the minimum number of modifiers which need to selected from the given modifier group.", "default": 0, "minimum": 0}, "max_cnt": {"title": "Max_cnt", "type": "integer", "description": "This attribute indicated the maximum number of modifiers which can be selected from a given modifier group.", "default": 0, "minimum": 0}, "included_cnt": {"title": "Included_cnt", "type": "integer", "description": "This attribute indicated the number of modifiers included in a price and no need pay additional price for them.", "default": 0, "minimum": 0}}}}, "item_options": {"title": "Item_options", "type": "array", "description": "Item options are very much similar to modifier options. With the help of them, user can create multiple size and price variations of the item. It may also help define the sale and cost price for them.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item option", "default": "", "minLength": 1, "maxLength": 50}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item option", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item option", "default": 0, "minimum": 0}, "size": {"title": "Size", "type": "string", "description": "If the item is having global size, then its PLU will be shown here.", "default": "", "minLength": 0, "maxLength": 50}, "size_name": {"title": "Size_name", "type": "string", "description": "If the given item is multiprice item but it does not have the global size, it will show the name of the size", "default": ""}}}}, "pizza_topping_combos": {"title": "Pizza_topping_combos", "type": "array", "description": "A pizza item can have various layer ingrediets like crust, sauce, cheese, toppings etc. And every layer may have multiple variations that is modifiers. So, pizza topping combos holds this kind of information. It is having attributes like modifiers, modifier categories, max number of toppings etc are used for the configuration of pizza item.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza topping combo", "default": "", "minLength": 1, "maxLength": 50}, "category_type": {"title": "Category_type", "type": "string", "description": "It is the pizza topping's category type. none value is used for the pizza toppings", "enum": ["crust", "cheese", "sauce", "none"]}, "modifier_category_plu": {"title": "Modifier_category_plu", "type": "string", "description": "It is PLU of the modifier category", "default": "", "minLength": 1, "maxLength": 50}, "max_toppings_choose_cnt": {"title": "Max_toppings_choose_cnt", "type": "integer", "description": "This number represents the maximum number of toppings can be choosen from the given pizza topping combo.", "default": 0, "minimum": 0}, "is_included_in_toppings": {"title": "Is_included_in_toppings", "type": "integer", "description": "Here value 0 means not included while 1 means included in topping.", "default": 0, "enum": [0, 1]}, "buy_more_than_max_qty": {"title": "Buy_more_than_max_qty", "type": "integer", "description": "Here value 0 means toppings can not purchased moe than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "modifiers": {"title": "Modifiers", "type": "array", "description": "It contains the information about pizza topping combo's modifiers", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the modifier", "default": ""}, "modifier_option_plu": {"title": "Modifier_option_plu", "type": "string", "description": "Size PLU of the modifier", "default": "", "minLength": 1, "maxLength": 50}, "is_default": {"title": "Is_default", "type": "integer", "description": "Here value 0 means toppings can not purchased more than max quatity while 1 means yes they can be.", "default": 0, "enum": [0, 1]}, "price_type": {"title": "Price_type", "type": "string", "description": "The 'included' value denotes the price of the modifier is included in the pizza price. 'excluded' value means pizza price is excluding of its modifier prices.", "enum": ["included", "excluded"]}, "split": {"title": "Split", "type": "string", "description": "This value denotes if the given modifiers of this section can be split with the pizza of 'half_and_half' type. Otherwise they will be available only for the 'regular' type pizzas.", "enum": ["yes", "no"]}}}}}}}, "pizza_options": {"title": "Pizza_options", "type": "array", "description": "Pizza options are about creating the multiple size variations for the pizza item. Here user has to select the one size from global sizes and decide price of the pizza option along with the price for the additional toppings.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the pizza option", "default": "", "minLength": 1, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the pizza option", "default": 0, "minimum": 0}, "extra_topping_price": {"title": "Extra_topping_price", "type": "number", "description": "The price charged for every extra topping.", "default": 0, "minimum": 0}, "purchase_option": {"title": "Purchase_option", "type": "string", "description": "It denotes whether the given pizza option is available for only either 'half and half' type or 'regular' type or for 'both' types.", "minLength": 1, "maxLength": 20, "enum": ["half", "regular", "both"]}, "size": {"title": "Size", "type": "string", "description": "Here enter the 'plu' value of one the global sizes mentioned in 'global_sizes' section.", "default": "", "minLength": 1, "maxLength": 50}}}}, "items": {"title": "Items", "type": "array", "description": "Here in this section detailed information of the items is entered. Make sure that you have already entered the correct values in its dependent sections.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "category_plu": {"title": "Category_plu", "type": "string", "description": "PLU of the menu category to which current item belongs", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the item", "default": "", "minLength": 1, "maxLength": 50}, "course_sno": {"title": "Course_sno", "type": "integer", "description": "Number of course number to item is associated. 0 means it is not associated with any course.", "default": 0, "minimum": 0, "enum": [0, 1, 2, 3, 4, 5, 6]}, "description": {"title": "Description", "type": "string", "description": "Description of the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "ingredients": {"title": "Ingredients", "type": "string", "description": "The information about the item ingredients can be mentioned in here.", "default": "", "pattern": "", "minLength": 0, "maxLength": 500}, "allergen_type": {"title": "allergen_type", "type": "string", "description": "It denotes the presence of allergens. 'none' means no allergens while 'specific' means allergens are present.", "enum": ["specific", "none"]}, "allergens": {"title": "Allergent", "type": "array", "description": "It is the integer values which represents the particular allergen.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]}}, "consent_available": {"title": "Consent_available", "type": "integer", "description": "Here value 1 means consumer consent is there. O means no consent.", "default": 0, "enum": [0, 1]}, "consent_message": {"title": "Consent_message", "type": "string", "description": "It is consent message for the given item is present", "default": "", "minLength": 0, "maxLength": 255}, "label": {"title": "Label", "type": "string", "description": "This will act as label to the item", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "query_meal_question": {"title": "Query_meal_question", "type": "string", "description": "This question will be displayed if the given item has a query meal.", "default": "", "minLength": 1, "maxLength": 500}, "sale_price": {"title": "Sale_price", "type": "number", "description": "Sale price of the item", "default": 0, "minimum": 0}, "cost_price": {"title": "Cost_price", "type": "number", "description": "Cost price of the item", "default": 0, "minimum": 0}, "included_toppings": {"title": "Included_toppings", "type": "integer", "description": "It shows the number of toppings are included in the current price. It is applied for pizza items.", "default": 0, "minimum": 0}, "allowed_toppings": {"title": "Allowed_toppings", "type": "integer", "description": "It shows max number of toppings allowed. It is applied for pizza items.", "default": 0, "minimum": 0}, "item_options_plu": {"title": "Item_options_plu", "type": "array", "description": "It contains the PLU of the item options if item is a multiprice.", "default": [], "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "pizza_options_plu": {"title": "pizza_options_plu", "type": "array", "description": "It contains the PLU of the pizza options if pizza is a multiprice.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "status": {"title": "Status", "type": "string", "description": "Activations status of the item.", "enum": ["active", "inactive"]}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "It denotes if tax is application on the item or not. If its value is 1, then tax is application and if value is 0, then it is not applicable", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "default": [], "items": {"title": "Items", "type": "object", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "It is the tax percentage for 'take_away' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "It is the tax percentage for 'delivery' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "It is the tax percentage for 'drive_thru' service which is applied only to the current modifier.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "It is the tax percentage for 'collection' service which is applied only to the current modifier.", "default": 0, "minimum": 0}}}}, "modifier_groups_plu": {"title": "Modifier_groups_plu", "type": "array", "description": "It is an array containing PLUs of the modifier group associated with the given item.", "default": [], "items": {"title": "Items", "type": "string", "description": "It is a modifier PLU", "default": "", "minLength": 1, "maxLength": 50}}, "topping_combos": {"title": "Topping_combos", "type": "array", "description": "It a list of toppings which are available for the given pizza. It contains the PLUs of the pizza topping combos", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "default": "", "minLength": 1, "maxLength": 50}}, "type": {"title": "Type", "type": "string", "description": "It is a type of an item. It may be 'item' for regular items and 'pizza' for pizza items", "default": "item", "maxLength": 10, "enum": ["item", "pizza"]}, "image_url": {"title": "Image_url", "type": "string", "description": "This is the image url of the current item.", "default": "", "maxLength": 250}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given item.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here value \"all\" means the item will be available on all days while \"specific\" value means, item shall be available only on specific days and time.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the start date of the availability of the item.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "Inside \"day_settings\" it contains the info about week days on which item will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}, "sale": {"title": "Sale", "type": "object", "description": "It contains the information about the sale status. There are various services through which items can be sold like pos, web, mob, contactless etc and they are having a active or inactive status. Value 1 means active, 0 means inactive.", "minProperties": 1, "properties": {"pos_status": {"title": "Pos_status", "type": "integer", "description": "Value 1 denotes sale on pos service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "web_status": {"title": "Web_status", "type": "integer", "description": "Value 1 denotes sale on web service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "mob_status": {"title": "Mob_status", "type": "integer", "description": "Value 1 denotes sale on mob service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "cless_status": {"title": "Cless_status", "type": "integer", "description": "Value 1 denotes sale on contactless service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}, "urbanpiper_status": {"title": "Urbanpiper_status", "type": "integer", "description": "Value 1 denotes sale on urbanpiper service is active. 0 means inactive.", "default": 0, "enum": [0, 1]}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "array", "description": "Here specific price can be mentioned for specific service and along with specific global size.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"size_plu": {"description": "**Omitted**"}, "service_type_prices": {"description": "**Omitted**"}}}}}}}}}, "query_meal_combos": {"title": "Query_meal_combos", "type": "array", "description": "It contains query meal combos that are created by adding the items and its size variations in it. These combos are used in query meal creation.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal combo", "default": "", "minLength": 1, "maxLength": 50}, "item_details": {"title": "Item_details", "type": "array", "description": "It contains the item details which are present to the current query meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU value of the item which is mentioned in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "qty": {"title": "Qty", "type": "integer", "description": "Quantity of the query meal combo", "default": 0, "minimum": 1}, "combination_title": {"title": "Combination_title", "type": "string", "description": "It is the title of the given query meal combo", "default": "", "minLength": 1, "maxLength": 50}}}}, "query_meal": {"title": "Query_meal", "type": "array", "description": "A particular item may have a query meal option. With the help of this customer can choose the meal option along with the item. Query meal has its own price and that will be applicable instead of individual item's price.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "Name of the query meal", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "Label of the query meal", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "price": {"title": "Price", "type": "number", "description": "Price of the query meal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Query meal status can be active or inactive. It defines query meal's availability.", "enum": ["active", "inactive"]}, "item_details": {"title": "Item_details", "type": "object", "description": "It contains the item details to which this query meal is attached.", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item/pizza size", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "Size PLU of the item/pizza", "default": "", "minLength": 0, "maxLength": 50}}}, "query_meal_combos_plu": {"title": "Query_meal_combos_plu", "type": "array", "description": "It contains the PLU value of query meal combos mentioned in 'query_meal_combos' section", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU of the query meal combo present in 'query_meal_combos' section.", "default": ""}}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the names of services for which the given query meal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "It the name of the service", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given query meal.", "properties": {"type": {"title": "Type", "type": "string", "description": "Here 'all' value means the query meals will be available on all days, while 'specific'' value means, query meal item shall be available only on specific days and time and then user has to define these settings using 'day_settings' attribute.", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "It is the start date of the availability of the query meal.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "It is the end date of the availability of the query meal.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which query meal will be available. Days -> sun, mon, tue, wed, thu, fri, sat", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}, "is_service_type_price_applicable": {"title": "Is_service_type_price_applicable", "type": "integer", "description": "It is used to decide whether there will be service specific prices are applicable. 0 means no and 1 means yes.", "default": 0, "enum": [0, 1]}, "service_wise_price_details": {"title": "Service_wise_price_details", "type": "object", "description": "It contains the price details for each service. Services -> eat_in, take_away, delivery, drive_thru, collection", "properties": {"eat_in": {"title": "Eat_in", "type": "number", "description": "Price for eat_in service", "default": 0, "minimum": 0}, "take_away": {"title": "Take_away", "type": "number", "description": "Price for take_away service", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Price for delivery service", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Price for drive_thru service", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Price for collection service", "default": 0, "minimum": 0}}}}}}, "meal_combos": {"title": "Meal_combos", "type": "array", "description": "Meal combos are associated with the meal deals. They very much similar to query meal combos. Here also combos of various items are configured.", "default": [], "minItems": 0, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "title": {"title": "Title", "type": "string", "description": "Title of the meal combo", "default": "", "minLength": 1, "maxLength": 50}, "qty": {"title": "Qty", "description": "Quanity of the meal combo PLU", "type": "integer", "default": 0, "minimum": 0}, "items": {"title": "Items", "type": "array", "description": "It contains the item details which are to be attached with the given meal combo", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the item which is present in 'items' section", "default": "", "minLength": 1, "maxLength": 50}, "option_plu": {"title": "Option_plu", "type": "string", "description": "PLU of the item which is present in 'item_options' section for regular item and 'pizza_options' section for pizza item", "default": "", "minLength": 0, "maxLength": 50}}}}}}}, "meal_deals": {"title": "Meal_deals", "type": "array", "description": "Meal deals are made of several meal combos. Here multiple items are offered as the part of several combos and user can select allowed number of iterms from each combo. And instead of paying seperate price for each item, user can simply pay one price for the entire deal.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the meal deal", "default": "", "minLength": 1, "maxLength": 50}, "name": {"title": "Name", "type": "string", "description": "It is the name of the meal deal.", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "It is the PLU value of the one of the menus mentioned in 'menu' section. This will connect current meal to deal to that menu.", "default": "", "minLength": 1, "maxLength": 50}, "description": {"title": "Description", "type": "string", "description": "Description of the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 250}, "label": {"title": "Label", "type": "string", "description": "Lable for the meal deal", "default": "", "pattern": "", "minLength": 0, "maxLength": 25}, "price": {"title": "Price", "type": "number", "description": "Price of the meal deal", "default": 0, "minimum": 0}, "status": {"title": "Status", "type": "string", "description": "Activation status of the meal deal", "default": "", "enum": ["active", "inactive"]}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given meal deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given meal deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "vat_flag": {"title": "Vat_flag", "type": "integer", "description": "Here 0 value means no vat/tax applicable while value 1 denotes tax is applicable and need to be added in 'taxes' array.", "default": 0, "enum": [0, 1]}, "taxes": {"title": "Taxes", "type": "array", "description": "It contains the tax information are applicable for given meal deal.", "default": [], "items": {"title": "Items", "type": "object", "description": "It contains the tax information.", "properties": {"tax_plu": {"title": "Tax_plu", "type": "string", "description": "PLU of the tax", "default": "", "minLength": 1, "maxLength": 50}, "take_away": {"title": "Take_away", "type": "number", "description": "Tax applicable for the take_away service.", "default": 0, "minimum": 0}, "delivery": {"title": "Delivery", "type": "number", "description": "Tax applicable for the delivery service.", "default": 0, "minimum": 0}, "drive_thru": {"title": "Drive_thru", "type": "number", "description": "Tax applicable for the drive_thru service.", "default": 0, "minimum": 0}, "collection": {"title": "Collection", "type": "number", "description": "Tax applicable for the collection service.", "default": 0, "minimum": 0}}}}, "combo_plu": {"title": "Combo_plu", "type": "array", "description": "It contains the PLU values that are present in meal_combos section.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "string", "description": "PLU value of the meal combo", "default": "", "minLength": 1, "maxLength": 50}}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the meal deal.", "default": "", "maxLength": 100}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given meal deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the meal deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the meal deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which meal deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}, "mix_and_match": {"title": "Mix_and_match", "type": "array", "description": "In mix and match the customer has to purchase an items to get other items either for free or at a discounted price. The section buy_items will have number of items and same for the get_items. Customer first has to purchase something from buy item section then may get choose some items from get_items section which may be available at discounted price. This also includes the other parameters such quantity, price, availability etc.", "default": [], "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "offer_title": {"title": "Offer_title", "type": "string", "description": "Title of the mix and match deal", "default": "", "minLength": 1, "maxLength": 50}, "menu_plu": {"title": "Menu_plu", "type": "string", "description": "PLU of the menu to which mix and match deal belonged. This PLU must be present in the 'menu' section.", "default": "", "minLength": 1, "maxLength": 50}, "cat_plu": {"title": "Cat_plu", "type": "string", "description": "PLU of menu category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "promo_cat_plu": {"title": "Promo_cat_plu", "type": "string", "description": "PLU of promotion category for which given mix and match deal is belonged.", "default": "", "minLength": 1, "maxLength": 50}, "label": {"title": "Label", "type": "string", "description": "It's a label for the mix and match deal.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}, "buy_qty": {"title": "Buy_qty", "type": "integer", "description": "This number represents the exact number to items which are need be purchased by the customer.", "default": 0, "minimum": 1}, "get_qty": {"title": "Get_qty", "type": "integer", "description": "This number represents the exact number to items which will bereceived by the customer once he/she purchase item from buy_items section.", "default": 0, "minimum": 1}, "discount_by": {"title": "discount_by", "type": "object", "description": "It contains the the discount type and its value.", "properties": {"type": {"title": "Type", "type": "string", "description": "It is a discount type.", "default": "price", "maxLength": 35, "enum": ["free", "price"]}, "value": {"title": "Value", "type": "number", "description": "It's a discount value. If discount_type is 'free' then discount value should be 0", "default": 0, "minimum": 0}}}, "buy_items": {"title": "Buy_items", "type": "array", "description": "It contains the information about items which need to purchased first.", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item. This PLU must be present in 'items' section.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "get_items": {"title": "Get_items", "type": "array", "default": [], "minItems": 1, "items": {"title": "Items", "type": "object", "properties": {"plu": {"title": "Plu", "type": "string", "description": "PLU of an item/pizza.", "default": "", "minLength": 1, "maxLength": 50}, "item_option_plu": {"title": "Item_option_plu", "type": "string", "description": "PLU of the item/pizza size.", "default": "", "pattern": "", "minLength": 0, "maxLength": 50}}}}, "status": {"title": "Status", "type": "string", "description": "Activation status of the mix and match deal.", "enum": ["active", "inactive"]}, "image_url": {"title": "Image_url", "type": "string", "description": "Image URL of the mix and match deal.\",", "default": "", "maxLength": 100}, "offer_applicable_services": {"title": "Offer_applicable_services", "type": "array", "description": "It contains the name of services for which the given mix and match deal is available.", "default": [], "minItems": 0, "uniqueItems": true, "items": {"title": "Items", "type": "string", "description": "Name of the service for which given mix and match deal is available", "enum": ["take_away", "eat_in", "delivery", "drive_thru", "collection"]}}, "availability_settings": {"title": "Availability_settings", "type": "object", "description": "Availability settings are for deciding the availability of the given mix and match deal.", "properties": {"type": {"title": "Type", "type": "string", "description": "", "default": "specific", "enum": ["all", "specific"]}, "start_date": {"title": "Start_date", "type": "string", "description": "Start date of the mix and match deal availability.", "default": ""}, "end_date": {"title": "End_date", "type": "string", "description": "End date of the mix and match deal availability.", "default": ""}, "day_settings": {"title": "Day_settings", "type": "object", "description": "It contains the info about week days on which mix and match deal will be available.", "properties": {"sun": {"title": "Sun", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "mon": {"title": "Mon", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "tue": {"title": "Tue", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "wed": {"title": "Wed", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "thu": {"title": "Thu", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "fri": {"title": "Fri", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}, "sat": {"title": "Sat", "type": "object", "properties": {"from_time": {"description": "**Omitted**"}, "to_time": {"description": "**Omitted**"}}}}}}}}}}}}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/eb1f6bd9-c4f2-4c94-9ea5-0dc49e98ef23/0/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | search | Returns all the companies that matches up by the keywords | 404 | null | {"status": 404, "message": "Not found"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/eb1f6bd9-c4f2-4c94-9ea5-0dc49e98ef23/1/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | search | Returns all the companies that matches up by the keywords | 200 | null | {"status": 200, "message": "OK", "data": [{"logo": "https://img.shgstatic.com/clutchco-static/image/scale/60x60/s3fs-public/logos/q-square100_0.png", "name": "AgencyQ", "rating": 4.4, "url": "https://clutch.co/profile/agencyq", "slug": "agencyq"}]} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "array", "items": {"type": "object", "properties": {"logo": {"type": "string"}, "name": {"type": "string"}, "rating": {"type": "number"}, "url": {"type": "string"}, "slug": {"type": "string"}}}}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/eb1f6bd9-c4f2-4c94-9ea5-0dc49e98ef23/2/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | search | Returns all the companies that matches up by the keywords | 400 | null | {"status": 400, "message": "Bad request"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/21258b5d-fae8-4f2f-9fb4-09c978561d29/0/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getCompany | Returns all the detailed information of a company by its slug | 400 | null | {"status": 400, "message": "Bad request"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/21258b5d-fae8-4f2f-9fb4-09c978561d29/1/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getCompany | Returns all the detailed information of a company by its slug | 404 | null | {"status": 404, "message": "Not found"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/21258b5d-fae8-4f2f-9fb4-09c978561d29/2/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getCompany | Returns all the detailed information of a company by its slug | 200 | null | {"status": 200, "message": "OK", "data": {"url": "https://clutch.co/profile/smartsites", "websiteUrl": "https://www.smartsites.com/lp/digital-marketing-lp/?utm_source=clutch.co&utm_medium=referral", "summary": {"name": "SmartSites", "logo": "https://img.shgstatic.com/clutchco-static/image/scale/60x60/s3fs-public/logos/a33a9494d9c0f41b112e8a1b4354a3e9.png", "title": "Think Web. Think Smart", "rating": 5, "noOfReviews": 56, "description": "Outsmart the competition with best-in-class digital marketing services.", "minProjectSize": "$1000", "averageHourlyRate": "$100 - $149 / hr", "employees": "10 - 49", "founded": "Founded 2011", "addresses": [{"title": "headquarters", "street": "45 Eisenhower Drive", "locality": "Paramus", "region": "NJ", "postalCode": 7652, "country": "United States", "phone": "+1.201.870.6000"}]}, "focus": [{"title": "Client focus", "values": [{"name": "Small Business (<$10M)", "percentage": 80}]}], "verification": {"status": "GOLD VERIFIED", "businessEntity": {"name": "Melen, LLC", "status": "Active", "jurisdictionOfFormation": "New Jersey", "ID": 600372607, "source": "New Jersey Division of Revenue & Enterprise Services", "lastUpdated": "November 1, 2020", "dateOfFormation": "May 15, 2011"}, "paymentLegalFilings": {"bankruptcy": "No", "taxLienFilings": 0, "judgementFilings": 0, "collectionsCount": 0, "source": "New Jersey Division of Revenue & Enterprise Services", "lastUpdated": "November 1, 2020", "fullBusinessCreditReport": "https://www.smartbusinessreports.com/search2.aspx?link=1352&fn=951794204"}}}} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"url": {"type": "string"}, "websiteUrl": {"type": "string"}, "summary": {"type": "object", "properties": {"name": {"type": "string"}, "logo": {"type": "string"}, "title": {"type": "string"}, "rating": {"type": "number"}, "noOfReviews": {"type": "number"}, "description": {"type": "string"}, "minProjectSize": {"type": "string"}, "averageHourlyRate": {"type": "string"}, "employees": {"type": "string"}, "founded": {"type": "string"}, "addresses": {"type": "array", "items": {"type": "object", "properties": {"title": {"type": "string"}, "street": {"type": "string"}, "locality": {"type": "string"}, "region": {"type": "string"}, "postalCode": {"type": "string"}, "country": {"type": "string"}, "phone": {"type": "string"}}}}}}, "focus": {"type": "array", "items": {"type": "object", "properties": {"title": {"type": "string"}, "values": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "percentage": {"type": "number"}}}}}}}, "verification": {"type": "object", "properties": {"status": {"type": "string"}, "businessEntity": {"type": "object", "properties": {"name": {"type": "string"}, "status": {"type": "string"}, "jurisdictionOfFormation": {"type": "string"}, "ID": {"type": "string"}, "source": {"type": "string"}, "lastUpdated": {"type": "string"}, "dateOfFormation": {"type": "string"}}}, "paymentLegalFilings": {"type": "object", "properties": {"bankruptcy": {"type": "string"}, "taxLienFilings": {"type": "string"}, "judgementFilings": {"type": "string"}, "collectionsCount": {"type": "string"}, "source": {"type": "string"}, "lastUpdated": {"type": "string"}, "fullBusinessCreditReport": {"type": "string"}}}}}}}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/3bcad85e-dc04-44b5-8d0f-9d58f786ca18/0/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getPortfolio | Returns all the portfolio information of a company by its slug | 200 | null | {"status": 200, "message": "OK", "data": [{"image": "https://static2.clutch.co/s3fs-public/portfolio/28eae3874f8afd9e23a14f332d86353d.jpeg?N66vx9xl9cXLR5H6.euqT_BkCwjjAYD8", "description": "Web Design, SEO, PPC"}]} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "array", "items": {"type": "object", "properties": {"image": {"type": "string"}, "description": {"type": "string"}}}}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/3bcad85e-dc04-44b5-8d0f-9d58f786ca18/1/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getPortfolio | Returns all the portfolio information of a company by its slug | 404 | null | {"status": 404, "message": "Not found"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/3bcad85e-dc04-44b5-8d0f-9d58f786ca18/2/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getPortfolio | Returns all the portfolio information of a company by its slug | 400 | null | {"status": 400, "message": "Bad request"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/11409194-676c-4c55-81f5-6943f4ae4c09/0/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getReviews | Returns all the review information of a company by its slug | 404 | null | {"status": 404, "message": "Not found"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/11409194-676c-4c55-81f5-6943f4ae4c09/1/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getReviews | Returns all the review information of a company by its slug | 200 | null | {"status": 200, "message": "OK", "data": [{"name": "SEO & PPC Services for Outdoor Refinishing Company", "datePublished": "May 25, 2021", "project": {"name": "SEO & PPC Services for Outdoor Refinishing Company", "category": "SEO & PPC", "size": "$10,000 to $49,999$10,000 to $49,999", "length": "Sep. 2020 - Jun. 2021Sep. 2020 - Jun. 2021", "description": "SmartSites provided SEO and PPC services for an outdoor refinishing company including adding backlinks and creating new content."}, "review": {"rating": 5, "quality": 5, "schedule": 5, "cost": 5, "willingToRefer": 5, "comments": "The team's work resulted in increased traffic and conversions."}, "reviewer": {"title": "Owner, General Manager, Teak & Deck", "name": "Drew Isaacman", "industry": "Construction", "size": "1-10 Employees", "location": "Carlsbad California", "reviewType": "Online Review", "verified": "Verified"}, "content": [{"label": "BACKGROUND", "text": "Please describe your company and position. I am the CEO"}]}]} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "datePublished": {"type": "string"}, "project": {"type": "object", "properties": {"name": {"type": "string"}, "category": {"type": "string"}, "size": {"type": "string"}, "length": {"type": "string"}, "description": {"type": "string"}}}, "review": {"type": "object", "properties": {"rating": {"type": "number"}, "quality": {"type": "number"}, "schedule": {"type": "number"}, "cost": {"type": "number"}, "willingToRefer": {"type": "number"}, "comments": {"type": "string"}}}, "reviewer": {"type": "object", "properties": {"title": {"type": "string"}, "name": {"type": "string"}, "industry": {"type": "string"}, "size": {"type": "string"}, "location": {"type": "string"}, "reviewType": {"type": "string"}, "verified": {"type": "string"}}}, "content": {"type": "array", "items": {"type": "object", "properties": {"label": {"type": "string"}, "text": {"type": "string"}}}}}}}}} |
9efce7ef-70bb-4937-a7cd-6e28b488f71c/11409194-676c-4c55-81f5-6943f4ae4c09/2/0 | Clutch.co | Gather comprehensive company information, numeric company focus, real client reviews, portfolios, and more from the extensive Clutch.co commercial database. | 9.4 | getReviews | Returns all the review information of a company by its slug | 400 | null | {"status": 400, "message": "Bad request"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
f2b0ad2b-5683-403c-8b38-b22a7a95e76c/aa6671ee-4fdc-484e-8fad-203d47ce8f50/0/0 | GET Quote | Provides Quotes Services . You can get quote with author name , type | null | GET Quote | Returns Quote | 200 | Response | [{"author": "Aristotle", "id": "5edb9180368d0d4f54d4e17d", "quote": "If one way be better than another, that you may be sure is natures way.", "type": "life"}, {"author": "Napoleon Hill", "id": "5edb9180368d0d4f54d4e17e", "quote": "Here is one quality that one must possess to win, and that is definiteness of purpose, the knowledge of what one wants, and a burning desire to possess it.", "type": "life"}, {"author": "William Shakespeare", "id": "5edb9180368d0d4f54d4e17f", "quote": "It is not in the stars to hold our destiny but in ourselves.", "type": "life"}, {"author": "Tony Robbins", "id": "5edb9180368d0d4f54d4e180", "quote": "Using the power of decision gives you the capacity to get past any excuse to change any and every part of your life in an instant.", "type": "decision"}, {"author": "Abraham Lincoln", "id": "5edb9180368d0d4f54d4e181", "quote": "I will prepare and some day my chance will come.", "type": "hardwork"}, {"author": "Tom Jackson", "id": "5edb9180368d0d4f54d4e182", "quote": "Sometimes the cards we are dealt are not always fair. However you must keep smiling and moving on.", "type": "life"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a14", "quote": "In a gentle way, you can shake the world.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a15", "quote": "The future depends on what you do today.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a16", "quote": "Strength does not come from physical capacity. It comes from an indomitable will.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a17", "quote": "I remain an optimist because of my unflinching faith that right must prosper in the end.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a18", "quote": "Live as if you were to die tomorrow. Learn as if you were to live forever.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a19", "quote": "When you are right, you have no need to be angry. When you are wrong, you have no right to be angry.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a1a", "quote": "Nobody can hurt me without my permission.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a1b", "quote": "Prayer is the key of the morning and the bolt of the evening.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a1c", "quote": "The weak can never forgive. Forgiveness is the attribute of the strong.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a1d", "quote": "Happiness is when what you think, what you say, and what you do are in harmony.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a1e", "quote": "If I have the belief that I can do it, I shall surely acquire the capacity to do it even if I may not have it at the beginning.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a1f", "quote": "Relationships are based on four principles: respect, understanding, acceptance, and appreciation.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a20", "quote": "Silence is the best answer to anger.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a21", "quote": "You can\u2019t change how people treat you or what they say about you. All you can do is change how you react to it.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a22", "quote": "You must not lose faith in humanity. Humanity is an ocean; if a few drops of the ocean are dirty, the ocean does not become dirty.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a23", "quote": "An eye for an eye only ends up making the whole world blind.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a24", "quote": "To lose patience is to lose the battle.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a25", "quote": "Nonviolence is a weapon of the strong.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a26", "quote": "If we want to reach real peace in this world, we should start educating children.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a27", "quote": "The good man is the friend of all living things.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a28", "quote": "You yourself as much as anybody in the entire universe deserve your love and affection.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a29", "quote": "To believe in something, and not live it, is dishonest.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a2a", "quote": "Our greatness lies not so much in being able to remake the world as being able to remake ourselves..", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a2b", "quote": "First they ignore you, then they laugh at you, then they fight you, then you win.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a2c", "quote": "A small body of determined spirits fired by an unquenchable faith in their mission can alter the course of history.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a2d", "quote": "Without action, you aren\u2019t going anywhere.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a2e", "quote": "I will not let anyone walk through my mind with their dirty feet.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a2f", "quote": "Love never claims, it ever gives.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a30", "quote": "Where there is love there is life.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a31", "quote": "It is health that is real wealth and not pieces of gold and silver.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a32", "quote": "A man is but the product of his thoughts. What he thinks he becomes.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a33", "quote": "The best way is to find yourself is to lose yourself in the service of others.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a34", "quote": "You must be the change you wish to see in the world.", "type": "Success"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a35", "quote": "A man is but the product of his thoughts, what he thinks, he becomes.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a36", "quote": "You must not lose faith in humanity. Humanity is an ocean; if a few drops of the ocean are dirty, the ocean does not become dirty.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a37", "quote": "Strength does not come from physical capacity. It comes from an indomitable will.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a38", "quote": "The best way to find yourself is to lose yourself in the service of others.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a39", "quote": "First they ignore you, then they laugh at you, then they fight you, then you win.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a3a", "quote": "First they ignore you, then they laugh at you, then they fight you, then you win.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a3b", "quote": "Happiness is when what you think, what you say, and what you do are in harmony.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a3c", "quote": "Live as if you were to die tomorrow; learn as if you were to live forever.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a3d", "quote": "The weak can never forgive. Forgiveness is the attribute of the strong.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a3e", "quote": "You must be the change you wish to see in the world.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a3f", "quote": "What is really needed to make democracy function is not knowledge of facts, but right education.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a40", "quote": "True education must correspond to the surrounding circumstances or it is not a healthy growth.", "type": "Education"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a41", "quote": "A man is but a product of his thoughts. What he thinks he becomes.", "type": "Inspiration"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a42", "quote": "I will not let anyone walk through my mind with their dirty feet.", "type": "Inspiration"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a43", "quote": "Nobody can hurt me without my permission.", "type": "Inspiration"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a44", "quote": "Happiness is when what you think, what you say, and what you do are in harmony.", "type": "Inspiration"}, {"author": "Mahatma Gandhi", "id": "5edc935716ca065178e88a45", "quote": "The weak can never forgive. Forgiveness is an attribute of the strong.", "type": "Inspiration"}, {"author": "string", "id": "5efc0d87b7d4dc28b8148d42", "quote": "string", "type": "string"}, {"author": "string", "id": "5efde67c51e4cf0f42af424d", "quote": "string", "type": "string"}, {"author": "string", "id": "5efde68b51e4cf0f42af424f", "quote": "string", "type": "string"}, {"author": "string", "id": "5efde6bb51e4cf0f42af4251", "quote": "string", "type": "string"}] | {"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"author": {"type": "string"}, "id": {"type": "string"}, "quote": {"type": "string"}, "type": {"type": "string"}}, "required": ["author", "id", "quote", "type"]}} |
4e247b50-e8c6-498f-ba7c-8df5622e131e/c6c03646-a1e5-4ab1-a2c9-98b7ac4b26ff/0/0 | Aruba Company Data | Access the official Aruba government company register. Ideal for KYB purposes | null | GetCompanybyID | Search the Aruba business register by company ID | 200 | Example_1 | {"dossiernummerString": "H41852.0", "type": "HANDELSREGISTER", "nummer": 41852, "filiaalNummer": 0, "bedrijfsnaam": "ILT TRADING V.B.A.", "handelsnaam": "I LOVE ARUBA TRADING", "hoofdbranch": "G47781 - WINKELS IN FOTOGRAFISCHE ARTIKELEN", "rechtsvorm": "VENNOOTSCHAP MET BEPERKTE AANSPRAKELIJKHEID", "bestuur": [{"naam": "DANIEL KAMEIER", "dossiernummer": null, "titel": null, "functie": "DIRECTEUR", "geboorteland": "DUITSLAND", "geboorteplaats": "BIELEFELD", "ingangsDatum": "2014-04-30T00:00:00Z", "bevoegdheid": "BEPERKT"}], "vestigingAdres": {"straatnaam": "BARCADERA", "landId": 1, "landnaam": "ARUBA", "plaatsnaam": "SANTA CRUZ", "nummer": "5", "huisnummer": 5, "toevoeging": "", "gacCode": 56060, "gacStraatnaam": "BARCADERA", "zone": "BALASHI/BARCADERA", "regio": "SANTA CRUZ", "postcode": null}, "types": [{"id": 0, "naam": "Uittreksels", "producten": [{"id": 0, "naam": "Authenticated Extract of Registration (Uittreksel)", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 1, "taal": "DUTCH", "prijs": 15, "directLeverbaar": false}, {"productId": 4, "taal": "ENGLISH", "prijs": 30, "directLeverbaar": false}, {"productId": 6, "taal": "SPANISH", "prijs": 30, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}]}, {"id": 0, "naam": "Regular", "producten": [{"id": 0, "naam": "Photo-static copy of deed", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 3, "taal": null, "prijs": 25, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}, {"id": 0, "naam": "Authenticated Copy of deed", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 9, "taal": null, "prijs": 30, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}, {"id": 0, "naam": "Trade Registry Forms Duplicate", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 14, "taal": null, "prijs": 3, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}, {"id": 0, "naam": "Modification deed of incorporation", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 17, "taal": null, "prijs": 15, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}]}, {"id": 0, "naam": "Historisch Uittreksel", "producten": [{"id": 0, "naam": "Historical Extract of a corporation", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 19, "taal": "DUTCH", "prijs": 30, "directLeverbaar": false}, {"productId": 101, "taal": "ENGLISH", "prijs": 40, "directLeverbaar": false}, {"productId": 102, "taal": "SPANISH", "prijs": 40, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}]}, {"id": 0, "naam": "Verklaring", "producten": [{"id": 0, "naam": "Declaration of cross-border conversion", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 31, "taal": "DUTCH", "prijs": 15, "directLeverbaar": false}, {"productId": 32, "taal": "ENGLISH", "prijs": 15, "directLeverbaar": false}, {"productId": 33, "taal": "SPANISH", "prijs": 15, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}, {"id": 0, "naam": "Declaration of good standing (Verklaring)", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 103, "taal": "DUTCH", "prijs": 15, "directLeverbaar": false}, {"productId": 104, "taal": "ENGLISH", "prijs": 15, "directLeverbaar": false}, {"productId": 105, "taal": "SPANISH", "prijs": 15, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}, {"id": 0, "naam": "Declaration of registration (Verklaring)", "omschrijving": null, "prijs": null, "volgorde": 0, "isGearchiveerd": false, "dossiernummerVerplicht": false, "taal": null, "eigenschappen": [{"productId": 106, "taal": "DUTCH", "prijs": 15, "directLeverbaar": false}, {"productId": 107, "taal": "ENGLISH", "prijs": 15, "directLeverbaar": false}, {"productId": 108, "taal": "SPANISH", "prijs": 15, "directLeverbaar": false}], "isJaarlijkseBijdrage": false}]}], "kapitaalGestort": 1200, "kapitaalMaatschappelijk": 1200, "kapitaalGeplaatst": 1200, "kapitaalValutaId": 1, "kapitaalValuta": "ARUBAANSE FLORINS", "kapitaalBeginBoekjaar": null, "kapitaalEindBoekjaar": null, "statutaireZetel": "ARUBA", "datumVestiging": "2012-04-26T00:00:00Z", "datumIngangStatus": "2022-10-26T16:34:33.2689574Z", "doelstellingNL": "DE GROOT- EN KLEINHANDEL IN SOUVENIRARTIKELEN.", "datumStatutenWijziging": null, "status": "ACTIEF/ACTIEF ZONDER ONDERNEMING", "productenBeschikbaar": true, "id": 437991, "subbranches": []} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"dossiernummerString": {"type": "string"}, "type": {"type": "string"}, "nummer": {"type": "integer"}, "filiaalNummer": {"type": "integer"}, "bedrijfsnaam": {"type": "string"}, "handelsnaam": {"type": "string"}, "hoofdbranch": {"type": "string"}, "rechtsvorm": {"type": "string"}, "bestuur": {"type": "array", "items": {"type": "object", "properties": {"naam": {"type": "string"}, "dossiernummer": {"type": "null"}, "titel": {"type": "null"}, "functie": {"type": "string"}, "geboorteland": {"type": "string"}, "geboorteplaats": {"type": "string"}, "ingangsDatum": {"type": "string"}, "bevoegdheid": {"type": "string"}}, "required": ["bevoegdheid", "dossiernummer", "functie", "geboorteland", "geboorteplaats", "ingangsDatum", "naam", "titel"]}}, "vestigingAdres": {"type": "object", "properties": {"straatnaam": {"type": "string"}, "landId": {"type": "integer"}, "landnaam": {"type": "string"}, "plaatsnaam": {"type": "string"}, "nummer": {"type": "string"}, "huisnummer": {"type": "integer"}, "toevoeging": {"type": "string"}, "gacCode": {"type": "integer"}, "gacStraatnaam": {"type": "string"}, "zone": {"type": "string"}, "regio": {"type": "string"}, "postcode": {"type": "null"}}, "required": ["gacCode", "gacStraatnaam", "huisnummer", "landId", "landnaam", "nummer", "plaatsnaam", "postcode", "regio", "straatnaam", "toevoeging", "zone"]}, "types": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "naam": {"type": "string"}, "producten": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "integer"}, "naam": {"type": "string"}, "omschrijving": {"type": "null"}, "prijs": {"type": "null"}, "volgorde": {"type": "integer"}, "isGearchiveerd": {"type": "boolean"}, "dossiernummerVerplicht": {"type": "boolean"}, "taal": {"type": "null"}, "eigenschappen": {"type": "array", "items": {"type": "object", "properties": {"productId": {"type": "integer"}, "taal": {"type": ["null", "string"]}, "prijs": {"type": "integer"}, "directLeverbaar": {"type": "boolean"}}, "required": ["directLeverbaar", "prijs", "productId", "taal"]}}, "isJaarlijkseBijdrage": {"type": "boolean"}}, "required": ["dossiernummerVerplicht", "eigenschappen", "id", "isGearchiveerd", "isJaarlijkseBijdrage", "naam", "omschrijving", "prijs", "taal", "volgorde"]}}}, "required": ["id", "naam", "producten"]}}, "kapitaalGestort": {"type": "integer"}, "kapitaalMaatschappelijk": {"type": "integer"}, "kapitaalGeplaatst": {"type": "integer"}, "kapitaalValutaId": {"type": "integer"}, "kapitaalValuta": {"type": "string"}, "kapitaalBeginBoekjaar": {"type": "null"}, "kapitaalEindBoekjaar": {"type": "null"}, "statutaireZetel": {"type": "string"}, "datumVestiging": {"type": "string"}, "datumIngangStatus": {"type": "string"}, "doelstellingNL": {"type": "string"}, "datumStatutenWijziging": {"type": "null"}, "status": {"type": "string"}, "productenBeschikbaar": {"type": "boolean"}, "id": {"type": "integer"}, "subbranches": {"type": "array"}}, "required": ["bedrijfsnaam", "bestuur", "datumIngangStatus", "datumStatutenWijziging", "datumVestiging", "doelstellingNL", "dossiernummerString", "filiaalNummer", "handelsnaam", "hoofdbranch", "id", "kapitaalBeginBoekjaar", "kapitaalEindBoekjaar", "kapitaalGeplaatst", "kapitaalGestort", "kapitaalMaatschappelijk", "kapitaalValuta", "kapitaalValutaId", "nummer", "productenBeschikbaar", "rechtsvorm", "status", "statutaireZetel", "subbranches", "type", "types", "vestigingAdres"]} |
4e247b50-e8c6-498f-ba7c-8df5622e131e/f5961721-4760-4ac5-8cda-389549f66b7a/0/0 | Aruba Company Data | Access the official Aruba government company register. Ideal for KYB purposes | null | Search | Search the Aruba company register by text | 200 | Example_1 | {"totalRowCount": 14, "resultSet": [{"dossiernummerString": "H54780.0", "dossiernummer": {"bedrijfstype": {"nameEN": "TRADE REGISTRY", "nameES": "REGISTRO MERCANTIL", "name": "HANDELSREGISTER", "id": 1}, "registratienummer": 54780, "filiaalnummer": 0, "value": "H54780.0"}, "bedrijfsnaam": "STARUBA TRADING GROUP VBA", "hoofdbranch": "GESPECIALISEERDE WINKELS IN OVERIGE VOEDINGS- EN GENOTMIDDELEN", "bedrijfstype": "HANDELSREGISTER", "rechtsvorm": "VENNOOTSCHAP MET BEPERKTE AANSPRAKELIJKHEID", "isActief": true, "vestigingAdres": {"straatnaam": null, "landId": 1, "landnaam": "ARUBA", "plaatsnaam": null, "nummer": null, "huisnummer": 13, "toevoeging": null, "gacCode": 22040, "gacStraatnaam": "ITALIESTRAAT", "zone": "EAGLE/PAARDENBAAI", "regio": "ORANJESTAD WEST", "postcode": null}, "handelsnaam": "STARUBA TRADING GROUP"}, {"dossiernummerString": "H53262.0", "dossiernummer": {"bedrijfstype": {"nameEN": "TRADE REGISTRY", "nameES": "REGISTRO MERCANTIL", "name": "HANDELSREGISTER", "id": 1}, "registratienummer": 53262, "filiaalnummer": 0, "value": "H53262.0"}, "bedrijfsnaam": "FORMULA ARUBA TRADING & SERVICES VBA", "hoofdbranch": "IMPORT VAN NIEUWE PERSONENAUTO`S EN LICHTE BEDRIJFSAUTO`S", "bedrijfstype": "HANDELSREGISTER", "rechtsvorm": "VENNOOTSCHAP MET BEPERKTE AANSPRAKELIJKHEID", "isActief": true, "vestigingAdres": {"straatnaam": null, "landId": 1, "landnaam": "ARUBA", "plaatsnaam": null, "nummer": null, "huisnummer": 211, "toevoeging": "H", "gacCode": 37050, "gacStraatnaam": "PRIMAVERA", "zone": "SABANA BLANCO/MAHUMA", "regio": "ORANJESTAD OOST", "postcode": null}, "handelsnaam": "FORMULA ARUBA TRADING & SERVICES"}, {"dossiernummerString": "H45499.0", "dossiernummer": {"bedrijfstype": {"nameEN": "TRADE REGISTRY", "nameES": "REGISTRO MERCANTIL", "name": "HANDELSREGISTER", "id": 1}, "registratienummer": 45499, "filiaalnummer": 0, "value": "H45499.0"}, "bedrijfsnaam": "ARUBA TRADING COMPANY N.V.", "hoofdbranch": "GROOTHANDEL IN OVERIGE VOEDINGSMIDDELEN EN IN OVERIGE GRONDSTOFFEN EN HALFFABRIKATEN VOOR DE VOEDINGSMIDDELENINDUSTRIE", "bedrijfstype": "HANDELSREGISTER", "rechtsvorm": "NAAMLOZE VENNOOTSCHAP", "isActief": true, "vestigingAdres": {"straatnaam": "WESTSTRAAT", "landId": 1, "landnaam": "ARUBA", "plaatsnaam": "ORANJESTAD WEST", "nummer": "17", "huisnummer": 17, "toevoeging": "", "gacCode": 26010, "gacStraatnaam": "WESTSTRAAT", "zone": "SOCOTORO/RANCHO", "regio": "ORANJESTAD WEST", "postcode": null}, "handelsnaam": "ARUBA TRADING COMPANY"}, {"dossiernummerString": "H41852.0", "dossiernummer": {"bedrijfstype": {"nameEN": "TRADE REGISTRY", "nameES": "REGISTRO MERCANTIL", "name": "HANDELSREGISTER", "id": 1}, "registratienummer": 41852, "filiaalnummer": 0, "value": "H41852.0"}, "bedrijfsnaam": "ILT TRADING V.B.A.", "hoofdbranch": "WINKELS IN FOTOGRAFISCHE ARTIKELEN", "bedrijfstype": "HANDELSREGISTER", "rechtsvorm": "VENNOOTSCHAP MET BEPERKTE AANSPRAKELIJKHEID", "isActief": true, "vestigingAdres": {"straatnaam": "BARCADERA", "landId": 1, "landnaam": "ARUBA", "plaatsnaam": "SANTA CRUZ", "nummer": "5", "huisnummer": 5, "toevoeging": "", "gacCode": 56060, "gacStraatnaam": "BARCADERA", "zone": "BALASHI/BARCADERA", "regio": "SANTA CRUZ", "postcode": null}, "handelsnaam": "I LOVE ARUBA TRADING"}, {"dossiernummerString": "H86.7", "dossiernummer": {"bedrijfstype": {"nameEN": "TRADE REGISTRY", "nameES": "REGISTRO MERCANTIL", "name": "HANDELSREGISTER", "id": 1}, "registratienummer": 86, "filiaalnummer": 7, "value": "H86.7"}, "bedrijfsnaam": "ARUBA HANDELMAATSCHAPPIJ N.V.", "hoofdbranch": "WINKELS IN PARFUMS EN COSMETICA", "bedrijfstype": "HANDELSREGISTER", "rechtsvorm": "NAAMLOZE VENNOOTSCHAP", "isActief": false, "vestigingAdres": {"straatnaam": "RENAISSANCE /L.G. SMITH BLVD.", "landId": 1, "landnaam": "ARUBA", "plaatsnaam": "ORANJESTAD WEST", "nummer": "9", "huisnummer": 0, "toevoeging": null, "gacCode": null, "gacStraatnaam": null, "zone": null, "regio": null, "postcode": null}, "handelsnaam": "ARUBA TRADING CO./BEAUTY BOUTIQUE"}]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"totalRowCount": {"type": "integer"}, "resultSet": {"type": "array", "items": {"type": "object", "properties": {"dossiernummerString": {"type": "string"}, "dossiernummer": {"type": "object", "properties": {"bedrijfstype": {"type": "object", "properties": {"nameEN": {"type": "string"}, "nameES": {"type": "string"}, "name": {"type": "string"}, "id": {"type": "integer"}}, "required": ["id", "name", "nameEN", "nameES"]}, "registratienummer": {"type": "integer"}, "filiaalnummer": {"type": "integer"}, "value": {"type": "string"}}, "required": ["bedrijfstype", "filiaalnummer", "registratienummer", "value"]}, "bedrijfsnaam": {"type": "string"}, "hoofdbranch": {"type": "string"}, "bedrijfstype": {"type": "string"}, "rechtsvorm": {"type": "string"}, "isActief": {"type": "boolean"}, "vestigingAdres": {"type": "object", "properties": {"straatnaam": {"type": ["null", "string"]}, "landId": {"type": "integer"}, "landnaam": {"type": "string"}, "plaatsnaam": {"type": ["null", "string"]}, "nummer": {"type": ["null", "string"]}, "huisnummer": {"type": "integer"}, "toevoeging": {"type": ["null", "string"]}, "gacCode": {"type": ["integer", "null"]}, "gacStraatnaam": {"type": ["null", "string"]}, "zone": {"type": ["null", "string"]}, "regio": {"type": ["null", "string"]}, "postcode": {"type": "null"}}, "required": ["gacCode", "gacStraatnaam", "huisnummer", "landId", "landnaam", "nummer", "plaatsnaam", "postcode", "regio", "straatnaam", "toevoeging", "zone"]}, "handelsnaam": {"type": "string"}}, "required": ["bedrijfsnaam", "bedrijfstype", "dossiernummer", "dossiernummerString", "handelsnaam", "hoofdbranch", "isActief", "rechtsvorm", "vestigingAdres"]}}}, "required": ["resultSet", "totalRowCount"]} |
ad5b7d46-2601-482a-bbed-4556240044ce/334e7c23-c089-474f-9453-58f0cb525b24/0/0 | Admin API | This API is used for our company project | null | jwtRefresh | 200 | null | {"statusCode": 0, "errors": [], "message": ""} | {"allOf": [{"type": "object", "properties": {"statusCode": {"type": "number"}, "errors": {"type": "array", "items": {"type": "string"}}, "message": {"type": "string"}}, "required": ["statusCode", "errors", "message"]}, {"properties": {"data": {"type": "object", "properties": {"accessToken": {"type": "string"}, "accessExpired": {"type": "number"}}, "required": ["accessToken", "accessExpired"]}}}]} |
|
ad5b7d46-2601-482a-bbed-4556240044ce/42e81892-239d-42cb-90c8-ba45ff605b41/0/0 | Admin API | This API is used for our company project | null | login | 200 | null | {"statusCode": 0, "errors": [], "message": ""} | {"allOf": [{"type": "object", "properties": {"statusCode": {"type": "number"}, "errors": {"type": "array", "items": {"type": "string"}}, "message": {"type": "string"}}, "required": ["statusCode", "errors", "message"]}, {"properties": {"data": {"type": "object", "properties": {"userId": {"type": "string"}, "username": {"type": "string"}, "roles": {"type": "array", "items": {"type": "string"}}, "accessToken": {"type": "string"}, "refreshToken": {"type": "string"}, "accessExpired": {"type": "number"}, "refreshExpired": {"type": "number"}}, "required": ["userId", "username", "roles", "accessToken", "refreshToken", "accessExpired", "refreshExpired"]}}}]} |
|
ad5b7d46-2601-482a-bbed-4556240044ce/32aa4bac-f8b9-4332-8df7-fa00505fe27a/0/0 | Admin API | This API is used for our company project | null | getProfile | 200 | null | {"statusCode": 0, "errors": [], "message": ""} | {"allOf": [{"type": "object", "properties": {"statusCode": {"type": "number"}, "errors": {"type": "array", "items": {"type": "string"}}, "message": {"type": "string"}}, "required": ["statusCode", "errors", "message"]}, {"properties": {"data": {"type": "object", "properties": {"userId": {"type": "string"}, "username": {"type": "string"}, "roles": {"type": "array", "items": {"type": "string"}}}, "required": ["userId", "username", "roles"]}}}]} |
|
c49b67a3-c84a-4b1c-8c68-f35f7c3c3872/82158eb3-b8b4-4ce7-9074-b4213d267ce9/0/0 | Sri Lanka Company Data | Access the official Sri Lankan Government company register, ideal for KYB purposes. | null | Search by Name | Here you can search by name or company number | 200 | Example_1 | {"availableData": {"data": [{"name": "SRI LANKAN AIRLINES", "registration_no": "PB67"}], "meta": {"last_page": 0, "per_page": 0, "total": 0}}, "notHasData": {"data": []}, "vat": 0, "conv_fee": 0} | {"type": "object", "properties": {"availableData": {"type": "object", "properties": {"available": {}, "data": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "", "default": "SRI LANKAN AIRLINES"}, "registration_no": {"type": "string", "description": "", "default": "PB67"}}}}, "meta": {"type": "object", "properties": {"last_page": {"type": "integer", "description": "", "default": 1}, "per_page": {"type": "integer", "description": "", "default": 10}, "total": {"type": "integer", "description": "", "default": 2}}}}}, "notHasData": {"type": "object", "properties": {"available": {}, "data": {"type": "array", "items": {}}}}, "vat": {"type": "integer", "description": "", "default": 15}, "conv_fee": {"type": "integer", "description": "", "default": 2}}} |
4c46a390-d5f9-4eba-a82d-6f6162375acb/3440f9ce-a911-43cc-87ee-e4aabce577b3/0/0 | getTickets | get list of tickets | null | getTickets | tickets API | 200 | New Example | {"key1": "value", "key2": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]} |
f8bb204b-8e91-48af-996c-de621b8b4003/df2faa52-21e9-4309-a1a5-2ef988bc3e96/0/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | getProperty | Returns all the detailed information of a property by its ID | 400 | null | {"status": 400, "message": "Bad request"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/df2faa52-21e9-4309-a1a5-2ef988bc3e96/1/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | getProperty | Returns all the detailed information of a property by its ID | 404 | null | {"status": 404, "message": "Not found"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/df2faa52-21e9-4309-a1a5-2ef988bc3e96/2/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | getProperty | Returns all the detailed information of a property by its ID | 200 | null | {"status": 200, "message": "OK", "data": {"url": "https://www.realtor.com/realestateandhomes-detail/11844-26th-Ave-S_Seattle_WA_98168_M15401-78278", "type": "Property", "updatedAt": "2023-06-14T12:45:16.824Z", "latitude": 29.498542, "longitude": -98.71176, "name": "Westwood Terrace", "description": "Sixteen miles west of downtown San Antonio", "photos": ["https://res.cloudinary.com/apartmentlist/image/upload/c_fill,dpr_auto,f_auto,g_center,h_830,q_auto,w_1280/2053763926a493333f6ed8fe60efd957.jpg"], "id": "p230023", "rentalType": "apartment", "availabilityLastChecked": "2023-06-14T12:36:04.795Z", "address": "11139 Culebra Rd, San Antonio, TX 78254", "state": "TX", "city": "San Antonio", "postalCode": 78254, "amenities": ["Cats allowed"], "isActive": true, "isAdvertisable": true, "additionalFees": "Renter's insurance required", "applicationFee": "$75 per applicant", "leaseTerms": "3-13 months", "moveInFees": "$150 admin fee", "parkingDetails": "Covered lot included in the lease", "storageDetails": "Patio balcony storage", "depositFee": "$100 and $200", "availableUnits": [{"id": 6988962, "remoteListingId": 4872813, "name": "S1", "bed": 0, "bath": 1, "sqft": 522, "sqftMax": 1827, "price": 1881, "priceMax": 1999, "photos": ["https://res.cloudinary.com/apartmentlist/image/upload/c_fill,dpr_auto,f_auto,g_center,h_830,q_auto,w_1280/8bcb121ef4a8907821ce94875e5f4180.jpg"], "units": [{"id": 32975657, "remoteListingId": "2-101", "name": 7205, "price": 1050, "priceMax": 0, "sqft": 282, "availability": "available", "availableOn": "2023-05-06", "unitRentalId": "p230023-2-101", "updatedAt": "2023-05-26T00:47:53Z"}]}]}} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "object", "properties": {"url": {"type": "string"}, "type": {"type": "string"}, "updatedAt": {"type": "string"}, "latitude": {"type": "number"}, "longitude": {"type": "number"}, "name": {"type": "string"}, "description": {"type": "string"}, "photos": {"type": "array", "items": {"type": "string"}}, "id": {"type": "string"}, "rentalType": {"type": "string"}, "availabilityLastChecked": {"type": "string"}, "address": {"type": "string"}, "state": {"type": "string"}, "city": {"type": "string"}, "postalCode": {"type": "string"}, "amenities": {"type": "array", "items": {"type": "string"}}, "isActive": {"type": "boolean"}, "isAdvertisable": {"type": "boolean"}, "additionalFees": {"type": "string"}, "applicationFee": {"type": "string"}, "leaseTerms": {"type": "string"}, "moveInFees": {"type": "string"}, "parkingDetails": {"type": "string"}, "storageDetails": {"type": "string"}, "depositFee": {"type": "string"}, "availableUnits": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "number"}, "remoteListingId": {"type": "string"}, "name": {"type": "string"}, "bed": {"type": "number"}, "bath": {"type": "number"}, "sqft": {"type": "number"}, "sqftMax": {"type": "number"}, "price": {"type": "number"}, "priceMax": {"type": "number"}, "photos": {"type": "array", "items": {"type": "string"}}, "units": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "number"}, "remoteListingId": {"type": "string"}, "name": {"type": "string"}, "price": {"type": "number"}, "priceMax": {"type": "number"}, "sqft": {"type": "number"}, "availability": {"type": "string"}, "availableOn": {"type": "string"}, "unitRentalId": {"type": "string"}, "updatedAt": {"type": "string"}}}}}}}}}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/dbd2429f-5446-463d-93db-feb405b2a751/0/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | suggestLocation | Lookup for locations that are available to use. This endpoint's key attribute is necessary for search requests. | 200 | null | {"status": 200, "message": "OK", "data": [{"type": "city", "population": 45099, "name": "Texas City", "longName": "Texas City, Texas", "key": 660574, "slug": "/tx/texas-city", "latitude": 29.404933077370423, "longitude": -94.95106225727775}]} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "array", "items": {"type": "object", "properties": {"type": {"type": "string"}, "population": {"type": "number"}, "name": {"type": "string"}, "longName": {"type": "string"}, "key": {"type": "string"}, "slug": {"type": "string"}, "latitude": {"type": "number"}, "longitude": {"type": "number"}}}}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/dbd2429f-5446-463d-93db-feb405b2a751/1/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | suggestLocation | Lookup for locations that are available to use. This endpoint's key attribute is necessary for search requests. | 404 | null | {"status": 404, "message": "Not found"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/dbd2429f-5446-463d-93db-feb405b2a751/2/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | suggestLocation | Lookup for locations that are available to use. This endpoint's key attribute is necessary for search requests. | 400 | null | {"status": 400, "message": "Bad request"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/beafaafa-2cf4-4bdf-98d1-b397d4f1cc8f/0/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | searchProperties | Returns all the properties that matches up by the filters | 200 | null | {"status": 200, "message": "OK", "data": [{"id": "p153763", "latitude": 39.69847918488085, "longitude": -104.98667816631496}]} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}, "data": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "latitude": {"type": "number"}, "longitude": {"type": "number"}}}}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/beafaafa-2cf4-4bdf-98d1-b397d4f1cc8f/1/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | searchProperties | Returns all the properties that matches up by the filters | 404 | null | {"status": 404, "message": "Not found"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
f8bb204b-8e91-48af-996c-de621b8b4003/beafaafa-2cf4-4bdf-98d1-b397d4f1cc8f/2/0 | Apartment List | Extensive information from apartmentlist.com for data on millions of rental properties. | 9.4 | searchProperties | Returns all the properties that matches up by the filters | 400 | null | {"status": 400, "message": "Bad request"} | {"type": "object", "properties": {"status": {"type": "integer"}, "message": {"type": "string"}}} |
d9b53473-643d-41bb-94e2-4b31d085e2b8/2d8b3ae6-bbe4-4ca5-856e-dd9baf2045b1/0/0 | LokDon ECSMID V 1.0.0 | LokDon APIs are one of a kind built from LokDon ECSMID V 1.0.0, SDK, a next generation Cybersecurity, data/information security, and privacy control layer 1 (foundational) software packaged as a robust, fast, low-cost, security module as a software service (SMaaSS) using patented key less, e2e encryptiong. It is platform-agnostic and data security integration solution for authentication. This is based on a latice face key less infrastructure (LFKI). It has a base matrix of 2048 bits: Which me... | null | decryptPin | Decrypts the encrypted pin returned from encrypt/pin API. | 200 | Example_1 | {"cipher_text": "\u00e8\u0116\u00e7\u013d\u00e6\u0130\u00e5\u00dd\u0109x"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"cipher_text": {"type": "string"}}, "required": ["cipher_text"]} |
b619a1f3-5d73-41aa-a0ad-51d198555082/9d403578-4eae-472a-be1e-1c5ff5deca1b/0/0 | User Details Eample | Example of getting all users details | 7.6 | allUsers | Get all user details | 200 | Response | [{"ID": "1", "user_login": "admin", "user_pass": "$P$B4J0XS51ngi4G0.jpXNM8SpGulu7ZC.", "user_nicename": "admin", "user_email": "[email protected]", "user_url": "https://dev.capsquery.com/yofidelivery/", "user_registered": "2022-11-17 07:31:54", "user_activation_key": "", "user_status": "0", "display_name": "Yofi"}, {"ID": "4", "user_login": "ramesh.kumar", "user_pass": "$P$BlaDQJCLVeKnNnnCjn8hCy7gWhzYau0", "user_nicename": "ramesh-kumar", "user_email": "[email protected]", "user_url": "", "user_registered": "2023-01-06 14:26:36", "user_activation_key": "1673015196:$P$BH2/haOIzUaocyMkqLaoZ4E0qCKoFs0", "user_status": "0", "display_name": "Ramesh Kumar"}, {"ID": "11", "user_login": "yohan.vajifdar-8730", "user_pass": "$P$BOsO4VyRyzHnVIzz.hNGn6Djup3spp1", "user_nicename": "yohan-vajifdar-8730", "user_email": "[email protected]", "user_url": "", "user_registered": "2023-03-17 07:16:59", "user_activation_key": "1679037419:$P$B4WvvLEMYWTMpsGNlR4grBrCvTKqkV1", "user_status": "0", "display_name": "yohan vajifdar"}] | {"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"ID": {"type": "string"}, "user_login": {"type": "string"}, "user_pass": {"type": "string"}, "user_nicename": {"type": "string"}, "user_email": {"type": "string"}, "user_url": {"type": "string"}, "user_registered": {"type": "string"}, "user_activation_key": {"type": "string"}, "user_status": {"type": "string"}, "display_name": {"type": "string"}}, "required": ["ID", "display_name", "user_activation_key", "user_email", "user_login", "user_nicename", "user_pass", "user_registered", "user_status", "user_url"]}} |
43135df2-cd7c-42e5-b1b2-97265550d048/ac2ed101-b6bc-4989-a323-5845d0907744/0/0 | Foxit eSign | Quickly and effortlessly eSign documents with online signatures using Foxit eSign’s trusted and legally binding electronic signature software. | null | regenerateEmbeddedSigningSession | You can regenerate the folder embedded signing token for accessing the signature from the signer at any time. | 200 | null | {"emailIdOfSigner": "EMAIL_ID_OF_RECIPIENT_PARTY", "embeddedToken": "EMBEDDED_TOKEN_VALUE", "embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"} | {"properties": {"emailIdOfSigner": {"type": "string"}, "embeddedToken": {"type": "string"}, "embeddedSessionURL": {"type": "string"}}} |
43135df2-cd7c-42e5-b1b2-97265550d048/1093df2c-4699-467b-b605-118d8e3681bd/0/0 | Foxit eSign | Quickly and effortlessly eSign documents with online signatures using Foxit eSign’s trusted and legally binding electronic signature software. | null | updateEnvelopeFields | You can update a folder and its custom fields (custom_field1 and custom_field2) anytime before
it is executed using the this API route.
The fields for this folder corresponding to a specific party can only be updated if
the document has not been signed by that party yet. | 200 | null | {"result": "", "custom_field1": {"name": "custom_field_name", "value": "custom_field_value"}, "custom_field2": {"name": "custom_field_name", "value": "custom_field_value"}, "allFieldsNameValue": [{"fieldId": 0, "documentId": 0, "documentVersionId": 0, "fieldType": "textfield"}]} | {"description": "description of things", "properties": {"result": {"type": "string"}, "custom_field1": {"allOf": [{"type": "object", "description": "A Custom field that can be used many purposes such as\nidentifying the application and module where the signed document belongs.\nYou can use custom fields as per your requirements.\nMaximum of two custom fields can be passed to Foxit eSign via API that are stored at the folder level.\nWebhook response includes these custom field.\n", "properties": {"name": {"type": "string", "description": "The identifier of our custom field."}, "value": {"type": "string", "description": "The value that the custom field will show."}}}, {"type": "object"}]}, "custom_field2": {"allOf": [{"type": "object", "description": "A Custom field that can be used many purposes such as\nidentifying the application and module where the signed document belongs.\nYou can use custom fields as per your requirements.\nMaximum of two custom fields can be passed to Foxit eSign via API that are stored at the folder level.\nWebhook response includes these custom field.\n", "properties": {"name": {"type": "string", "description": "The identifier of our custom field."}, "value": {"type": "string", "description": "The value that the custom field will show."}}}, {"type": "object"}]}, "allFieldsNameValue": {"type": "array", "items": {"type": "object", "properties": {"fieldId": {"type": "number"}, "documentId": {"type": "number"}, "documentVersionId": {"type": "number"}, "fieldType": {"type": "string", "enum": ["textfield", "signfield", "initialfield", "datefield", "checkboxfield", "attachmentfield", "imagefield", "accept", "decline"]}}}}}} |
852f779b-54d8-48d3-86e8-f789589d62e8/cd74ba95-b311-4299-944d-8abfe7b3f605/0/0 | AusRoads | AusRoads OpenData | null | ausRoads | Primary api endpoint | 200 | Example_1 | {"Plate Number": "1GKW716", "Make": "SUBARU", "Model": "LIBERTY", "Year": "2011", "Colour": "WHITE", "This vehicle licence expires on": "26/09/2023"} | {"type": "object"} |
2fb1bc2e-caad-4e2f-8f19-292616ba1887/bc2c2580-765b-415a-b7a1-d49b3d37a150/0/0 | RankOnyx | Rankonyx is an API that helps you generate SEO keywords and find similar, high-performing keywords with low competition. It provides a list of relevant keywords and data on search volume and competition rank. Use Rankonyx to optimize your website or product for search engines and improve your search ranking. | 0.2 | Keyword Suggestions for site | This endpoint allows you to retrieve a list of suggested keywords for a given website. The response includes the keyword text, competition level, competition index, search volume, and top page bid range for each keyword.. These data points can help you understand the relative difficulty and value of ranking for each keyword on a specific website. | 200 | Google | [{"keywordText": "googles", "competition": "LOW", "competitionIndex": 0, "searchVolume": 68000000, "lowTopPageBid": 0.39, "highTopPageBid": 1.29}, {"keywordText": "login gmail", "competition": "LOW", "competitionIndex": 0, "searchVolume": 11100000, "lowTopPageBid": 0.55, "highTopPageBid": 2.13}, {"keywordText": "goo", "competition": "LOW", "competitionIndex": 0, "searchVolume": 3350000, "lowTopPageBid": 0.16, "highTopPageBid": 1.25}] | {"type": "array", "items": {"type": "object", "properties": {"keywordText": {"type": "string"}, "competition": {"type": "string"}, "competitionIndex": {"type": "integer"}, "searchVolume": {"type": "integer"}, "lowTopPageBid": {"type": "number"}, "highTopPageBid": {"type": "number"}}}} |
2fb1bc2e-caad-4e2f-8f19-292616ba1887/5146d797-0812-4cef-8162-95772cec5b9e/0/0 | RankOnyx | Rankonyx is an API that helps you generate SEO keywords and find similar, high-performing keywords with low competition. It provides a list of relevant keywords and data on search volume and competition rank. Use Rankonyx to optimize your website or product for search engines and improve your search ranking. | 0.2 | Keyword Suggestions | This endpoint allows you to retrieve a list of suggested keywords for a given search query filtered by location codes. The response includes the keyword text, competition level, competition index, search volume, and top page bid range for each keyword. You can also specify a keyword category to narrow the results to a particular industry or topic. These data points can help you understand the relative difficulty and value of ranking for each keyword in a specific location or set of locations. | 200 | Running Shoes Query | [{"keywordText": "best running shoes", "competition": "HIGH", "competitionIndex": 75, "searchVolume": 100000, "lowTopPageBid": 1.23, "highTopPageBid": 2.34}, {"keywordText": "running shoe reviews", "competition": "LOW", "competitionIndex": 60, "searchVolume": 50000, "lowTopPageBid": 0.78, "highTopPageBid": 1.56}] | {"type": "array", "items": {"type": "object", "properties": {"keywordText": {"type": "string"}, "competition": {"type": "string"}, "competitionIndex": {"type": "integer"}, "searchVolume": {"type": "integer"}, "lowTopPageBid": {"type": "number"}, "highTopPageBid": {"type": "number"}}}} |
2fb1bc2e-caad-4e2f-8f19-292616ba1887/27ce2b5b-6fd6-44dd-8b96-3908c188c3cc/0/0 | RankOnyx | Rankonyx is an API that helps you generate SEO keywords and find similar, high-performing keywords with low competition. It provides a list of relevant keywords and data on search volume and competition rank. Use Rankonyx to optimize your website or product for search engines and improve your search ranking. | 0.2 | Keyword Categories | This endpoint allows you to retrieve a list of keyword categories in various industries. The categories are organized by industry, and each category includes a list of related keywords. This data can help you understand the types of keywords that are commonly used within each industry. | 200 | Category List | [{"id": "1", "name": "Animals & Pets"}, {"id": "2", "name": "Arts & Entertainment"}, {"id": "3", "name": "Attorneys & Legal Services"}, {"id": "4", "name": "Automotive -- For Sale"}, {"id": "5", "name": "Automotive -- Repair, Service & Parts"}, {"id": "6", "name": "Beauty & Personal Care"}, {"id": "7", "name": "Business Opportunities"}, {"id": "8", "name": "Business Services"}] | {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.