{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5f5ec2e3-8035-4256-b730-3a2f319fffd8","name":"Eat Concierge API","description":"Eat App Concierge APIs\n\n# Overview\n\nThe concierge API's allow restaurants, restaurant vendors and groups managing booking and access data across our table management system.\n\nThe system can only be accessed by `Concierge Users` using a provided API key.\n\n# Concierge Users\n\n- Concierge users can only be created by Eat.\n    \n- Each Concierge user will be accompanied by a long term API key for authentication\n    \n- Each Concierge user will be assigned to the reservations they create or alter\n    \n- Concierge user can be assigned to groups of custom restaurant lists.\n    \n- Concierge groups limit scope of access to a select group of restaurants\n    \n- Certain endpoints require the group id to be provided in the header to allow Eat to better understand the scope intentions\n    \n- Many Concierge user can be granted access across many groups, however, although this is possible, for troubleshooting and invesigation purposes we always suggest a simple approach with grouping\n    \n\n# API Requirements\n\n- All APIs are using [JSONAPI](http://jsonapi.org) response format and accepts JSON in the request's body for POST and PATCH endpoints.\n    \n- All APIs accept `Content-Type: 'application/json'` in the headers\n    \n- All APIs accept Gzip Encoding by passing `Accept-Encoding: 'gzip'` in the headers\n    \n\n# API Scopes\n\nFor certain endpoints, a restaurant.id or group.id may be required to scope the data.\n\nIn both cases the preferred method is to pass those values in the headers are follows;\n\n``` http\nX-Group-ID: {{group_id}}\n\n ```\n\nor\n\n``` http\nX-Restaurant-ID: {{restaurant_id}}\n\n ```\n\nIf for some reason you cannot modify the request headers, you can pass the id scopes via url params as follows;\n\n``` http\nsome_url?group_id={{group_id}}\n\n ```\n\nor\n\n``` http\nsome_url?restaurant_id={{restaurant_id}}\n\n ```\n\n# Authentication\n\nAll the endpoints required authentication that needs to pass it in the request header as:\n\n```\nAuthorization: Bearer {{api_token}}\n\n ```\n\n> Note - All API keys are assigned to Concierge users, all API keys are povided by eat \n  \n\n## Authentication Error Response (Example)\n\n``` json\n{\n  \"error_code\": \"authorization_invalid\",\n  \"error_message\": \"Authentication token is expired\",\n  \"validations\": []\n}\n\n ```\n\n# Error Codes\n\nEat APIs are following the [HTTP standards status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) format.\n\n## Overview of Error Codes\n\n### Status Code Symbol\n\n- 1xx Informational\n    \n- 100 :continue\n    \n- 101 :switching_protocols\n    \n- 102 :processing\n    \n\n### 2xx Success\n\n- 200 :ok\n    \n- 201 :created\n    \n- 202 :accepted\n    \n- 203 :non_authoritative_information\n    \n- 204 :no_content\n    \n- 205 :reset_content\n    \n- 206 :partial_content\n    \n- 207 :multi_status\n    \n- 226 :im_used\n    \n\n### 3xx Redirection\n\n- 300 :multiple_choices\n    \n- 301 :moved_permanently\n    \n- 302 :found\n    \n- 303 :see_other\n    \n- 304 :not_modified\n    \n- 305 :use_proxy\n    \n- 307 :temporary_redirect\n    \n\n### 4xx Client Error\n\n- 400 :bad_request\n    \n- 401 :unauthorized\n    \n- 402 :payment_required\n    \n- 403 :forbidden\n    \n- 404 :not_found\n    \n- 405 :method_not_allowed\n    \n- 406 :not_acceptable\n    \n- 407 :proxy_authentication_required\n    \n- 408 :request_timeout\n    \n- 409 :conflict\n    \n- 410 :gone\n    \n- 411 :length_required\n    \n- 412 :precondition_failed\n    \n- 413 :request_entity_too_large\n    \n- 414 :request_uri_too_long\n    \n- 415 :unsupported_media_type\n    \n- 416 :requested_range_not_satisfiable\n    \n- 417 :expectation_failed\n    \n- 422 :unprocessable_entity\n    \n- 423 :locked\n    \n- 424 :failed_dependency\n    \n- 426 :upgrade_required\n    \n- 429 :too_many_requests\n    \n\n### 5xx Server Error\n\n- 500 :internal_server_error\n    \n- 501 :not_implemented\n    \n- 502 :bad_gateway\n    \n- 503 :service_unavailable\n    \n- 504 :gateway_timeout\n    \n- 505 :http_version_not_supported\n    \n- 507 :insufficient_storage\n    \n- 510 :not_extended\n    \n\n# Rate limit\n\nAll the endpoints are limited to `60 requests per minute` after locked out you will be able to hit again until the next minute.\n\n> Note this limit can be altered to suit requirements \n  \n\nRate limit response with status 429 and body response :\n\n``` json\n{\n  \"error_code\": \"too_many_requests\",\n  \"error_message\": \"You exceeded the requests limit, try again after sometime\",\n  \"validations\": []\n}\n\n ```\n\n# Changes Log\n\n#### 18 Dec 2025\n\n- Add [New Reservation Lookup API](#37115617-22708092-c68c-48de-8791-ed9fbcb4bd94)\n    \n\n#### 13 May 2025\n\n- Add [New Vouchers API](#a4f6dd8a-6f51-4802-a429-2e43d43f840c)\n    \n- Support `vouchers` in [Create](#477488e7-1c36-438c-96cb-c67829d63227) and [Update](#4aa8c582-57d6-4b27-9006-be851b10c996) Reservation API\n    \n- Add `voucher_assignments` to [reservation response](#97833204-581d-4ae1-9a09-0a6cc29e8780)\n    \n- Add `voucher_assignments` to [guest response](#a34f5e36-7638-4494-8954-b1526fe02e71)\n    \n- Support `add_loyalty_points` in [Create](#477488e7-1c36-438c-96cb-c67829d63227) Reservation API\n    \n- Support `redeem_loyalty_points` in [Create](#477488e7-1c36-438c-96cb-c67829d63227) Reservation API\n    \n- Add `loyalty_points` to [reservation response](#97833204-581d-4ae1-9a09-0a6cc29e8780)\n    \n- Add `loyalty_points` in [List](#e3699537-a0d2-4355-8ed0-879144cee67a) and [Show](#a34f5e36-7638-4494-8954-b1526fe02e71) Guest API\n    \n\n#### 24 December 2024\n\n- Add wait list options to the [New Availability API](#e87c3694-48f5-445e-98e6-3e60b0bb8c52)\n    \n- Add option to only return available slots in search parameters in [New Availability API](#e87c3694-48f5-445e-98e6-3e60b0bb8c52)\n    \n- Allow wait list reservation in [Create Reservation API](#477488e7-1c36-438c-96cb-c67829d63227)\n    \n\n#### 29 October 2024\n\n- Add `remaining_covers` to the [New Availability API](#e87c3694-48f5-445e-98e6-3e60b0bb8c52)\n    \n- Add `terms_and_conditions` to `restaurnat` relationship to [reservations response](#97833204-581d-4ae1-9a09-0a6cc29e8780)\n    \n- Remove `spots` from the [New Availability API](#e87c3694-48f5-445e-98e6-3e60b0bb8c52)\n    \n\n#### 25 October 2024\n\n- Add `shift_name` to [reservation response](#97833204-581d-4ae1-9a09-0a6cc29e8780)\n    \n- Add `restaurnat` relationship to [reservations response](#97833204-581d-4ae1-9a09-0a6cc29e8780)\n    \n- Change last name to optional in [Create](#477488e7-1c36-438c-96cb-c67829d63227) Reservation API\n    \n- Add `spots` to the [New Availability API](#e87c3694-48f5-445e-98e6-3e60b0bb8c52)\n    \n\n#### 22 October 2024\n\n- Support Custom Fields in [Create](#477488e7-1c36-438c-96cb-c67829d63227) and [Update](#4aa8c582-57d6-4b27-9006-be851b10c996) Reservation API\n    \n- Show Custom Fields in [List](#04776dc0-1f17-419e-bc32-a292a8ac36fa) and [Show](#4a1833a3-3f1e-4797-b983-060b754bae23) Reservation API\n    \n- Show Custom Fields in [List](#e3699537-a0d2-4355-8ed0-879144cee67a) and [Show](#a34f5e36-7638-4494-8954-b1526fe02e71) Guest API\n    \n- Update [Rate Limit](#rate-limit)\n    \n\n#### 20 October 2024\n\n- Add [New Availability API](#e87c3694-48f5-445e-98e6-3e60b0bb8c52)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6372626","collectionId":"5f5ec2e3-8035-4256-b730-3a2f319fffd8","publishedId":"SWLcc85D","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6372626/SWLcc85D","privateUrl":"https://go.postman.co/documentation/6372626-5f5ec2e3-8035-4256-b730-3a2f319fffd8","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-08-29T09:17:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Bonsai Sandbox","id":"06500289-f0a8-499c-ac5b-eb9f8a028f3b","owner":"10495480","values":[{"key":"host","value":"https://api.eat-sandbox.co","enabled":true},{"key":"key","value":"key","enabled":true,"type":"default"},{"key":"token","value":"abc","enabled":true},{"key":"partner_email","value":"support@partner.com","enabled":true},{"key":"partner_password","value":"your_password","enabled":true},{"key":"restaurant_id","value":"RESTAURANT_UUID","enabled":true},{"key":"restaurant_email","value":"support@restaurant.com","enabled":true},{"key":"restaurant_password","value":"your_password","enabled":true},{"key":"group_id","value":"GUEST_UUID","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/493b3c2ed8a797bf8b8565bd4a712bebbc301a5367ca4797a4cba3905172d667","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Bonsai Sandbox","value":"10495480-06500289-f0a8-499c-ac5b-eb9f8a028f3b"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SWLcc85D"}