{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"84245951-897f-4357-bcb4-a6f628ccc28d","name":"NoShow Public API","description":"The NoShow Public API provides many endpoints allowing a partner to manage restaurants' bookings.\n\nYou can contact the development team at [dev@yproximite.com](https://mailto:dev@yproximite.com).\n\n# Overview\n\nEvery requests must include a valid Bearer Token (JWT) using the \"Authorization\" HTTP header.  \nThis token is issued using the \"Access Token\" endpoint.\n\nAlong with the link to this documentation, you may receive a pair \"Client-Id / Client-Secret\". This pair identifies the partner and allows them to request access token for any restaurant which has previously enabled the integration on NoShow.\n\nIf you do not have a pair yet, you can send an email to [dev@yproximite.com](https://mailto:dev@yproximite.com). We will create the credentials identifying your platform, and create a test establishment.\n\nMoreover, you must provide two additional headers :\n\n- \"Accept: application/json\"\n    \n- \"Content-Type: application/json\"\n    \n\nFinally, every resources returned by any endpoints are wrapped into a \"data\" key (which can be an object representing the resource, or an array of objects).\n\n# Includes\n\nEach endpoints which return a resource has an optional query parameter \"include\" allowing additional data retrieval.\n\nIncludes can be nested using a dot, such as \"reservations.menus\", and chained using a coma, such as \"reservations.menus,reservations.general_options\".\n\nAvailable includes for the given resource are listed at the beginning of each section.\n\n# Errors\n\nErrors are handled the same way on every endpoints.\n\nFirst, you'll receive an HTTP error code, matching the current error.  \nFor example, if you try to retrieve a non existing booking, a \"404 Not Found\" is triggered.\n\nSecond, you will always receive a JSON Response, including a global error message:\n\n``` json\n{\n    \"message\": \"Partner has not been allowed on target restaurant\"\n}\n\n ```\n\nThird, in some cases, the JSON Response will include an additional field named `error_code`:\n\n``` json\n{\n    \"message\": \"Unable to place booking for 2024-05-23\",\n    \"error_code\": 1\n}\n\n ```\n\nHere are the current available error codes:\n\n- `1`: Unable to launch the seating plan algorithm (in case of booking's creation, it means we are unable to place the booking on the seating plan)\n    \n- `2`: No changes recorded (for example, trying to set status \"validated\" on a booking which already has \"validated\" status)\n    \n- `3`: The gift voucher code is not recognized, this error can occurs only if the gift vouchers module is enabled.\n    \n- `4`: A gift voucher code for the booking has already been applied, this error can occurs only if the gift vouchers module is enabled.\n    \n- `5`: The tables linked are not available\n    \n- `6`: The establishment has no live services for the given tables\n    \n\nFinally, if the error occured during the request body validation (for example, on booking creation), the response body will include an additional \"errors\" field, with detailed information for each request field :\n\n``` json\n{\n    \"message\": \"The lastname field is required. (and 2 more errors)\",\n    \"errors\": {\n        \"lastname\": [\n            \"The lastname field is required.\"\n        ],\n        \"tel\": [\n            \"The tel field contains an invalid number.\"\n        ],\n        \"newsletter\": [\n            \"The newsletter field is required.\"\n        ]\n    }\n}\n\n ```\n\n# Phone Numbers\n\nThis API use a wrapper to Google's phone number library to validate and format phone numbers.  \nEven if many format are supported, we highly advise to use \"E164\", \"RFC3966\" or \"International\" format (NoShow uses the third one under the hood).\n\nIf no area code is specified (for example : 06 58 96 54 12), we assume a french phone number.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6512886","team":503370,"collectionId":"84245951-897f-4357-bcb4-a6f628ccc28d","publishedId":"VUjPH4z1","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6512886/VUjPH4z1","privateUrl":"https://go.postman.co/documentation/6512886-84245951-897f-4357-bcb4-a6f628ccc28d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"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":"EF5B25"}}]}},"version":"8.10.1","publishDate":"2024-05-06T07:04:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Base","id":"ce4ccff1-3dc7-43e7-a9cd-adb2ce155f2c","owner":"6512886","values":[{"key":"baseUrl","value":"https://api.noshow.io/v1","enabled":true,"type":"default"},{"key":"restaurantId","value":"RESTAURANT_ID","enabled":true,"type":"default"},{"key":"authClientId","value":"PROVIDED_BY_NOSHOW","enabled":true,"type":"default"},{"key":"authClientSecret","value":"PROVIDED_BY_NOSHOW","enabled":true,"type":"secret"},{"key":"accessToken","value":"ACCESS_TOKEN","enabled":true,"type":"default"},{"key":"clientId","value":"CLIENT_ID","enabled":true},{"key":"reservationId","value":"RESERVATION_ID","enabled":true,"type":"default"},{"key":"slotId","value":"SLOT_ID","enabled":true,"type":"default"},{"key":"siret","value":"RESTAURANT_SIRET","enabled":true,"type":"default"},{"key":"restaurantSecret","value":"","enabled":true,"type":"any"}],"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/ede5b73c6ea3e2a5f76a33a7bd9c0c58dfcbb34d6615bc184b8581241a056dd3","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":"Base","value":"6512886-ce4ccff1-3dc7-43e7-a9cd-adb2ce155f2c"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/VUjPH4z1"}