{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4b5383a2-730f-42c9-9526-396b219b4c82","name":"Eat Partner APIs","description":"EatApp Partner APIs\n\n# Overview\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 accepting Gzip Encoding by passing `Accept-Encoding: 'gzip'` in the headers\n    \n- All APIs accept `Content-Type: 'application/json'` in the headers\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# Error Codes\n\nEat APIs are following the [HTTP standards status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) and [JSONAPI error response](https://jsonapi.org/examples/#error-objects-error-codes) format.\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 within 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  \"errors\": [\n    {\n      \"code\": \"many_requests\",\n      \"detail\": \"You exceted the requests limit, try again after sometime\"\n    }\n  ]\n}\n\n ```\n\n# Partner Portal\n\nWhile using the API, you can review the reservations and guest in HTML format by using the parter portal:\n\n- [Eat Partner Portal - Sandbox](https://sandbox.eatapp.co/portal)\n    \n- [Eat Partner Portal - Production](https://admin.eatapp.co/portal)\n    \n\nPlease use your provided email and password to login.\n\nWithin the partner portal you may also update the status of any partnership you have with eat. Click edit on any partership and update your status accordingly. This way you can keep track of partnership statuses on your end.\n\n# Regions\n\nYou may views your available regions on the partner portal. Once our team activates a partnership on one of the restaurants in a particular region, you can also query other API listings related to those regions.\n\n# API Changelog\n\n### Recent unversioned changes\n\n#### July 2, 2025\n\n- Return Payment details if exists in create and show reservation response\n    \n\n#### November 8, 2023\n\nSupporting preference in the reservation and availability APIs\n\n1. The Availability API response has been updated to include preferences and available slots based on those preferences. The response structure now includes: `preferences` an array of preferences including an array of time slots available for each preference\n    \n2. The response structure for the Creating, Listing, Updating, and Show reservation APIs has been updated to include the preference object\n    \n3. The Create and Update reservation API now accept a new parameter: `preference_id`. This parameter allows partners to specify their preference when making a booking or updating booking details.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6173104","team":226659,"collectionId":"4b5383a2-730f-42c9-9526-396b219b4c82","publishedId":"S1Lr4Av4","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6173104/S1Lr4Av4","privateUrl":"https://go.postman.co/documentation/6173104-4b5383a2-730f-42c9-9526-396b219b4c82","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-24T18:40:52.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/S1Lr4Av4"}