{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b5475278-8b0f-41f8-9fd5-bf2972cc0aaf","name":"Eat POS - Open API","description":"# Eat App Open POS API\n\n## Overview\n\nThe open POS API's allows POS providers to publish POS tickets to our table management system.\n\nThe system can only be accessed using a provided API key.\n\n## Use Cases\n\n### POS Ticket Creation\n\n- When a POS ticket is opened on the system, post the entire POS ticket payload to eat app.\n- Make sure to post the entire payload in the ticket body with the webhook meta data\n\n### POS Ticket Updates\n\n- When a POS ticket is modified, closed, voided, re-opened, un-voided etc., post the entire POS ticket payload to eat app.\n- Note - we require the current complete ticket, not the changed parts. \n- You use the same endpoint, Eat will handle create/update logic.\n\n## API Requirements\n\n- All APIs are using [JSONAPI](http://jsonapi.org)\n- All APIs require `Content-Type: 'application/json'` in the headers\n\n### Basics\n\n- We require some webhooks specific meta data\n- For the ticket, the id must be 100% unique\n- We replace the entire POS ticket on each webhook event\n- Ordering is important, post batch updates in order\n\n### Mapping\n\n- We need the POS provider to provide us with unique location id's for each restaurant, we user this number to map your POS location <> our restaurant.\n- We need table numbers mentioned in each ticket to allow matching to our reservations (note: we offer a UI to map this values on our end)\n\n## Authentication\n\nAll the endpoints required authentication that needs to pass it in the request header as:\n\n```http\nAuthorization: Bearer {{api_token}}\n```\n> Note - All API keys are provided to POS vendors by eat\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## 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- 100 :continue\n- 101 :switching_protocols\n- 102 :processing\n\n#### 2xx Success\n\n- 200 :ok\n- 201 :created\n- 202 :accepted\n- 203 :non_authoritative_information\n- 204 :no_content\n- 205 :reset_content\n- 206 :partial_content\n- 207 :multi_status\n- 226 :im_used\n\n### 3xx Redirection\n\n- 300 :multiple_choices\n- 301 :moved_permanently\n- 302 :found\n- 303 :see_other\n- 304 :not_modified\n- 305 :use_proxy\n- 307 :temporary_redirect\n\n#### 4xx Client Error\n\n- 400 :bad_request\n- 401 :unauthorized\n- 402 :payment_required\n- 403 :forbidden\n- 404 :not_found\n- 405 :method_not_allowed\n- 406 :not_acceptable\n- 407 :proxy_authentication_required\n- 408 :request_timeout\n- 409 :conflict\n- 410 :gone\n- 411 :length_required\n- 412 :precondition_failed\n- 413 :request_entity_too_large\n- 414 :request_uri_too_long\n- 415 :unsupported_media_type\n- 416 :requested_range_not_satisfiable\n- 417 :expectation_failed\n- 422 :unprocessable_entity\n- 423 :locked\n- 424 :failed_dependency\n- 426 :upgrade_required\n- 429 :too_many_requests\n\n#### 5xx Server Error\n\n- 500 :internal_server_error\n- 501 :not_implemented\n- 502 :bad_gateway\n- 503 :service_unavailable\n- 504 :gateway_timeout\n- 505 :http_version_not_supported\n- 507 :insufficient_storage\n- 510 :not_extended\n\n## Rate limit\n\nAll the endpoints are limited to `300 requests per minute` after locked out you will be able to hit again within 15 minutes.\n> Note this limit can be altered to suit requirements\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```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6372626","collectionId":"b5475278-8b0f-41f8-9fd5-bf2972cc0aaf","publishedId":"TzshHRBE","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6372626/TzshHRBE","privateUrl":"https://go.postman.co/documentation/6372626-b5475278-8b0f-41f8-9fd5-bf2972cc0aaf","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:13.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/TzshHRBE"}