This is a developer portal offered by OpenTable!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"24127212","collectionId":"3599f6fc-bfb2-40d3-ba14-51226f7162ac","publishedId":"2sA3rwKtUR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"DC143C"},"publishDate":"2024-09-27T07:42:39.000Z"},"item":[{"name":"Restaurant Onboarding API","item":[{"name":"APIs","item":[{"name":"Obtaining an Access Token","id":"e0aa6299-bb6c-4572-a047-827f818817c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client-id}}"},{"key":"password","value":"{{client-secret}}"}],"advancedConfig":[{"key":"saveHelperData","value":"OpenTable uses OAuth 2.0 to authorize access to protected resources. Authorization involves following steps:
\nRequest client id and secret
\nObtain an access token using the issued client credentials
\nUse the access token to access protected resources
\nClient credentials are submitted in the Authorization header as defined in the OAuth spec. Given a client id (e.g., “client_id”) and a client secret (e.g., “client_secret”), you need to do the following:
Concatenate them using a “:” (e.g., “client_id:client_secret”)
\nBase64 encode the result from step 1 (e.g., “Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=”)
\nSet the header “Authorization: Basic ” (e.g., “Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=”)
\nNote: For Oauth token POST requests, it is mandatory to include the Content-Length header, even when the request body is empty. In these instances, set the Content-Length to 0. If using GET requests for Oauth tokens, no update is required.
Using the below information, partners can create new restaurants in the OpenTable system by publishing a payload of their restaurant information.
\nPartners must supply all required information to successfully onboard a restaurant in the OpenTable environment.
\nOnce the restaurant has been onboarded, or provisioned, in the OpenTable environment, OpenTable will return the corresponding OpenTable restaurant ID, or RID.
\nNot all partners will be certified to create new restaurants and will only be able to update content of existing restaurants. And, depending on the partnership, the partner will only be able to create a specific type of restaurant on the OpenTable Network.
\nShould you not have any idea on one of the required fields, please send it back as “null”.
\nIf you would like to remove any existing data and leave the field empty and it will append the attribute and delete whatever detail is inside.
\nTo modify an existing restaurant, the same endpoint for creating a new restaurant is used. OpenTable systems will detect that the restaurant is already onboarded and will use the submitted payload to update the existing restaurant.
\nPartners must supply all required information to successfully modify a restaurant in the OpenTable environment; we do not support any type of partial payload submissions (i.e. we do not call any PATCH updates or PUT for only missing details).
\n","urlObject":{"path":["v2","partnerrestaurants"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8dba04f2-9d59-40df-a9e1-8d70eaf7bdd8"},{"name":"Onboarding Status API","id":"638c7f84-23fe-41c4-83b8-5cb16e95e23e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}/provisionstatus","description":"Partners can get the status of a restaurant they have submitted for onboarding by calling a designated API endpoint with the below parameters.
\nRequest Attributes
\nThe following table outlines the response attributes returned when getting the status of a restaurant being onboarded.
\nFor the response attributes, there will be one element in the response list for each time the partner has posted to the restaurant.
\n","urlObject":{"path":["v2","partnerrestaurants","{{partner-restaurant-identifier}}","provisionstatus"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"c491b67a-90b6-4a12-b949-827202bc4143","name":"404","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}/provisionstatus"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"41fda95f-bdf7-4717-a0b8-18300f1cc2c9"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"05811C77-A93A-46E6-BD0E-DD85317A84A4"},{"key":"x-ot-backend","value":"pdp"},{"key":"x-ot-uritemplate","value":"/pdp/writeback/v3/partnerrestaurants/{id}/status"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"50"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Thu, 26 Sep 2024 11:14:32 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"4df33049-fd48-4af6-a5cf-1b43cb74d9a1","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}/provisionstatus"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"19f66070-befb-48a9-b8ed-bc74e0be10de"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"05811C77-A93A-46E6-BD0E-DD85317A84A4"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-ot-backend","value":"pdp"},{"key":"x-ot-uritemplate","value":"/pdp/writeback/v3/partnerrestaurants/{id}/status"},{"key":"x-envoy-upstream-service-time","value":"17"},{"key":"Content-Length","value":"237"},{"key":"Date","value":"Thu, 26 Sep 2024 11:17:28 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-09-26T14:36:03.575+0000\",\n \"path\": \"/gateway/proxies/restaurantpartnerapigateway/pdp/writeback/v3/partnerrestaurants/123456789/status\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Not authorized\",\n \"requestId\": \"7942126a\"\n}"},{"id":"dfbc284e-7b46-4092-897f-b69e3be7616a","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}/provisionstatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"e271e6d4-c056-4141-be78-dcdfce6958d4"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"05811C77-A93A-46E6-BD0E-DD85317A84A4"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"80"},{"key":"x-ot-backend","value":"pdp"},{"key":"x-ot-uritemplate","value":"/pdp/writeback/v3/partnerrestaurants/{id}/status"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 26 Sep 2024 14:31:10 GMT"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": [\n {\n \"itemId\": \"123456789\",\n \"sequenceId\": 38434555,\n \"status\": \"Processing\",\n \"statusTimestamp\": \"2024-09-26T14:14:25.850014Z\"\n },\n {\n \"itemId\": \"123456789\",\n \"sequenceId\": 38435049,\n \"status\": \"Processing\",\n \"statusTimestamp\": \"2024-09-26T14:14:52.048124Z\"\n }\n ]\n}"}],"_postman_id":"638c7f84-23fe-41c4-83b8-5cb16e95e23e"},{"name":"General Status API","id":"0e5d713b-9341-4bfc-a435-1924af4f020b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}","description":"Partners can get the status of a restaurant that has been onboarded by calling a designated API endpoint with the below parameters.
\nThe following table outlines the response attributes returned when getting the status of a restaurant being onboarded.
\nFor the response attributes, there will be one element in the response list for each time the partner has posted to the restaurant.
\n","urlObject":{"path":["v2","partnerrestaurants","{{partner-restaurant-identifier}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"b88b2c16-b1aa-47ab-967c-c2ea264e78c8","name":"404","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"41fda95f-bdf7-4717-a0b8-18300f1cc2c9"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"05811C77-A93A-46E6-BD0E-DD85317A84A4"},{"key":"x-ot-backend","value":"pdp"},{"key":"x-ot-uritemplate","value":"/pdp/writeback/v3/partnerrestaurants/{id}/status"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"50"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Thu, 26 Sep 2024 11:14:32 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"8dbb9121-6673-42ec-acaf-90d77783b863","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"7297cd01-95e8-4a57-a853-6717aaf1198a"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"05811C77-A93A-46E6-BD0E-DD85317A84A4"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"52"},{"key":"x-ot-backend","value":"pdp"},{"key":"x-ot-uritemplate","value":"/pdp/writeback/v3/partnerrestaurants/{id}/status"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 26 Sep 2024 11:15:06 GMT"},{"key":"Content-Length","value":"134"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantId\": \"123456789\",\n \"openTableRid\": \"374684\",\n \"active\": true,\n \"created\": \"2024-09-26T14:29:09.399163Z\",\n \"lastUpdated\": \"2024-09-26T14:29:09.399163Z\",\n \"restaurantName\": \"Restaurant Bar and Grill\",\n \"address\": {\n \"address1\": \"123 Restaurant Street\",\n \"address2\": \"Suite 123\",\n \"city\": \"Sydney\",\n \"state\": \"AU-NSW\"\n },\n \"description\": \"Coming Soon!\",\n \"phoneNumber\": \"+61396473436\"\n}"},{"id":"63b4351c-ec82-4c69-9260-ef76012eaaae","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"19f66070-befb-48a9-b8ed-bc74e0be10de"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"05811C77-A93A-46E6-BD0E-DD85317A84A4"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-ot-backend","value":"pdp"},{"key":"x-ot-uritemplate","value":"/pdp/writeback/v3/partnerrestaurants/{id}/status"},{"key":"x-envoy-upstream-service-time","value":"17"},{"key":"Content-Length","value":"237"},{"key":"Date","value":"Thu, 26 Sep 2024 11:17:28 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-09-26T11:17:27.970+0000\",\n \"path\": \"/gateway/proxies/restaurantpartnerapigateway/pdp/writeback/v3/partnerrestaurants/abc123abc/status\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Not authorized\",\n \"requestId\": \"3b9f20ae\"\n}"}],"_postman_id":"0e5d713b-9341-4bfc-a435-1924af4f020b"},{"name":"Delete API","id":"c460389b-a3ff-4315-b223-a067336d50a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer [token]","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/v2/partnerrestaurants/{{partner-restaurant-identifier}}","description":"Partners can delete a restaurant on the OpenTable network that they onboarded by calling a designated API endpoint with the below parameters.
\nDelete will return a similar payload to POST, there will be a single itemStatus. Status will typically be ‘Processing’ and will change to Success or Failed once the conversion is complete.
The following table outlines the response attributes returned when deleting a restaurant.
Using the instructions below, access our API documentation for a step-by-step guide to using the Onboarding API.
\nGet an Oauth Token - Using your credentials, call OpenTable’s Oauth authentication service to get a token.
\nCreating New Restaurant API - Create new restaurant profiles on OpenTable
\nModify existing restaurant API - Use the endpoint to modify existing OpenTable profiles
\nCheck the onboarding status - Check the status of the restaurant that has been submitted
\nDelete restaurant API - Delete a restaurant on the OpenTable network
\nUkrainian
\nVegetarian
\nPizzeria
\nTraditional Mexican
\nTartar
\nRegional Mexican
\nBar / Lounge / Bottle Service
\nKappou
\nItalian
\nNordic
\nEastern European
\nRhenish
\nTurkish
\nTraditional French
\nSwedish
\nHibachi
\nRussian
\nGreek
\nPacific Rim
\nWine Bar
\nHawaiian
\nFrench / Indian
\nBrazilian
\nJapanese
\nWest Indian
\nSouth Indian
\nAustrian
\nCambodian
\nChinese
\nBreakfast
\nBistro
\nPolynesian
\nRegiomontana
\nOttoman
\nQuebec
\nBeer Garden
\nSouthwest
\nChinese (Canton)
\nDanish
\nFrench
\nUruguayan
\nRegional Mexican (Baja Med)
\nEuropean
\nIndian
\nNative American
\nComfort Food
\nContemporary Mexican
\nEcuadorian
\nContemporary French / American
\nPeruvian
\nLatin American
\nScottish
\nSerbian
\nAsian
\nOrganic
\nSushi
\nBritish
\nSouthern
\nModern Tuscan
\nSouth Carolina
\nArgentinean
\nContemporary German
\nModern Australian
\nThai
\nPolish
\nRegional Italian (Sardinia)
\nGrill
\nKosher
\nMiddle Eastern
\nBelgian
\nGerman
\nIraqi
\nSteakhouse
\nLatin / Spanish
\nFusion / Eclectic
\nCroatian
\nVegan
\nOkonomiyaki
\nCreative Japanese
\nUnspecified
\nSouth American
\nBlow Fish
\nCuban
\nRegional German (Berlin)
\nIndonesian / Malaysian
\nVietnamese
\nEthiopian
\nCreole
\nNorthwest Spain
\nContemporary European
\nSoutheast Asian
\nEgyptian
\nCajun
\nYakitori
\nLow Country
\nContemporary Korean
\nOyster Bar
\nCentral Asian
\nDim Sum
\nTex-Mex
\nChinese (Sichuan)
\nAfghan
\nSouth African
\nNew Zealand
\nFilipino
\nChilean
\nHungarian
\nBarbecue
\nCreole / Cajun / Southern
\nContemporary American
\nIrish
\nOkinawan
\nMedieval
\nLounge
\nKorean
\nDinner Cruise
\nSeafood
\nChinese (Shanghai)
\nCrossover
\nRamen
\nDining Bar
\nMalaysian
\nColombian
\nTempura
\nContemporary British
\nYum Cha
\nAfternoon Tea
\nSouthwest Spain
\nBurmese
\nSouthern Spain
\nAmerican
\nPub
\nBrazilian Steakhouse
\nSouthern German
\nCzech
\nHome cooking
\nContinental
\nDutch
\nCountry kitchen
\nPakistani
\nFondue
\nYakiniku
\nPersian
\nDeli
\nShabu-shabu
\nBavarian
\nWild Game
\nNorthwest
\nAustralian
\nWinery
\nEurasian
\nKaiseki
\nCreperie
\nLebanese
\nFrench / Canadian
\nPizza Bar
\nFrench American
\nHawaii Regional Cuisine
\nContemporary French
\nMeat
\nMotsunabe
\nMacedonian
\nContemporary Indian
\nSwiss
\nNorthwest British
\nIndonesian
\nMoroccan
\nCatalan
\nFine cuts
\nChinese (Beijing)
\nAfrican
\nContemporary Southern
\nMexican
\nSports Bar
\nSicilian
\nKyoto-style
\nKushikatsu
\nTraditional Spanish
\nDessert
\nMarket Cuisine
\nThai French
\nJugoslavian
\nMexican / Southwestern
\nJapanese Speciality
\nEnglish
\nRotisserie Chicken
\nRegional Japanese
\nTapas / Small Plates
\nSouthwest British
\nRegional German
\nIzakaya
\nDistillery
\nIsraeli
\nSoba
\nSouthwest French
\nCaribbean
\nSri Lankan
\nLaotian
\nProvencal
\nBottle Service
\nEritrean
\nContemporary Italian
\nYoshoku
\nContemporary Latin
\nSouthern British
\nVenezuelan
\nNorth African
\nBasque
\nCreative Western
\nCocktail Bar
\nPuerto Rican
\nJamaican
\nShellfish
\nCanadian
\nMediterranean
\nSpeakeasy
\nBrewery
\nSteak
\nBalkan style
\nFrench / Japanese
\nNorthwest Germany
\nPalestinian
\nPork
\nSwaibian
\nPan-Asian
\nPortuguese
\nModern European
\nPanamanian
\nNepalese
\nHalal
\nFish
\nPrime Rib
\nCalifornian
\nIcelandic
\nInternational
\nTeppanyaki
\nSyrian
\nSukiyaki
\nCafé
\nNorthern Mexican
\nBurgers
\nSpanish
\nContemporary Asian
\nGeorgian
\nSoul food
\nChinese (Taiwan)
\nGlobal, International
\nWashoku
\nContemporary Canadian
\nSouthwest German
\nVegetarian / Vegan
\nGastro Pub
\nScandinavian
\nFarm-to-table
\n| Banquet | Bar/Lounge | Beer Garden | Cafe | Chef's Table | Cigar Room |
| Counter Seating | Dancing | Delivery | Dog Friendly | Entertainment | Happy Hour |
| High Tea | Indoor Fireplace | Late Night | Outdoor Firepit | Patio/Outdoor Dining | Private Room |
| Takeout | View | Weekend Brunch | Gender Neutral Restroom | Wheelchair Access |
What changes does Opentable consider to be “backwards-compatible”?
\nAdding new API resources
\nAdding new optional request parameters to existing API methods
\nAdding new properties to existing API responses
\nRenaming API resources
\nChanging the order of properties in existing API responses
\nChanging the length or format of reservation IDs or other opaque strings - this includes adding or removing fixed prefixes where applicable
\nURLs in responses including format, querystring parameters, and address
\nThe Restaurant Onboarding API collection is a group of APIs that allows certified partners to create new, check the status of, and decommission existing restaurants from their environment to the OpenTable environment.
\n","_postman_id":"6c2ff4e2-512d-471c-bb2b-fb1fe524871c"}]}