{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a07ccee2-3699-49f0-a944-b3fb29972e9f","name":"Zenchef API Documentation / Generic POS","description":"Zenchef API provides all resources relating to bookings necessary for any kind of Zenchef partner\n\n# Overview\n\nTo connect to the API, you will need:\n\n- an authentication token\n    \n- a restaurant id\n    \n\nThey're both necessary to identify your calls on the API. The restaurant can find this information on the Zenchef web app account under settings > partners page.\n\n# **Host**\n\n- Production environment : [https://api.zenchef.com/api/v1](https://api.zenchef.com/api/v1)\n    \n- Test environment : [https://api.preproduction.zenchef.io/api/v1](https://api.preproduction.zenchef.io/api/v1)\n    \n\n# Authentication\n\nEvery call should provide the following information in header:\n\n- Content-Type: application/json\n    \n- auth-token: your authentication token\n    \n- restaurantId: Zenchef restaurant identifier\n    \n\n# Error Codes\n\nYou can expect HTTP error codes. For example:\n\n- 200 OK\n    \n- 404 Forbidden\n    \n- 412 Duplicate content\n    \n\n# Guidelines\n\nBelow you can find some guidelines to create an optimal integration between Zenchef and the POS.\n\n- **Reservations**:\n    \n    - Shared documentation lets you integrate Zenchef reservations into your POS. Information is exchanged in both directions.\n        \n    - Optimum integration enables you to exchange 4 types of information that can be shared between the two systems:\n        \n        - Reservations (reciprocal)\n            \n        - Zenchef status (waiting list, on hold, confirmed, seated, finished, etc.)\n            \n        - Invoice and average ticket information on reservations and customer files.\n            \n- **Examples**:\n    \n    - `booking created` from Zenchef to POS and reverse\n        \n    - `booking updated` : from Zenchef to POS and reverse\n        \n    - `booking seated` : table/order opened/reservation seated on POS → booking status update on same table n° on Zenchef\n        \n    - `walk-in created/seated` : table/order opened on POS → walk-in created on the empty table on Zenchef\n        \n    - `booking over` : order paid - booking(walk-in) status update on same table n° on Zenchef + order_invoice retrieved\n        \n- **`Payment`**`:`\n    \n    - By flashing the QR code, Zenchef PAY identifies the restaurant and the table number.\n        \n    - Zenchef's reverse API enables open orders to be sent from the POS to the end customer's smartphone.\n        \n    - The end customer selects an amount or items to pay. Validate and pay\n        \n    - Zenchef's reverse API inserts the payment amount into the cash register.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"874040","team":30397,"collectionId":"a07ccee2-3699-49f0-a944-b3fb29972e9f","publishedId":"Uz5AseV7","public":true,"publicUrl":"https://documenter-api.postman.tech/view/874040/Uz5AseV7","privateUrl":"https://go.postman.co/documentation/874040-a07ccee2-3699-49f0-a944-b3fb29972e9f","customColor":{"top-bar":"FFD200","right-sidebar":"3b3e3a","highlight":"dbb704"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.12.12","publishDate":"2022-05-27T07:40:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"PROD - Generic","id":"6ce214cf-bad8-4cbb-9108-b329c269fc8a","owner":"874040","values":[{"key":"host","value":"https://api.zenchef.com/api/v1","enabled":true},{"key":"token","value":"AUTH-TOKEN","enabled":true},{"key":"restaurantId","value":"RESTAURANT-ID","enabled":true},{"key":"hostv2","value":"https://api.zenchef.com/api/v2","enabled":true},{"key":"bookingId","value":"BOOKING-ID","enabled":true},{"key":"host_wh","value":"https://api.zenchef.com/webhooks","enabled":true},{"key":"root_host","value":"https://api.zenchef.com","enabled":true},{"key":"commandId","value":"COMMAND-ID","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://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/t_team_logo_pubdoc/v1/team/6d5aca47d05a12bb3c1de4742036e4ac9a749d7de2e1fb5981c8b4e173c31192","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":"PROD - Generic","value":"874040-6ce214cf-bad8-4cbb-9108-b329c269fc8a"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Uz5AseV7"}