![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXfDeWFdsZQy7SzgpkmQRjIzedP3NYE2LLEmtf6xAWVlUC6JNp7lRqMMnmHJMt93jRmYyA66Lp-V-SRoWGT_bIBth0qVthgEu9M4yZNA2xRKFYhl8h9bYpTlnjsaNVFk4lYeIPD82sux3BHv7us5KVM2EaA?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdlBuwi6FcYynAKfOJm201rtI1yw8Yf4SaKNmx21VzNF1oVRnUY1yGjMMYmOCe8rwTh50NlOZwWhl2sM-EqcLV8hqs31AODf81nqT8cs6Gf4DLmi4hTKwGLNuf9hlcWDBFn1XVaxQQ69jTMfP4Blj3xpQ?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXearOz6dqjkgPr9TQNYJG8p4Kuj6ZIRE7IYT3EuGpNV_g52K4WbN0u-46ry4_wzVDx4FVINn4SpNIBMHzmyJMPAW2oyF0fhlSjbm16uLguPzeaA8nTpjY6aqN7bsB17BGsLP4CZoFmwmCGLnwTp_d3vOnE?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXeTD1OU6gavM9PxQKgrK6h960Fs4wSrKN7OhaXJdA9ETDCmGhBiXtI57bczEGb3AGWpscGQNbx8-703OpyAdq5wEzgrTItZswJjmUKfqg_MdwkxNMqu90ai1s0iRVNomlImUsLlgSdyNzuUSFZ-oXzvfPs?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdCsqGKVYm0ZnV2a7GuVddFWgtW9uQ2Hq9QGrskKr22mJgFkq83NmJ7M8bT4_tmGRcyXhj7s-ANVvcCQx1TdRNNXUqGyog4Nw1n8FJchx4PAqrodWRydX7qyCvZpO48P7HP7C00l8CekeT4VNZYQwPtHw?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXf42MSS9pJVLBWGtIbPA0OV6fN_ud2-usINdzBQe-rlWmJmN2TfJB3_BMWnnC5nvUltR_P6bWu1oWqrMcXmtY8qjuMwlHZpzMVr4F2ma4ywCQgTBCRU8X7XGPvwwpIbwVwFZgJqfJP-A76KMrH5uRm88Q?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXe8lgh6joByKGnpfu8p-6GSHAaq_BQsR3SY0QVnh9fe5TuyzLsOEu-HtZEkLR53LnTJiarDPpYM1E-PmEqe-aSODK0-BcAUzKQesP1UFz_L_kOxd__g-IjNP6m31hkteVFlsuq1VDtGiHo5asuevWcsCg?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdzepapvXyDqIQMhvec4BOOFIG0OZqjwP6dOo3P4gw_S-aoxbOkgQMVoeyasY8eVI8mO8gu7IFsRJPgTha6D0m3cMfGxeRehOav0eLSaf6HN5hpNGjxTvuT_HIEPeo8kOocKJJ9VnAN7ZCzM6tAIAeSHw?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXffy4_QIFlOMHOX2dGCZsjAt7AJW1xXLJsvRHu8RqoicjqSw5Na7RKOMq7tScNOT3mFvqKgQ0ZUnCAfErXT2ZEm6Z9z8TcxRojkmneM-Pts8KH9T6jzehr13LifMXf_Al0kDq0oPOoZJorWlCDCX-flEQ?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXfKzn8ZcKvAYpbMoZct5b5W6pk0ihJwOZFxFzAoL4LUsC-3ahg1gm9Ws51dsCTfkVUBNdf6UPysDiTG6HI_zIgknmEn4PwamAuFnKDtjn7tF9L-Rl8_UzkYOvM0zYDVjNckKkd6vXpiQerv7o7tA7aoAQ?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXf9RHMH8pKaVdaKF1cscCDXr17i4mT2CctvMq6KF5uHiVFo_taUqjTzkZQN9dkstwgtLbw1PXtAwQJilVL-Kux3F99ZLiOxcuXXafnxr3cUKaUcDhf63h6c_F8IF_06UE-qbSmbVop2Wqw5dvKPUov0-A?key=v8hB7lxe1rfGQzKMjVjZBg\"){kind=spacer}
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdvHvwWnw7wese9OISV8mViPGC9hDEEwuepFk5ba_8jg13VrJn4BE45bKPRIzq3Rf-PU0KAIlgbkN2hMV9mQ1H1cZXBN1Kf-E5JvSxDTZefgIUe5B9X4Iip3rANf7MpFPFvaDekYNWTzM4VK74HBcZVYA0?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdSzp02id-EVgJBCYhCrhoY_vPKziNrpAfN7hcW4dhpTWJ3QkM-IiKFquBr4rzolRiI-n0b_V0KuFvR3Si9-OwUDoQgmN9RpUqGvOpHSyoWuN9fHM5MbP59Vv1mR_nq7c-b88aL_t_8WsGSrWizKQ_1Vg?key=v8hB7lxe1rfGQzKMjVjZBg\")
\n\nOpenTable OAuth 2.0 Authorization Documentation
\nOpenTable utilizes OAuth 2.0 for authorizing access to protected resources. The authorization process involves the following steps:
\n- \n
Request client ID and secret.
\n \nObtain an access token using the issued client credentials.
\n \nUse the access token to access protected resources.
\n \n
Obtaining an Access Token
\nEnvironment and OAuth Base URL
\n- \n
Pre-production:
\nhttps://oauth-pp.opentable.com\nProduction:
\nhttps://oauth.opentable.com\n
Clients can obtain an access token using the OAuth 2.0 client credentials flow.
\nAccess Token URI
\n- \n
- URI:
{{base-url}}/api/v2/oauth/token?grant_type=client_credentials\n
Request Parameters
\n- \n
- grant_type: OAuth grant type. Should be
client_credentials\n
Submitting Client Credentials
\nClient credentials are submitted in the Authorization header as defined in the OAuth specification. Follow these steps:
\n- \n
Concatenate client ID and client secret using a “:” and base64 encode the result.
\n \nSet the header
\nAuthorization: Basic\n
Note: For OAuth token POST requests, include the Content-Length header even when the request body is empty. Set Content-Length to 0. No update is required for GET requests for OAuth tokens.
\nAuthorizing Tokens
\nObtain an Access Token
\n- \n
- Set the header
Authorization: Basic\n
Send the Request
\n- \n
If the token is valid and not expired, the resource server will return an appropriate response.
\n \nIf the token is not valid, the resource server responds with the appropriate HTTP status code (e.g., 400, 401, 403, or 405) and an error code.
\n \n
Token Renewal
\nToken expiry is included in the response. To get a new token, follow the process of Submitting Client Credentials to obtain a new one.
\nResponses
\n- \n
If the access token is present and valid, the resource server will return an appropriate response.
\n \nIf the access token is missing, HTTP 400 Bad Request is returned.
\n \nIf the access token is invalid or expired, HTTP 401 Unauthorized is returned.
\n \n
Overview
\nThis documentation outlines the process for using the Availability Search API to retrieve reservation times and metadata for one restaurant.
\nEndpoint
\nURL: {{base-url}}/v2/availability-metadata/{{rid}}
HTTP Method: GET
\nPath Parameter
\nQuery Parameters
\nThe API does not use query parameters for this endpoint.
\nResponse Elements
\nThe API response includes the following elements:
\nData
\nThe data object includes:
Dining Areas
\nEach dining area object includes:
\n","urlObject":{"path":["v2","availability-metadata","{{rid}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"7de5f298-04c0-4a31-bc2c-5557100604c3","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"token","type":"text","disabled":true}],"url":"{{base-url}}/v2/availability-metadata/{{rid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"8f49d723-7db4-4c2d-aa61-a58a84727ed1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"16"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/v2/availability-metadata/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Wed, 05 Feb 2025 19:48:50 GMT"},{"key":"Content-Length","value":"205"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"enviroments\": [\n \"Outdoor\",\n \"Indoor\"\n ],\n \"attributes\": [\n \"bar\",\n \"counter\",\n \"highTop\",\n \"default\"\n ],\n \"dining_areas\": [\n {\n \"id\": 1,\n \"name\": \"Other\",\n \"description\": \"Other\"\n },\n {\n \"id\": 2439,\n \"name\": \"Garden\",\n \"description\": \"Garden\",\n \"environment\": \"Outdoor\"\n },\n {\n \"id\": 2632,\n \"name\": \"VIP Lounge\",\n \"description\": \"Ultra VIP lounge\",\n \"environment\": \"Indoor\"\n }\n ]\n }\n}"}],"_postman_id":"cc623732-2316-454f-873e-0d93e4ea9833"}],"id":"f8f4b821-e4d8-4494-9a57-50990e853094","description":"Search APIs
\nIntroduction
\nThe Single Search API provides developers with a streamlined way to retrieve restaurant reservation availability using OpenTable's platform. This API enables partners to perform highly customizable searches based on parameters such as date, time, party size, table type, and more. By leveraging this endpoint, developers can enhance user experiences by seamlessly integrating availability searches into their applications.
\nOverview
\nThe Single Search API allows you to:
\n- \n
Search for available reservations at a specific restaurant.
\n \nCustomize searches with parameters like date, time range, party size, and table type.
\n \nRetrieve detailed availability, including dining area information and cancellation policies.
\n \nInclude special options like experiences and credit-card-secured reservation times.
\n \n
API Documentation for Availability Search API
\nOverview
\nThis documentation outlines the process for using the Availability Search API to retrieve reservation times for one restaurant. It includes the endpoint details, parameters, and examples of requests and responses.
\nEndpoint
\nSingle Search URL: {{base-url}}/v2/availability/{{rid}}
Method: GET
\nPath Parameters
\nQuery Parameters
\nThe API supports the following query parameters to customize the search:
\nResponse Elements
\nThe API response includes the following elements:
\nTimes Available
\nEach time slot includes:
\nAvailability Types
\nEach availability type provides:
\nCancellation Policy
\nDetails about reservation cancellation policies include:
\nDining Area Attributes
\nDining area details include:
\nExperience Cancellation Policies
\nDetails about reservation cancellation policies include:
\nCommon Errors
\n","_postman_id":"f8f4b821-e4d8-4494-9a57-50990e853094"},{"name":"Experiences","item":[{"name":"Get Active Experiences V2","id":"790cbb98-1599-4fe6-b427-defe5a697d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"application/json;charset=UTF-8"},{"key":"Accept-Language","value":"en-US"}],"url":"{{base-url}}/v2/experiences/{{rid}}/active","description":"Overview
\nThis documentation provides details on the Experiences API for retrieving detailed information about various experiences offered by a restaurant.
\n\n
Experiences API
\nEndpoint
\nURL: {{base-url}}/v2/experiences/{{rid}}/active
HTTP Method: GET
\nPath Parameters
\nKey Features
\n- \n
Experience Details: Name, description, type, and ID of the experience.
\n \nAdd-Ons: Optional items or services, such as wine upgrades or truffle additions.
\n \nPricing Information: Includes price per person and additional charges like gratuity.
\n \nService Charges: Information about mandatory fees associated with the experience.
\n \n
Response Schema
\nExperience Data
\nRoot Response Body
\nObject: data
\nAdd-Ons Object (add_ons)
\nAdd-Ons Group Object (add_ons.groups[]
\nAdd-on Item Object (add_ons.groups[].items[])
\nPrice Per Item Object (price_per_item)
\nService Charge Object (service_charges[])
\nAdd-ons Summary Object (add_ons_summary)
\nPrice Info Object (price_info)
\nGratuity Object (price_info.gratuity)
\nPolicy Information Object (policyInformation)
\nPolicy ID Object (*Policy.id)
\nUsed by cancellationPolicy, bookingPolicy, and tncPolicy.
\n","urlObject":{"path":["v2","experiences","{{rid}}","active"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"8ab5807e-905f-4ea0-a5b9-9a85371ef569","name":"200","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json;charset=UTF-8"},{"key":"Accept-Language","value":"en-US"}],"url":"{{base-url}}/v2/experiences/{{rid}}/active"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"8ca5bd2c-69fc-4dcc-9918-f4b63c0bb96b"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Accept-Language","value":"en-US"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-envoy-upstream-service-time","value":"50"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/experiences/active/v2/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 19:45:14 GMT"},{"key":"Content-Length","value":"563"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"add_ons\": {\n \"groups\": [\n {\n \"description\": \"Experience Add-ons\",\n \"items\": [\n {\n \"description\": \"test\",\n \"id\": \"198a5320-78f8-4f52-9f02-dde5c66c7b46\",\n \"max_per_reservation\": 20,\n \"name\": \"Test addon\",\n \"price_per_item\": {\n \"currency_code\": \"USD\",\n \"min_unit_amount\": 100,\n \"multiplier\": 100,\n \"service_charges\": [\n {\n \"serviceChargeId\": 1,\n \"label\": \"Additional fees\",\n \"numerator\": 200,\n \"denominator\": 10000,\n \"mandatory\": true,\n \"taxable\": true,\n \"description\": \"Cleaning\"\n }\n ]\n }\n }\n ],\n \"name\": \"Experience Add-ons\"\n }\n ],\n \"max_per_reservation\": 0\n },\n \"add_ons_summary\": {\n \"available\": \"OPTIONAL\",\n \"count\": 5\n },\n \"bookable\": true,\n \"currency\": \"USD\",\n \"description\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.\",\n \"experience_id\": 508501,\n \"name\": \"Aasma 1 (per person) - add ons service fee\",\n \"rid\": 152416,\n \"type\": \"Special menu\",\n \"type_enum\": \"PRIX_FIXE\",\n \"type_id\": 2,\n \"version\": 3,\n \"price_info\": {\n \"priceType\": \"PER_PERSON\",\n \"prePaymentRequired\": true,\n \"currencyCode\": \"USD\",\n \"multiplier\": 100,\n \"gratuity\": {\n \"label\": \"Gratuity\",\n \"numerator\": 100,\n \"denominator\": 10000,\n \"mandatory\": true,\n \"taxable\": true\n },\n \"prices\": [\n {\n \"priceId\": 117333,\n \"priceTitle\": \"Chefs special\",\n \"priceDescription\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry\",\n \"priceOrder\": 1,\n \"minUnitAmount\": 1000,\n \"priceAllInclusive\": false\n },\n {\n \"priceId\": 117334,\n \"priceTitle\": \"Everyday menu\",\n \"priceDescription\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It h\",\n \"priceOrder\": 2,\n \"minUnitAmount\": 1000,\n \"priceAllInclusive\": false\n },\n {\n \"priceId\": 117335,\n \"priceTitle\": \"Bakery menu\",\n \"priceDescription\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry\",\n \"priceOrder\": 3,\n \"minUnitAmount\": 1000,\n \"priceAllInclusive\": false\n },\n {\n \"priceId\": 117336,\n \"priceTitle\": \"Vegan menu\",\n \"priceOrder\": 4,\n \"minUnitAmount\": 5000,\n \"priceAllInclusive\": true\n },\n {\n \"priceId\": 117337,\n \"priceTitle\": \"Salads only\",\n \"priceDescription\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry\",\n \"priceOrder\": 5,\n \"minUnitAmount\": 200,\n \"priceAllInclusive\": true\n }\n ]\n }\n }\n ]\n}"},{"id":"04f4402b-9b98-4cbe-b2da-19ac48ab4417","name":"200 - No available Experiences","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json;charset=UTF-8"},{"key":"Accept-Language","value":"en-US"}],"url":"{{base-url}}/v2/experiences/{{rid}}/active"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"995948c8-4400-484f-b81a-13e049a4fef4"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Accept-Language","value":"en-US"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-envoy-upstream-service-time","value":"73"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/experiences/active/v2/{rid}"},{"key":"Content-Length","value":"11"},{"key":"Date","value":"Mon, 23 Dec 2024 19:17:10 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": []\n}"},{"id":"d15e153b-4cce-4a6f-9989-31d2467b980e","name":"403","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json;charset=UTF-8"},{"key":"Accept-Language","value":"en-US"}],"url":"{{base-url}}/v2/experiences/{{rid}}/active"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"e478b350-3138-4411-9fb3-c6e2bb314065"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Accept-Language","value":"en-US"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"14"},{"key":"Content-Length","value":"95"},{"key":"Date","value":"Mon, 23 Dec 2024 19:18:16 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Permission denied\"\n }\n ],\n \"requestid\": \"e478b350-3138-4411-9fb3-c6e2bb314065\"\n}"}],"_postman_id":"790cbb98-1599-4fe6-b427-defe5a697d93"},{"name":"Experience Total Calculation","id":"8674d747-1e77-4c21-9112-7bc478716c90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"application/json;charset=UTF-8"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"experience_id\": 511659,\r\n \"version\": 2,\r\n \"party_size\": 4,\r\n \"tip_percent_list\": [\r\n 10\r\n ],\r\n \"add_ons\": [\r\n {\r\n \"item_id\": \"3de22255-8af7-42dd-aade-e6b4cfc767d7\",\r\n \"quantity\": 2\r\n }\r\n ],\r\n \"party_size_per_price_type\": [\r\n {\r\n \"id\": 121058,\r\n \"count\": 1\r\n },\r\n {\r\n \"id\": 121059,\r\n \"count\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v2/booking/{{rid}}/reservations/experiences/total","description":"
Experience Total API
\nOverview
\nThe Experience Total API allows you to calculate and retrieve detailed cost information for restaurant booking experiences. This includes costs for add-ons, tips, service fees, and taxes. It supports specifying details such as party size, experience version, and price breakdowns for comprehensive booking insights.
\n\n
Endpoint
\nURL: {{base-url}}/v2/booking/{{RID}}/reservations/experiences/total
Method: POST
\n\n
Path Parameters
\n\n
Request Body
\n\n
Add-Ons Array
\n\n
Party Size Per Price Type Array
\n\n
Totals Array
\n\n
Subtotals Per Price Type Array
\n\n
Taxes Array
\n\n
Tax Subtotals Per Price Type Array
\n\n
Response
\nMain Response Fields
\n\n
Add-Ons Array
\n\n
Service Fees Array
\n\n
Taxes Array
\n\n
Tax Subtotals Per Price Type Array
\n\n
Totals Array
\n\n
Subtotals Per Price Type Array
\n","urlObject":{"path":["v2","booking","{{rid}}","reservations","experiences","total"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"5f8bb0d2-b9cd-4337-a531-8801b07cf50c","name":"200","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json;charset=UTF-8"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"experience_id\": 512011,\r\n \"version\": 2,\r\n \"party_size\": 4,\r\n \"tip_percent_list\": [],\r\n \"party_size_per_price_type\": [\r\n {\r\n \"id\": 121439,\r\n \"count\": 2\r\n },\r\n {\r\n \"id\": 121440,\r\n \"count\": 2\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v2/booking/{{rid}}/reservations/experiences/total"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"9e0fcc10-e813-4454-bd84-6738a9d67c96"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-envoy-upstream-service-time","value":"119"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/booking/reservations/{rid}/experiences/v3/total"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 19:54:40 GMT"},{"key":"Content-Length","value":"614"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 512011,\n \"version\": 2,\n \"add_ons\": [],\n \"currency\": \"USD\",\n \"currency_denominator\": 100,\n \"totals\": [\n {\n \"tip_amount\": 2500,\n \"tip_percent\": 10,\n \"tip_amount_with_taxes\": 2500,\n \"service_fee_amount\": 2500,\n \"add_on_subtotal_amount_with_taxes\": 0,\n \"add_on_subtotal\": 0,\n \"item_subtotal_amount\": 25000,\n \"taxes_on_tip_amount\": 0,\n \"taxes_on_service_fees_amount\": 250,\n \"taxes_amount\": 2750,\n \"total_amount\": 32750,\n \"taxes_on_item_amount\": 2500,\n \"taxes_on_add_ons_amount\": 0,\n \"item_subtotal_amount_without_taxes\": 25000,\n \"is_tip_mandatory\": true,\n \"subtotals_per_price_type\": [\n {\n \"id\": 121439,\n \"count\": 2,\n \"price\": 10000,\n \"subtotal\": 20000,\n \"price_all_inclusive\": false,\n \"subtotal_with_tax_and_fees\": 24200\n },\n {\n \"id\": 121440,\n \"count\": 2,\n \"price\": 2500,\n \"subtotal\": 5000,\n \"price_all_inclusive\": false,\n \"subtotal_with_tax_and_fees\": 6050\n }\n ],\n \"taxes\": [\n {\n \"tax_id\": 0,\n \"tax_percent\": 0,\n \"tax_on_item_amount\": 2500,\n \"tax_on_tip_amount\": 0,\n \"tax_on_service_fees_amount\": 250,\n \"tax_subtotals_per_price_type\": [\n {\n \"id\": 121439,\n \"tax_percent\": 10,\n \"tax_on_item_amount\": 2000,\n \"tax_on_service_fees_amount\": 200,\n \"tax_on_service_fees\": [\n {\n \"service_fee_id\": 1,\n \"tax_amount\": 200\n }\n ],\n \"tax_subtotal\": 2200,\n \"tax_id\": 1,\n \"label\": \"Tax\"\n },\n {\n \"id\": 121440,\n \"tax_percent\": 10,\n \"tax_on_item_amount\": 500,\n \"tax_on_service_fees_amount\": 50,\n \"tax_on_service_fees\": [\n {\n \"service_fee_id\": 1,\n \"tax_amount\": 50\n }\n ],\n \"tax_subtotal\": 550,\n \"tax_id\": 1,\n \"label\": \"Tax\"\n }\n ],\n \"tax_subtotal\": 2750,\n \"tax_total\": 3000\n }\n ]\n }\n ],\n \"has_mandatory_tip\": true,\n \"is_tip_taxable\": false,\n \"prices\": [\n {\n \"id\": 121439,\n \"title\": \"Adult price\",\n \"description\": \"Adult price\",\n \"price\": 10000,\n \"price_all_inclusive\": false,\n \"price_order\": 1\n },\n {\n \"id\": 121440,\n \"title\": \"Child price\",\n \"description\": \"Child price\",\n \"price\": 2500,\n \"price_all_inclusive\": false,\n \"price_order\": 2\n }\n ],\n \"restaurant_id\": 188878,\n \"booking_type\": \"Table\",\n \"ticketed\": false,\n \"service_fees\": [\n {\n \"label\": \"Service charge\",\n \"fee_percent\": 0,\n \"fee_amount\": 2500,\n \"taxable\": true,\n \"service_fee_subtotals_per_price_type\": [\n {\n \"fee_percent\": 10,\n \"fee_amount\": 2000,\n \"label\": \"Service charge\",\n \"description\": \"Event fee\",\n \"mandatory\": true,\n \"taxable\": true\n },\n {\n \"fee_percent\": 10,\n \"fee_amount\": 500,\n \"label\": \"Service charge\",\n \"description\": \"Event fee\",\n \"mandatory\": true,\n \"taxable\": true\n }\n ],\n \"fee_amount_for_add_ons\": 0,\n \"fee_amount_without_add_ons\": 2500\n }\n ]\n}"}],"_postman_id":"8674d747-1e77-4c21-9112-7bc478716c90"}],"id":"ae4b2e47-6c90-48c4-8f0e-136049b1886d","description":"Description
\nOVERVIEW
\nExperiences allow restaurants to use their availability for special events. From happy hour to winery tours, $1 oysters to exquisite 12-course tasting menus and more. When restaurants offer Experiences on OpenTable, the Consumer API v2 will allow you to book, confirm and even collect deposits.
\nAvailability for the experiences are real-time and reservations are confirmed in the system once the reservation is completed. You can choose to show only standard availability or also include experiences by using the include_experiences quey parameter.
HOW WILL THIS IMPACT RESTAURANTS?
\nWhile these APIs are optional, restaurants that offer experiences will have inventory dedicated to the experiences. Here is how it looks on OpenTable.com for a restaurant with an experience and standard availability.
\nOverview
\nThe Slot Lock API provides the ability to create, manage, and retrieve reservations for a restaurant. This documentation outlines the payload structure, attributes, and their descriptions, along with sample requests and responses for seamless integration.
\n\n
Request Details
\nEndpoint
\nURL: {{base-url}}/v2/booking/{{rid}}/slot_locks
Method: POST
\nHeaders
\n\n
Request Body
\nAttributes
\nExperience Object Attributes
\nNote: This Data will be gathered from the GET Experiences API response. All attributes are required when booking an experience.
\nParty_Size_Per_Price_Type Array Object Attributes
\nNote: This Data will be gathered from the GET Experiences API response. Optional, applicable only if returned in GET Experiences API
\nAdd_Ons Array Object Attributes
\nNote: This Data will be gathered from the GET Experiences API response. Optional, applicable only if returned in GET Experiences API
\n\n
\n
Notes
\n- \n
- Ensure the
restaurant_id,party_size,date_time, andexperienceattributes are accurate for successful reservation creation. \n
Response
\nNotes
\n- \n
The
\nexpires_attimestamp indicates when the slot lock expires. Ensure the reservation is completed before this time. \nThe
\nreservation_tokenis required for the reservation creation request and ensures the slot remains locked during the reservation process. \nIf the
\nexpires_attime is reached without completing the reservation, the slot will be released. \nTokens should be treated securely and not exposed to unauthorized users.
\n \n
Delete Slot Lock API Documentation
\nOverview
\nThe Delete Slot Lock API allows external partners to remove a reservation lock (slot lock) for a specific availability at a restaurant. By unlocking the slot, it becomes available for other customers to book.
\n\n
Endpoint
\nURL: {{base-url}}/v2/booking/{{rid}}/slot_locks/{{reservation_token}}
Method: DELETE
\n\n
Request Details
\nPath Parameters
\nQuery Parameters
\nThe API does not use query parameters for this endpoint.
\n\n
Response Details
\nError Responses
\n\n
\n
Notes
\n- \n
Ensure the
\nreservation_tokenandridare accurate to avoid errors. \nThe reservation token is provided by the booking API when a slot is locked.
\n \n
Description
\nOVERVIEW
\nSlot Locks allow for the inventory that has been chosen by the booker to be locked for a total of 5 minutes. This allows that no other user can book the reservation while the initial booker completes their transaction. If a booking is attempted after the slot lock expiry, the booking can be re-tried, but availability is not guareenteed.
\nAvailability has already been verifies via the APIs, this step will block the availability for the diner and allow for booking.
\nIt is important to delete unused slot locks as it may block other bookers from accessing availability during the slot lock window.
\nThe five minute window is hard coded and cannot be edited.
\nHOW WILL THIS IMPACT RESTAURANTS?
\nRestaurant availability will be blocked for that specific user for the allotment of the slot lock window.
\nEndpoint
\nURL: {{base-url}}/v2/booking/{{rid}}/reservations
Method: POST
\nThis endpoint creates a new reservation for a restaurant. It expects a JSON payload containing all the required information for the reservation.
\n\n
Request Body
\nThe request payload consists of the following fields:
\n\n
Phone Object
\n\n
Credit Card Object
\n\n
Experience Object
\n\n
Party Size Per Price Type Object
\n\n
Add-Ons Object
\n\n
Response
\nUpon successful creation of a reservation, the API returns the reservation details along with a unique reservation ID and confirmation details.
\nResponse Attributes
\nNotes
\n- \n
The
\nmessageprovides important booking policy information such as grace periods and contact instructions. \nThe
\nmanage_reservation_urlcan be shared with guests to modify or cancel the reservation if needed. \nThe
\nconfirmation_numberandoffer_confirmation_numberserve as unique identifiers for tracking purposes. \nEnsure the provided
\ndate_timeandparty_sizealign with the guest’s booking details. \n
Common Errors
\n","urlObject":{"path":["v2","booking","{{rid}}","reservations"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"9d2414cf-fd2e-457f-b322-7d1e9a0a5424","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer "}],"body":{"mode":"raw","raw":"{\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI2MTc3MzgxNDJ8MnwyMDI1LTEwLTEzVDE2OjAwfDEwMzgwMDcifQ.6uVQiE9gzI8nRxIP0qUjP2o__5pwV7DwYeW_0-VPq8oJUvltg-HIj8iel3acYzWeKZuQqLHNiBQ3VlSVeONYGQ\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email_address\": \"JaneDoe@mailanator.com\",\n \"phone\": {\n \"number\": \"4155555555\",\n \"country_code\": \"US\",\n \"phone_type\": \"mobile\"\n },\n \"reservation_attribute\": \"default\",\n \"special_request\": \"This is my special request\",\n \"credit_card\": {\n \"token\": \"tok_0SDBnhjrulGLaJAMRTatEB0N\",\n \"last4\": \"4242\"\n },\n \"restaurant_email_marketing_opt_in\": \"true\",\n \"dining_area_id\": \"2632\",\n \"environment\": \"Indoor\",\n \"experience\": {\n \"id\": 512031,\n \"version\": 1,\n \"party_size_per_price_type\": [\n {\n \"id\": 121058,\n \"count\": 1\n },\n {\n \"id\": 121059,\n \"count\": 1\n }\n ],\n \"add_ons\": [\n {\n \"item_id\": \"4cb68e46-39be-4110-b345-884bf57635bd\",\n \"quantity\": 2\n }\n ]\n }\n}"},"url":"{{base-url}}/v2/booking/{{rid}}/reservations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"1a84a330-5edd-4d4f-b47d-306f93d7c23a"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Location","value":"/booking/reservations/1038007-1751"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-envoy-upstream-service-time","value":"1364"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/booking/reservations"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 06 Jan 2025 21:21:08 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"We have a 5 minute grace period. Please call us if you are running later than 5 minutes after your reservation time.We may contact you about this reservation, so please ensure your email and phone number are up to date.
Your table will be reserved for 1 hour 30 minutes for parties of up to 2; 2 hours for parties of up to 4; 2 hours 30 minutes for parties of up to 6; and 3 hours for parties of 7+.\",\n \"confirmation_number\": 1751,\n \"offer_confirmation_number\": 0,\n \"date_time\": \"2025-10-13T16:00\",\n \"party_size\": 2,\n \"notes\": \"This is my special request\",\n \"manage_reservation_url\": \"https://www.opentable.com/book/view?rid=1038007&confnumber=1751&token=01EMM9tRYsZ5LWf59HhG_iCHIzHSs1Spu-9JvrwKx0nzI1\"\n}"}],"_postman_id":"2b0d2fc2-9732-44f4-adea-7d8b902a23df"}],"id":"b1c1ac75-7821-4263-b3d3-e1c5c2ff4fca","description":"
Description
\nOVERVIEW
\nThis will book and confirm the reservation. It confirms the slot lock and must be made within 5 minutes of slot lock (expires_at slot lock parameter).
\nRequirements
\n- \n
Request body must be encoded in UTF-8 format. StringEntity encodes as ISO-8859-1 as default if you do not specify the encoding format. ISO-8859-1 is not the supported format for JSON.
\n \nResponses are compressed using gzip and added a “Content-Encoding: gzip” header in the response to indicate that the response body has been compressed. Supporting “Content-Encoding” allows servers to compress responses, saving bandwidth. This will improve performance, especially on slower networks. Modern web browsers and HTTP clients all support common compression formats like gzip and deflate.
\n \nOptional request header \"Accept-Language: [Locale]\" (default is en-US) for email communications sent in alternate language & locale.
\n \n
References:
\n- \n
- \n \n
Wikipedia | https://en.wikipedia.org/wiki/JSON “JSON exchange in an open ecosystem must be encoded in UTF-8”
\n \n
Supported Accept Language values:
\nHOW WILL THIS IMPACT RESTAURANTS?
\nWith this API, restaurants can receive online reservations via the API. Reservations will automatically show in the reservation list and any applicable deposit, experience or booking policy can also be referenced.
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdNDcfuwJFiKhVKNa-L2qMQ2Nw2YamVAn-sL6VXqZZMXzRwNgjehY2vnaQImY-GG9jHR05qKX7bpdeF55wZYI1REP9nwPUiCq02we2WDM_7cxUnpf8NJSbbgUuG5j10IM5IiWp8?key=1sc8NXY0brb4x8F-_CIwjKFb\")
\n\nCredit Card Processing
\nAs part of the Make Reservation request, the below process can be followed to vault a credit card with Stripe, our partner used for all credit card related transactions.
\nAdditional Credit_Card Request Body Fields (added to the make reservation request)
\nStripe API details and tokenization
\nIn order to generate the required credit_card parameters for the make reservation request, you will need to use the process detailed by Stripe in their API documentation, https://stripe.com/docs/api/tokens/create_card, to generate the Stripe token “id” and “last4”. We have included the basic requirements, however these are subject to change, are not inclusive of what is supported, and are not supported directly by OpenTable. Please review the Stripe documentation for further details and information.
\nAs part of the Stripe API call, you will set the content-type as x-www-form-urlencoded and the authorization is the bearer token provided by OpenTable. For this you will need the OpenTable Stripe Publishable Key. Please contact the API team at OpenTable and they will securely supply the pre-production and production Stripe keys.
\nSample Request Body \ncurl -X POST \n'[https://platform.otqa.com/booking/reservations'](https://platform.otqa.com/booking/reservations') \n\\-H 'authorization: Bearer \\[Access Token\\]' \n\\-H 'cache-control: no-cache' \n\\-H 'content-type: application/json' \n\\-d ' \nSample Response: 200 OK \n{ \n\"restaurant_id\": 334879, \n\"reservation_token\": \"\\[Reservation Token from Lock\\]\", \n\"first_name\": \"John\", \n\"last_name\": \"Smith\", \n\"email_address\": \"[john.smith@sample-email.com](https://mailto:john.smith@sample-email.com)\", \n\"phone\": { \n\"number\": \"4153444200\", \n\"country_code\": \"US\", \n\"phone_type\": \"Mobile\" \n}, \n\"reservation_attribute\": \"outdoor\", \n\"special_request\": \"Please seat us at a round table.\", \n\"credit_card\": { \n\"token\": \"tok_XXXXXXXXX\", \n\"last4\": \"4242\" \n}, \n\"restaurant_email_marketing_opt_in\": false, \n\"is_third_party\": false \n}\n\nThe Stripe Request will generate a response with many details, however for OpenTable booking purposes, only “id” and “last4” are required for the basic make reservation request. Refer to the Stripe documentation with any other questions around the full response payload.
\nStripe and SCA (Strong Customer Authentication)
In some instances, when a credit card is tokenized and vaulted with Stripe, there is an additional authentication step required from the diner, known as Strong Customer Authentication, or SCA. To read more about Stripe and SCA, you can view their documentation here, https://stripe.com/docs/strong-customer-authentication.
In instances of required SCA, when the partner submits the make reservation request, if Stripe responds to the OpenTable credit card vaulting that SCA is needed, OpenTable will return a 424 Failed Dependency error message (example provided). When SCA is required, the partner must present a UI element to the diner to approve the credit card transaction (see below Stripe APIs).
\nOpenTable Requirements for SCA verification for credit card holds
In the 424 Failed Dependency error response, OpenTable will return the following pieces of information. You will need to store this for your follow-up API calls to Stripe and your new make reservation request to OpenTable.
Once you present the UI element for the diner to approve the transaction, call the Stripe APIs (below), Stripe will return the setup_intent. You will use this in the follow-up modified make reservation request to OpenTable.
\nOpenTable response for SCA Required 424 error for credit card holds:\n{\n \"errors\": [\n {\n \"message\": \"CreditCardTokenSCARequired\",\n \"details\": {\n \"stripeToken\": \"tok_Fp8cLrD3NSkDRz\",\n \"clientSecret\": \"seti_1FJULqCpqyzgzbXS1NOKWBib_secret_Fp8dlPMpxYWak99cjjth3UM0GKvFPWU\",\n \"paymentMethod\": \"pm_1FJULqCpqyzgzbXSWawUCC4n\",\n \"connectedAccountPk\": \"pk_test_GvfiPXSbQ3eo6R4eKo8NL5Pk00qeYMWQuz\"\n }\n }\n ],\n \"requestid\": \"3c2e3a10-38a6-40d8-bffe-71ede613b3a9\"\n }\n\nOpenTable Make Reservation SCA parameters for credit card holds
\nAfter allowing the diner to accept the credit card transaction and completing the Stripe SCA APIs, using the original stripe token, with the last4, and the paymentMethod returned from the 424 Failed Dependency error message, you will use the setupIntent from the SCA response and add those to the make reservation body (in the same method as you added the original credit_card body).
\nStripe APIs to use for SCA verification
\nThe below are Stripe resources used to call Stripe and get back the requirements to submit back to OpenTable for the make reservation request.
\n- \n
Stripe JavaScript API | https://stripe.com/docs/js/setup_intents/confirm_card_setup
\n \nStripe iOS SDK | https://stripe.dev/stripe-ios/docs/index.html
\n \n
OpenTable Requirements for SCA verification for prepaid experiences
\nIn the 424 Failed Dependency error response, OpenTable will return the following pieces of information. You will need to store this for your follow-up API calls to Stripe and your new make reservation request to OpenTable.
\nOnce you present the UI element for the diner to approve the transacation, call the Stripe APIs (below), Stripe will return the payment_intent. You will use this in the follow-up modified make reservation request to OpenTable.
\nOpenTable response for SCA Required 424 error for prepaid experiences:\n{\n \"errors\": [\n {\n \"message\": \"CreditCardTokenSCARequired - SCAForPayment\",\n \"details\": {\n \"stripeToken\": \"tok_0Mf90jjrulGLaJAMMKERcecp\",\n \"clientSecret\": \"pi_3Mf94PBf02EU9tgq0MEhjyCw_secret_LYhAPaXbcCphUGOQKgzjiMalN\",\n \"paymentMethod\": \"pm_1Mf94PBf02EU9tgqSbtMncPh\",\n \"connectedAccountPk\": \"pk_test_51HHB6EBf02EU9tgqyXTYwje0cm3NrKU1JaahO4DKBLoHt4jix8X80b57UfFzToCBjc4GRXWiKjdFsYTrQNgLC3oS007wF7q7GZ\"\n }\n }\n ],\n \"requestid\": \"ec416096-cf30-42ce-a517-9d67fb526a23\"\n }\n\nOpenTable Make Reservation SCA parameters for prepaid experiences
\nAfter allowing the diner to accept the credit card transaction and completing the Stripe SCA APIs, using the original stripe token, with the last4, and the paymentMethod returned from the 424 Failed Dependency error message, you will use the paymentIntent from the SCA response and add those to the make reservation body (in the same method as you added the original credit_card body).
\nStripe APIs to use for SCA verification for prepaid experiences
\nThe below are Stripe resources used to call Stripe and get back the requirements to submit back to OpenTable for the make reservation request.
\n- \n
Stripe JavaScript API | https://docs.stripe.com/js/payment_intents/confirm_card_payment
\n \nStripe iOS SDK | https://stripe.dev/stripe-ios/docs/index.html
\n \n
Booking Policies API Documentation
\nEndpoint
\n{{base-url}}/v2/booking-policies/{{rid}}/{YEAR-MONTH-DAY}/{TIME}/{PartySize}
Path Parameters
\n- \n
rid (restaurant id): A static identifier for each restaurant.
\n \ndate (YEAR-MONTH-DAY): Specifies the booking date. Example:
\n2024-12-01. \ntime (TIME): Specifies the time of the reservation. Must be in 15-minute intervals (
\n7:00,7:15,7:30,7:45). \nPartySize: Specifies the number of guests for the booking policy query.
\n \n
Query Parameters
\nResponse Elements
\nPolicies Attributes
\nLanguage Attributes
\n","urlObject":{"path":["v2","booking-policies","{{rid}}","{{date}}","{{time}}","{{partysize}}"],"host":["{{base-url}}"],"query":[{"key":"dinerContext","value":"details"}],"variable":[]}},"response":[{"id":"d86d3038-d571-4b54-814e-490422279a2d","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"bearer ","type":"text"}],"url":{"raw":"{{base-url}}/v2/booking-policies/{{rid}}/{{date}}/{{time}}/{{partysize}}?dinerContext=details","host":["{{base-url}}"],"path":["v2","booking-policies","{{rid}}","{{date}}","{{time}}","{{partysize}}"],"query":[{"key":"dinerContext","value":"details"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"72ea2a04-bb79-4f41-8eed-4d9669ded136"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"73"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/v1/booking-policies/{rid}/{date}/{time}/{partySize}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 20:21:52 GMT"},{"key":"Content-Length","value":"266"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Policies\": [\n {\n \"Message\": \"We have a 15 minute grace period. Please call us if you are running later than 15 minutes after your reservation time.Your table will be reserved for 1 hour 30 minutes for parties of up to 2; 2 hours for parties of up to 4; 2 hours 30 minutes for parties of up to 6; and 3 hours for parties of 7+.\",\n \"Type\": \"General\",\n \"Language\": {\n \"Code\": \"en\",\n \"Region\": \"US\",\n \"IETF\": \"en-US\"\n }\n }\n ]\n}"}],"_postman_id":"0290fb98-be7b-4789-8458-00bd2b8c8d0c"},{"name":"Cancellation Policies","id":"a2b91ea7-e2b8-4de1-b677-fe25f144a15c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"bearer ","type":"text"}],"url":"{{base-url}}/v2/cancellation-policies/{{rid}}/{{cancelationid}}","description":"
Cancellation Policies API Documentation
\nEndpoint
\nURL: {{base-url}}/v2/cancellation-policies/{rid}/{cancelationid}
Method: GET
\nDescription
\nThe cancellation policy endpoint allows you to retrieve the cancellation policy for a reservation based on the restaurant ID and cancellation ID. The cancelationid is obtained from the response of the GET Availability call.
Sample Request
\ncurl --location '{{base-url}}/v2/cancellation-policies/{rid}/{cancelationid}' \\\n--header 'Authorization: bearer '\n\nResponse
\n{\n \"partySize\": 5,\n \"policyType\": \"Deposit\",\n \"depositDetails\": {\n \"amount\": 1500,\n \"currency\": \"USD\",\n \"denominator\": 100,\n \"type\": \"PerGuest\"\n },\n \"cutOff\": {\n \"cutoffType\": \"DaysBefore\",\n \"daysBeforeCutoff\": 2\n }\n}\n\nResponse Attributes
\nNotes
\n- \n
Ensure you use a valid
\ncancelationidretrieved from the Make Reservation call. \nThe cutoff policy specifies the period within which cancellations are allowed.
\n \nThe deposit amount is specified in minor currency units (e.g., cents for USD).
\n \n
OVERVIEW
\nBooking Policies allow the restaurants to expose any specific details they would like the diner to know when they book the reservation.
\nThese details should be exposed when the diner is confirming the reservation so that they understand the terms of the reservations. These can be as simple as \"We offer valet parking...\" to \"Deposit of $50.00 will be collected if there is a no show\".
\nA few notes:
\n- \n
The custom details added by restaurants will have a maximum of 500 characters.
\n \nBooking and Cancellation Policies can vary by date and party size.
\n \nIf no policies are available, the APIs will return an empty response.
\n \n
Below is an example of how these details are exposed in OpenTable.com during the booking path.
\nModify Reservation API Documentation
\nEndpoint
\nURL:{{base-url}}/v2/booking/{{rid}}reservations/{id}
Method: PUT
- \n
The
\nidparameter is a unique combination of theRestaurant_IDandConfirmation_Numberprovided in the request URL, formatted as{rid}-{confirmation_number}. \nPrior Actions:
\n- \n
Perform a search request to verify availability for new time/date (Availability API)
\n \nProvision/lock request to lock the new desired time. (Slot Lock API)
\n \nIf a credit card is required for the new reservation, please refer to the Make Reservation Credit Card details (Credit Card Processing Details)
\n \n
\n
Request Body
\nThe request payload consists of the following fields:
\nReservation Details Table
\nCredit Card Object
\n\n
Experience Object
\n\n
Party Size Per Price Type Object
\n\n
Add-Ons Object
\n\n
Response
\nUpon successful creation of a reservation, the API returns the reservation details along with a unique reservation ID and confirmation details.
\nResponse Attributes
\nNotes
\n- \n
Default Behavior: If the
\nreservation_attributeis not provided, the default seating will be used. \nExperience: The
\nexperienceobject supports modifying experiences and add-ons for enhanced booking flexibility. \n
We may contact you about this reservation, so please ensure your email and phone number are up to date.
Your table will be reserved for 1 hour 30 minutes for parties of up to 2; 2 hours for parties of up to 4; 2 hours 30 minutes for parties of up to 6; and 3 hours for parties of 7+.\",\n \"confirmation_number\": 1751,\n \"date_time\": \"2025-11-13T16:00\",\n \"party_size\": 2,\n \"notes\": \"Window Table\"\n}"},{"id":"0877d1c7-87c3-42cf-af93-cc01fd5b264a","name":"400","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer "}],"body":{"mode":"raw","raw":"{\n \"party_size\": 4,\n \"date_time\": \"2025-12-13T14:30\",\n \"reservation_attribute\": \"default\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI4MDkzMDU5NDV8NHwyMDIzLTA1LTEyVDE0OjMwfDEwMzgwMDcifQ.pb5zRsChKSDOk52Q3IX4hIsRxgi7uIweacsZpJObA6M5jzicMNKp2rIIlWAENce6i98336tPzVciv-anlAx_Ag\",\n \"special_request\": \"Window Table\",\n \"experience\": {\n \"id\": 512031,\n \"version\": 1,\n \"party_size_per_price_type\": [\n {\n \"id\": 121058,\n \"count\": 1\n },\n {\n \"id\": 121059,\n \"count\": 1\n }\n ],\n \"add_ons\": [\n {\n \"item_id\": \"4cb68e46-39be-4110-b345-884bf57635bd\",\n \"quantity\": 2\n }\n ]\n }\n}"},"url":"{{base-url}}/v2/booking/{{rid}}/reservations/{{rid}}-{{confirmation-id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"beac4f6e-fa1b-4a29-af7c-bb6ba6a8e6ca"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"127"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/booking/reservations/{reservationId}"},{"key":"Content-Length","value":"123"},{"key":"Date","value":"Mon, 06 Jan 2025 21:28:46 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"reservation_token or restaurant id is invalid\"\n }\n ],\n \"requestid\": \"beac4f6e-fa1b-4a29-af7c-bb6ba6a8e6ca\"\n}"}],"_postman_id":"0fc6793e-5f32-4b5e-a9d8-c598d53c326b"},{"name":"Cancel Web Reservation","id":"454b5367-6a17-46d6-ae4c-456f55ae688b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"CancelledWeb\"\n}"},"url":"{{base-url}}/v2/booking/{{rid}}/reservations/{{rid}}-{{confirmation-id}}","description":"
Cancel Reservation API Documentation
\nEndpoint
\nURL: {{base-url}}/v2/booking/{{rid}}reservations/{id}
Method: PUT
\nDescription
\nThe Cancel Reservation API allows users to cancel an existing reservation by providing the unique identifier for the reservation. No other status changes are supported.
\nRequest
\nThe id parameter is a unique combination of the Restaurant_ID and Confirmation_Number provided in the request URL, formatted as {rid}-{confirmation_number}.
Request Body Fields
\nNotes
\n- \n
Request Requirements: The
\nidmust be obtained from the original reservation creation process and stored in your system of record. \nCancel Response: A successful cancellation request will return a
\n200 OKstatus with an empty body. \nNo Other Status Changes: Only the status
\nCancelledWebis supported for this API call. \n
OVERVIEW
\nThis API allows you to Modify or Cancel reservations that have been previously booked via this API. Please note that if the reservation is booked outside of this API, you may not be able to modify or cancel.
\nTo perform these queries, you will need the reservation ID. This can be found in the original Make Reservation response or via the Get Reservations query.
\nYou may also choose to update or cancel reservations, via linking to the reservation details view. The reservation details view URL is returned in manage_reservation_url response field of make and get reservation endpoints. The same link works for web, mobile web, and the OpenTable Android and iOS apps.
\n","_postman_id":"42f17619-485f-419f-ada0-47955764942a"},{"name":"Find Reservations","item":[{"name":"Get Reservation","id":"82bcee3c-bcb6-48ca-90e8-b6dbe1688720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"bearer "}],"url":"{{base-url}}/v2/booking/{{rid}}/reservations/{{rid}}-{{confirmation-id}}","description":"Get Reservation API Documentation
\nEndpoint
\nURL: {{base-url}}v2/booking/{rid}/reservations/{rid}-{confirmationId}
Method: GET
\nDescription
\nThe Get Reservation API allows you to retrieve detailed information about a specific reservation for a restaurant. This information includes reservation status, party size, reservation attributes, pricing details, experiences, and additional add-ons.
\nPath Parameters
\nAPI Overview
\nThis API returns a structured payload containing the following key sections:
\n- \n
General Reservation Details: Status, environment, confirmation number, restaurant ID, date/time, party size, and a URL to manage the reservation.
\n \nExperience Object: Provides a detailed breakdown of the experience including pricing, taxes, service fees, and add-ons.
\n \nAdd-Ons: A list of additional items purchased during the reservation with individual pricing, taxes, and service fees.
\n \n
General Reservation Details
\nExperience Object
\nPrice Item Object (experience.prices[])
\nSubtotals Per Price Type Object (experience.subtotalsPerPriceType[])
\nAdd-On Reservation Item Object (experience.addOns[])
\nTax Detail Object (experience.addOns[].taxes[])
\nService Fee Detail Object (experience.addOns[].serviceFees[])
\nNotes
\n- \n
Ensure you use a valid
\nridandconfirmationIdwhen making the request. \nThe API provides a comprehensive breakdown of pricing, taxes, and additional fees for accurate reservation management.
\n \nAll amounts are presented in minor currency units (e.g., cents).
\n \n
API Path
\n/v1/privatedining/restaurant/{{RID}}/leads
\nMethod: POST
\nEligibility Rules
\n- \n
Access is restricted to restaurant IDs (RIDs) with an active Private Dining subscription
\n \nRequests for ineligible RIDs will be rejected
\n \n
\n
Request Parameters
\nPath Parameters
\n\n
Request Body (JSON)
\nRequired Fields
\n\n
eventType Enum Values
\n- \n
\nAnniversary\n
\nBabyShower\n
\nBarMitzvah\n
\nBirthday\n
\nBridalWeddingShower\n
\nCharityEvent\n
\nClass\n
\nCocktailParty\n
\nConference\n
\nCorporateEvent\n
\nDinnerParty\n
\nEngagement\n
\nFilmingLocation\n
\nFundraiser\n
\nGraduation\n
\nHolidayEvent\n
\nLaunchParty\n
\nMeeting\n
\nOther\n
\nPrivateDining\n
\nRehearsalDinner\n
\nSocialEvent\n
\nSpecialOccasion\n
\nWeddingReception\n
\n
Optional Fields
\n\n
Notes & Validation Rules
\n- \n
\neventDatemust be in the future \n
\neventTimemust use 24-hour format \n
\nemailis validated for proper format \n
\npartySizemust be ≥ 1 \nRequests for RIDs without an active Private Dining subscription will fail
\n \n
Overview
\nThe Private Dining Lead API allows partners to create and submit private dining inquiries on behalf of guests directly to an OpenTable restaurant. Each lead is routed using the OpenTable restaurant ID (RID), ensuring the request reaches the correct venue and its private dining team.
\nThis endpoint is designed to support high-value event inquiries such as celebrations, corporate events, and group dining, helping restaurants capture demand beyond standard reservations.
\nPosting leads is restricted to restaurants with an active Private Dining subscription.
\n","_postman_id":"033b00a6-1d26-4b6e-a1ae-7b216b0319b3"}],"id":"daa8627b-ce98-4157-8b16-47a3bf55210e","_postman_id":"daa8627b-ce98-4157-8b16-47a3bf55210e","description":""},{"name":"Use Cases","item":[{"name":"Consumer API Use Case - Make Reservation","item":[{"name":"GET Single RID Search V2","id":"32c44ff6-d8b6-4492-939d-848409c2317e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/v2/availability/{{rid3}}?start_date_time={{yyyy-mm-ddThh:ss}}&forward_minutes={{forwardminutes}}&backward_minutes={{backwardminutes}}&party_size={{partysize}}&require_attributes={{tabletypes}}&include_credit_card_results={{trueorfalse}}&include_experiences={{trueorfalse2}}","urlObject":{"path":["v2","availability","{{rid3}}"],"host":["{{base-url}}"],"query":[{"key":"start_date_time","value":"{{yyyy-mm-ddThh:ss}}"},{"key":"forward_minutes","value":"{{forwardminutes}}"},{"key":"backward_minutes","value":"{{backwardminutes}}"},{"key":"party_size","value":"{{partysize}}"},{"key":"require_attributes","value":"{{tabletypes}}"},{"key":"include_credit_card_results","value":"{{trueorfalse}}"},{"key":"include_experiences","value":"{{trueorfalse2}}"}],"variable":[]}},"response":[{"id":"69e82677-4ff2-488b-9ba0-b4dcbd4bc474","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/v2/availability/{{rid}}?start_date_time={{yyyy-mm-ddThh:ss}}&forward_minutes={{forwardminutes}}&backward_minutes={{backwardminutes}}&party_size={{partysize}}&require_attributes={{tabletypes}}&include_credit_card_results={{trueorfalse}}&include_experiences={{trueorfalse}}","host":["{{base-url}}"],"path":["v2","availability","{{rid}}"],"query":[{"key":"start_date_time","value":"{{yyyy-mm-ddThh:ss}}"},{"key":"forward_minutes","value":"{{forwardminutes}}"},{"key":"backward_minutes","value":"{{backwardminutes}}"},{"key":"party_size","value":"{{partysize}}"},{"key":"require_attributes","value":"{{tabletypes}}"},{"key":"include_credit_card_results","value":"{{trueorfalse}}"},{"key":"include_experiences","value":"{{trueorfalse}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"df7a3d8b-433d-491a-a752-371ac1dc740d"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"108"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/v2/availability/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 18:56:33 GMT"},{"key":"Content-Length","value":"979"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"rid\": 1074796,\n \"party_size\": 2,\n \"times\": [\n \"2025-03-05T07:00\",\n \"2025-03-05T07:15\",\n \"2025-03-05T07:30\",\n \"2025-03-05T07:45\",\n \"2025-03-05T08:00\",\n \"2025-03-05T08:15\",\n \"2025-03-05T08:30\",\n \"2025-03-05T08:45\",\n \"2025-03-05T09:00\",\n \"2025-03-05T09:15\",\n \"2025-03-05T09:30\",\n \"2025-03-05T09:45\",\n \"2025-03-05T10:00\",\n \"2025-03-05T10:15\",\n \"2025-03-05T10:30\",\n \"2025-03-05T10:45\",\n \"2025-03-05T11:00\",\n \"2025-03-05T11:15\",\n \"2025-03-05T11:30\",\n \"2025-03-05T11:45\",\n \"2025-03-05T12:00\",\n \"2025-03-05T12:15\",\n \"2025-03-05T12:30\",\n \"2025-03-05T12:45\",\n \"2025-03-05T13:00\"\n ],\n \"times_available\": [\n {\n \"time\": \"2025-03-05T07:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T07%3A00&sd=2025-03-05T07%3A00&p=2&pt=100&hash=2147862740&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T07%3A00&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T07:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T07%3A15&sd=2025-03-05T07%3A15&p=2&pt=100&hash=217371454&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T07%3A15&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T07:30\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T07%3A30&sd=2025-03-05T07%3A30&p=2&pt=100&hash=2147606043&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T07%3A30&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T07:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T07%3A45&sd=2025-03-05T07%3A45&p=2&pt=100&hash=2032678253&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T07%3A45&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T08:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T08%3A00&sd=2025-03-05T08%3A00&p=2&pt=100&hash=2660307093&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T08%3A00&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T08:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T08%3A15&sd=2025-03-05T08%3A15&p=2&pt=100&hash=138347776&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T08%3A15&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T08:30\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T08%3A30&sd=2025-03-05T08%3A30&p=2&pt=100&hash=2773282000&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T08%3A30&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T08:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T08%3A45&sd=2025-03-05T08%3A45&p=2&pt=100&hash=2614241140&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T08%3A45&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T09:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T09%3A00&sd=2025-03-05T09%3A00&p=2&pt=100&hash=836874191&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T09%3A00&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T09:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T09%3A15&sd=2025-03-05T09%3A15&p=2&pt=100&hash=2708338772&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T09%3A15&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T09:30\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T09%3A30&sd=2025-03-05T09%3A30&p=2&pt=100&hash=1207480732&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T09%3A30&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T09:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T09%3A45&sd=2025-03-05T09%3A45&p=2&pt=100&hash=1793344914&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T09%3A45&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T10:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T10%3A00&sd=2025-03-05T10%3A00&p=2&pt=100&hash=3707628001&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T10%3A00&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T10:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T10%3A15&sd=2025-03-05T10%3A15&p=2&pt=100&hash=1027216335&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T10%3A15&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T10:30\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T10%3A30&sd=2025-03-05T10%3A30&p=2&pt=100&hash=1124764936&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T10%3A30&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T10:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T10%3A45&sd=2025-03-05T10%3A45&p=2&pt=100&hash=3082816818&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T10%3A45&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T11:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T11%3A00&sd=2025-03-05T11%3A00&p=2&pt=100&hash=2813092328&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T11%3A00&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T11:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T11%3A15&sd=2025-03-05T11%3A15&p=2&pt=100&hash=3509409143&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T11%3A15&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T11:30\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T11%3A30&sd=2025-03-05T11%3A30&p=2&pt=100&hash=425483764&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T11%3A30&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T11:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T11%3A45&sd=2025-03-05T11%3A45&p=2&pt=100&hash=3263916944&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T11%3A45&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T12:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T12%3A00&sd=2025-03-05T12%3A00&p=2&pt=100&hash=2022544807&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T12%3A00&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T12:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T12%3A15&sd=2025-03-05T12%3A15&p=2&pt=100&hash=2026935413&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T12%3A15&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T12:30\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T12%3A30&sd=2025-03-05T12%3A30&p=2&pt=100&hash=3752222726&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T12%3A30&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T12:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T12%3A45&sd=2025-03-05T12%3A45&p=2&pt=100&hash=2617696080&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T12%3A45&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-03-05T13:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {},\n \"diningArea\": [\n {\n \"id\": 1,\n \"attributes\": [\n \"default\"\n ],\n \"environment\": \"Indoor\",\n \"booking_url\": \"https://www.opentable.com/book/validate?rid=1074796&d=2025-03-05T13%3A00&sd=2025-03-05T13%3A00&p=2&pt=100&hash=4009648945&ref=&tc=default&diningAreaId=1\",\n \"booking_restref_url\": \"https://www.opentable.com/restref/client?rid=1074796&dateTime=2025-03-05T13%3A00&partySize=2&restref=1074796\"\n }\n ]\n }\n ]\n }\n ],\n \"no_availability_reasons\": [],\n \"href\": \"https://platform.otqa.com/sync/listings/1074796\"\n}"},{"id":"82b41d7b-262e-4da9-be11-7ba577211bd0","name":"404","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{oauth-url}}/v2/availability/{{rid}}?start_date_time={{yyyy-mm-ddThh:ss}}&forward_minutes={{forwardminutes}}&backward_minutes={{backwardminutes}}&party_size={{partysize}}&require_attributes={{tabletypes}}&include_credit_card_results={{trueorfalse}}&include_experiences={{trueorfalse}}","host":["{{oauth-url}}"],"path":["v2","availability","{{rid}}"],"query":[{"key":"start_date_time","value":"{{yyyy-mm-ddThh:ss}}"},{"key":"forward_minutes","value":"{{forwardminutes}}"},{"key":"backward_minutes","value":"{{backwardminutes}}"},{"key":"party_size","value":"{{partysize}}"},{"key":"require_attributes","value":"{{tabletypes}}"},{"key":"include_credit_card_results","value":"{{trueorfalse}}"},{"key":"include_experiences","value":"{{trueorfalse}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"OT-RequestId","value":"c2e3f23e-6ef1-4994-9115-c1df7ec7e033"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1EBF9FAD-AA08-4631-874C-42B0A58954FC"},{"key":"Pragma","value":"no-cache"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"x-frame-options","value":"DENY"},{"key":"Cache-Control","value":"must-revalidate,no-cache,no-store"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"18"},{"key":"Content-Length","value":"133"},{"key":"Date","value":"Mon, 23 Dec 2024 16:14:59 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-12-23T16:14:59.531+0000\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Not Found\",\n \"path\": \"/v2/availability/1074796\"\n}"},{"id":"39fd0ce3-e566-4570-9994-ea9d137ef3cb","name":"403","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/v2/availability/{{rid}}?start_date_time={{yyyy-mm-ddThh:ss}}&forward_minutes={{forwardminutes}}&backward_minutes={{backwardminutes}}&party_size={{partysize}}&require_attributes={{tabletypes}}&include_credit_card_results={{trueorfalse}}&include_experiences={{trueorfalse}}","host":["{{base-url}}"],"path":["v2","availability","{{rid}}"],"query":[{"key":"start_date_time","value":"{{yyyy-mm-ddThh:ss}}"},{"key":"forward_minutes","value":"{{forwardminutes}}"},{"key":"backward_minutes","value":"{{backwardminutes}}"},{"key":"party_size","value":"{{partysize}}"},{"key":"require_attributes","value":"{{tabletypes}}"},{"key":"include_credit_card_results","value":"{{trueorfalse}}"},{"key":"include_experiences","value":"{{trueorfalse}}"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"ff3b1deb-944f-4c34-9634-12dc088fb97e"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"6"},{"key":"Content-Length","value":"95"},{"key":"Date","value":"Mon, 23 Dec 2024 18:49:10 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Permission denied\"\n }\n ],\n \"requestid\": \"ff3b1deb-944f-4c34-9634-12dc088fb97e\"\n}"}],"_postman_id":"32c44ff6-d8b6-4492-939d-848409c2317e"},{"name":"Slot Locks","id":"ab385eb8-1c14-45f6-8eac-0d3ddddc289b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"As a restauranteur I would like to create a custom booking flow on my website.
\nAPIs to use:
\nConsumer API v2:
\n- \n
Availability APIs (Search)
\n \nSlot Locks
\n \nMake Reservation
\n \nAdditional functionlity, not required:
\n- \n
Experiences
\n \nPolicies
\n \nStripe APIs (credit card functionality within the Make Call)
\n \nModify or Cancel
\n \nFind Reservations
\n \n
\n
Overview
\nThe Slot Lock API provides the ability to create, manage, and retrieve reservations for a restaurant. This documentation outlines the payload structure, attributes, and their descriptions, along with sample requests and responses for seamless integration.
\n\n
Request Details
\nEndpoint
\nURL: {{base-url}}/v2/booking/{{rid}}/slot_locks
Method: POST
\nHeaders
\n\n
Request Body
\nAttributes
\nExperience Object Attributes
\nNote: This Data will be gathered from the GET Experiences API response. All attributes are required when booking an experience.
\nParty_Size_Per_Price_Type Array Object Attributes
\nNote: This Data will be gathered from the GET Experiences API response. Optional, applicable only if returned in GET Experiences API
\nAdd_Ons Array Object Attributes
\nNote: This Data will be gathered from the GET Experiences API response. Optional, applicable only if returned in GET Experiences API
\n\n
\n
Notes
\n- \n
- Ensure the
restaurant_id,party_size,date_time, andexperienceattributes are accurate for successful reservation creation. \n
Response
\nNotes
\n- \n
The
\nexpires_attimestamp indicates when the slot lock expires. Ensure the reservation is completed before this time. \nThe
\nreservation_tokenis required for the reservation creation request and ensures the slot remains locked during the reservation process. \nIf the
\nexpires_attime is reached without completing the reservation, the slot will be released. \nTokens should be treated securely and not exposed to unauthorized users.
\n \n
Cancellation Policies API Documentation
\nEndpoint
\nURL: {{base-url}}/v2/cancellation-policies/{rid}/{cancelationid}
Method: GET
\nDescription
\nThe cancellation policy endpoint allows you to retrieve the cancellation policy for a reservation based on the restaurant ID and cancellation ID. The cancelationid is obtained from the response of the Make Reservation call.
Sample Request
\ncurl --location '{{base-url}}/v2/cancellation-policies/{rid}/{cancelationid}' \\\n--header 'Authorization: bearer '\n\nResponse
\n{\n \"partySize\": 5,\n \"policyType\": \"Deposit\",\n \"depositDetails\": {\n \"amount\": 1500,\n \"currency\": \"USD\",\n \"denominator\": 100,\n \"type\": \"PerGuest\"\n },\n \"cutOff\": {\n \"cutoffType\": \"DaysBefore\",\n \"daysBeforeCutoff\": 2\n }\n}\n\nResponse Attributes
\nNotes
\n- \n
Ensure you use a valid
\ncancelationidretrieved from the Make Reservation call. \nThe cutoff policy specifies the period within which cancellations are allowed.
\n \nThe deposit amount is specified in minor currency units (e.g., cents for USD).
\n \n
As a restauranteur I would like to create a custom booking flow on my website.
\nAPIs to use:
\nConsumer API v2:
\n- \n
Availability APIs (Search)
\n \nPolicies
\n \nStripe APIs (credit card functionality within the Make Call)
\n \nSlot Locks
\n \nMake Reservation
\n \nAdditional functionality, not required:
\n- \n
- Experiences \n
\n
Here are some ways our partners use our Consumer APIs.
\n","_postman_id":"84793408-0f49-4aff-afee-853a9e6e05d6"},{"name":"Migration Guide Overview","item":[],"id":"9b1858ff-6951-4577-bc69-5306be515e24","description":"For partners looking to migrate from Online Booking API v1 to Online Booking API v2, we have a detailed migration guide available upon request. We have also included some of the overview details below.
\nPlease note that any new implementation of our APIs may require additional contracting and certification. Please work with your OpenTable team for details.
\nMigration Overview
\nWhat's Changed?
\n- \n
Availability response is nested: availability_types[] with dining_area, environment, and policy refs.
\n \nSearch window expanded to ≤720 minutes.
\n \nNew endpoints: availability-metadata, booking-policies, cancellation-policies, experiences totals.
\n \nSlot lock path changed and adds DELETE to release.
\n \nMake reservation path changed
\n \nBooking supports Accept-Language, gzip, SMS opt-in, dining_area_id, environment.
\n \nLink policy split: booking_url (affiliate) vs booking_restref_url (restaurant group).
\n \n
Breaking Changes You Must Handle
\n- \n
Parse availability_types (remove reliance on time-root attribute/availabilityType).
\n \nLift validators for forward/backward minutes to ≤720.
\n \nNormalize attribute casing (e.g., 'highTop').
\n \nDon’t hard-code policies—fetch and render via policy endpoints.
\n \nImplement DELETE for slot lock cancellation.
\n \n
Minimal Code Changes to Ship
\nKnown Pitfalls
\n- \n
Hard-coded policy copy, leading to mismatches.
\n \nForgetting to DELETE slot_locks on user cancel.
\n \nAttribute casing mismatches breaking filters.
\n \nDesigning APIs or schemas too rigidly, without allowing for additional attributes or fields. This can lead to breaking changes when new properties are introduced within objects or appended to the end of a response. To avoid this, clients should be built to ignore unknown attributes and treat responses as extensible rather than fixed.
\n \n
Overview
\nThe OpenTable Booking API catalog (aka Consumer API) is a robust suite of tools designed to empower partners to seamlessly integrate OpenTable's reservation management functionalities into their own digital platforms. This comprehensive API solution offers a wide array of capabilities, providing restaurants with the ability to not only search for available tables in real-time across single or multiple restaurant locations but also to create, modify, and cancel reservations directly within their own website or application.
\nFurthermore, the Consumer API enables partners to maintain control over their booking policies and customize the user experience to align with their brand identity. By leveraging the API's flexible framework, restaurants can optimize their reservation process, enhance customer engagement, and streamline operations, ultimately driving increased bookings and improved customer satisfaction.
\nFor questions and support, please contact api@opentable.com
\nDetails and Documentation
\nAs of spring 2025, the most current version of Consumer API is v2, and any new implementation must adhere to those specifications. You can find the documentation for the APIs here - docs.opentable.com
\nHelpful Tips
\n- \n
We are here to help! Reach out to us at api@opentable.com should you have any questions.
\n \nEnvironments: During the onboarding process, you will only have access to our pre-production test restaurants. You will be given access to your production restaurants upon certification.
\n \nSearch Window: Although not required, the maximum number of minutes forwards and backwards to search for times is 720 +/-, giving you a full day's window -- Does your implementation allow for a maximized search window or have you accounted for actively limiting the search results?
\n \nTable Types: Although not required, Table Types and Dining Areas are part of over 90% of our current restaurant base -- Are you exposing these options?
\n \nCredit Cards: Although not required, Credit Card capture is required in a growing number of our restaurant base -- Do you have credit card search and capture as part of your implementation or have you accounted for actively not including it?
\n \nEmail opt-in: Do you have means to allow diners to opt-in or opt-out of email marketing from the restaurant in question? If you do not present the option to the diner and that is not part of the API payload, you will not be able to capture their marketing preference.
\n \nReservation Notes: Have you included a field to allow diners to key in freeform notes as requests associated with their reservation?
\n \nExperiences: Make sure you can handle the following experiences IDs (pre prod) for RID 1040230 - The experiences are the same as production but with a different ID:
\n- \n
518093: This experience has multiple priceTitles (these titles can be anything) and a mandatory tip.
\n- \n
- priceId, 129261 has priceAllInclusive = false. Meaning that it has taxes and service which affects the total price \n
\n518092: The name is “Breakfast - Pay at the restaurant” make sure your LLM is not relying on the name to inform the diner that they must pay at the restaurant. (use the price array)
\n \n518091: Experiences inherit the restaurant level/default policy only when the policy is “hold”. Make sure you can handle it on Mondays where there is no policy and Friday to Sunday where there’s a “hold” policy.
\n \n
\n
Testing Environment
\nBelow are some Test Restaurant ID’s (RIDs) that you may utilize for the Consumer API. These are meant to be used for Pre-Production testing only. We have also included some nuances around availability and requirements for each. This should help you test numerous scenarios.
\nNote we consider the following days “Special Days”:
\n- \n
Thanksgiving Day (US Observance date)
\n \nChristmas Eve
\n \nChristmas Day
\n \nNew Year's Day
\n \nMemorial Day
\n \nIndependence Day
\n \nLabor Day
\n \n
RID : 264001
\n- \n
Party Size: 1-20
\n \nShift: 6AM-2AM, Sun-Sat
\n \nSpecial Days closed
\n \n
RID 1038007: With Credit Card Requirements and Experiences (Stripe)
\n- \n
Party Size: 1-10
\n \nShift: 24 hours
\n \nSpecial Days open
\n \n
RID 1040230: With Credit Card Requirements and Experiences (Spreedly)
\n- \n
Party Size: 1-20
\n \nReservations:
\n \n- Monday: standard
\n \n- Tues to Thur: deposit | party size > 2
\n \n- Fri to Sun: credit card hold | party size > 2
\n \n- Experiences: everyday 6am-12am
\n \nShifts: 6AM-12PM, 1PM-5PM, 6PM-11.30PM.
\n \n
RID 268549:
\n- \n
Party Size: 1-10
\n \nShifts: 7AM-6PM, 8PM-12AM, Sun-Sat
\n \nSpecial Days closed
\n \n
RID 138712:
\n- \n
Party Size: 1-6
\n \nShifts: 8AM-2AM, Sun & Sat only
\n \nSpecial Days closed
\n \n
Certification Process
\nOpenTable will need to review and approve your pre-production implementation of the API prior to granting production publication. A minimum window of 14 days for OpenTable to review a pre-production submission is required. Production credentials will be provided only after QA certification of the pre-prod implementation.
\nThe following scenarios will be verified:
\n- \n
Verify party size is between 1-20
\n \nVerify times are between 12:00 AM and 11:30 PM
\n \nDiner should not be allowed to select a past date (optional, but highly recommended)
\n \nPerform a search on a future date, time and party size between 1-20. This should return at least one time slot
\n \nDiner should be allowed to select a date/time/party size and book a reservation that is up-to a year in advance (depends on your preferred setting: it can be as little as 1 day and up to 1 year)
\n \nVerify diner must enter first name, last name, e-mail, and phone number in order to book a reservation
\n \nVerify with different combinations of first, last name, phone number and email address.
\n \nVerify diner is able to cancel a reservation
\n \nIf more than one restaurant locations is supported, verify the reservation is made correctly for the selected location, date, time and party size
\n \nPerform a search on today's date and a time that has already passed. Diner should get available time slots that are in the future.
\n \nBook and cancel a reservation. Confirm the diner's name, date/time/party size of the reservation is accurate. Verify e-mail confirmation is received for booking and cancellation.
\n \nBook two reservations for the same date that are within 2.5 hours. Verify diner gets an appropriate error message and is directed back to the search page for the second reservation. Cancel the first reservation
\n \nIf there is a cut off time for cancellation, verify diner gets a cancellation error if cancellation is made after the cut off time.
\n \nEmail opt in checkbox present and functions correctly in OT4R when on and off
\n \nSpecial requests coming through properly in the Guest Requests section. Make sure only notes appear when entered in web UI
\n \n
Branding Requirements for Website
\n- \n
For details around our brand requirements please visit opentable.design
\n \nThe restaurant website is required to display “Powered by” and the OpenTable logo on any pages/areas that include the reservation booking flow.
\n \nThe restaurant website is required to link to OpenTable’s Terms of Use Privacy Policy and include language requiring the user to agree as part of the reservation booking flow prior to completing the reservation.
\n- \n
E.g. “By clicking ‘Complete reservation’ you agree to the OpenTable Terms of Use and Privacy Policy.”
\n \nTerms and Conditions: https://www.opentable.com/legal/terms-and-conditions
\n \nPrivacy Policy: https://www.opentable.com/legal/privacy-policy
\n \n
\n
Consumer API Availability Notice
\nFor existing partners, Consumer API v1 remains available and supported. There are no deprecation dates currently scheduled for v1. If you are already integrated, you may continue using it as part of your existing implementation. Please coordinate with your implementation team to access the appropriate documentation or if you have any questions regarding usage.
\nHowever, we recommend using Consumer API v2 for all new integrations, as it offers enhanced functionality, improved performance, and ongoing feature development.
\nThe documentation below details Consumer API v2 endpoints.
\n","_postman_id":"e521f540-a3db-404e-ba0d-8e0aea242c5c"},{"name":"In House Booking API (aka Voice AI API)","item":[{"name":"APIs","item":[{"name":"Availability Search","item":[{"name":"Availability","id":"47020dd6-98a1-4f94-b8d7-16113dfb8eed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/inhouse/v1/availability/{{rid4}}?party_size={{party_size}}&start_date_time={{start_date_time}}&forward_minutes={{minutes}}&backward_minutes={{minutes}}&include_experiences={{true_false}}","description":"\n","urlObject":{"path":["inhouse","v1","availability","{{rid4}}"],"host":["{{base-url}}"],"query":[{"key":"party_size","value":"{{party_size}}"},{"key":"start_date_time","value":"{{start_date_time}}"},{"key":"forward_minutes","value":"{{minutes}}"},{"key":"backward_minutes","value":"{{minutes}}"},{"key":"include_experiences","value":"{{true_false}}"}],"variable":[]}},"response":[{"id":"8be67434-679c-4819-8ea8-f2163c12313b","name":"200","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://platform.opentable.com/inhouse/v1/availability/1038007?party_size=2&start_date_time=2025-07-28T13:00&forward_minutes=15&backward_minutes=15&include_experiences=true","protocol":"https","host":["platform","opentable","com"],"path":["inhouse","v1","availability","1038007"],"query":[{"key":"party_size","value":"2"},{"key":"start_date_time","value":"2025-07-28T13:00"},{"key":"forward_minutes","value":"15"},{"key":"backward_minutes","value":"15"},{"key":"include_experiences","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"3fbf5a39-4f60-4831-97e3-7dab461790f3"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"6b58e986-e618-4ee8-86f5-e6dbb65c1f94"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/availability/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 18:14:38 GMT"},{"key":"Content-Length","value":"324"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQSXQyF4XwZy+XAQAAb15NQRzJzELvqIEK1SScITAKraItPQdCM10BMwtB5+mD2NtLQf9AhJarXVi8L2qNLmx/tFWTJvy6d4WaMIpz8aYbX5q+KUVk5Cgg9Tu9dkWlBy0Yh6lmm0wV9gNsgUHeQyJ/4DNN0Dp89wDbIOcUiUoZaI96OFSKyKtuWdbW39gajY2/JtbLYJCs2Zx0rYXJ/9mspoBAn8BVv5kor0g7uZLd0dDs7KMVvyOWtjyt+V/JVdh1VQ==~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=2401; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"rid\": 1038007,\n \"party_size\": 2,\n \"restaurant_settings\": {\n \"scc_enabled\": true\n },\n \"times\": [\n \"2025-07-28T12:45\",\n \"2025-07-28T13:00\",\n \"2025-07-28T13:15\"\n ],\n \"times_available\": [\n {\n \"time\": \"2025-07-28T12:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-07-28T13:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-07-28T13:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"47020dd6-98a1-4f94-b8d7-16113dfb8eed"},{"name":"Availability Metadata","id":"21868040-9ca6-43c4-9438-781bc2bed7f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"
Overview
\nThis documentation outlines the process for using the Availability Search API to retrieve reservation times and metadata for one restaurant.
\nEndpoint
\nURL: {{base-url}}/v2/availability-metadata/{{rid}}
Path Parameter
\nQuery Parameters
\nThe API does not use query parameters for this endpoint.
\nResponse Elements
\nThe API response includes the following elements:
\nData
\nThe data object includes:
The dining_areas Array
\nEach dining area object includes:
\n","urlObject":{"path":["v2","availability-metadata","{{rid4}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"a79d88ff-13f4-4012-b22d-c61dc5176a1a","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"token","type":"text","disabled":true}],"url":"{{base-url}}/v2/availability-metadata/{{rid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"8f49d723-7db4-4c2d-aa61-a58a84727ed1"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"16"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/v2/availability-metadata/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Wed, 05 Feb 2025 19:48:50 GMT"},{"key":"Content-Length","value":"205"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"enviroments\": [\n \"Outdoor\",\n \"Indoor\"\n ],\n \"attributes\": [\n \"bar\",\n \"counter\",\n \"highTop\",\n \"default\"\n ],\n \"dining_areas\": [\n {\n \"id\": 1,\n \"name\": \"Other\",\n \"description\": \"Other\"\n },\n {\n \"id\": 2439,\n \"name\": \"Garden\",\n \"description\": \"Garden\",\n \"environment\": \"Outdoor\"\n },\n {\n \"id\": 2632,\n \"name\": \"VIP Lounge\",\n \"description\": \"Ultra VIP lounge\",\n \"environment\": \"Indoor\"\n }\n ]\n }\n}"}],"_postman_id":"21868040-9ca6-43c4-9438-781bc2bed7f0"}],"id":"ab80c4d3-3c2e-44a5-9289-e47e8eabcbbb","description":"Introduction
\nAvailability Search API provides developers with a streamlined way to retrieve restaurant reservation availability using OpenTable's platform. This API enables partners to perform highly customizable searches based on parameters such as date, time, party size, table type, and more.
\nOverview
\nAvailability Search API allows you to:
\n- \n
Customize searches with parameters like date, time range, party size, and table type.
\n \nRetrieve detailed availability, including dining area information and cancellation policies.
\n \nInclude special options like experiences and credit-card-secured reservation times.
\n \nThis will search for any inventory available that has been categorized as \"In House Only\" or \"All Availabilities\"
\n \n
Request
\nMethod: GET
Search URL: {{base-url}}/inhouse/v1/availability/{RID}
Path Parameter
\nQuery Parameters
\n📝 Note:
\n- \n
The API considers 5 AM as the start of a new business day.
\n \nExample: A request with
\nstart_date_time = 2024-01-10T03:30will only search availability between 01:00 and 04:45 on 2024-01-10. \nIf no availability is found, a
\n200 OKwill be returned with empty arrays. \n
\n
Response
\nThe restaurant_settings Object
\n\n
The times_available Array
\nThe availability_types Array
\n\n
The cancellationPolicy Object
\n\n
The dining_area Array
\nUnderstanding Dining Areas and Table types
\n- \n
Dining Area: is a grouping of tables within a specific physical or conceptual section of a restaurant, such as “Patio,” “Main Room,” or “Lounge.” Restaurants can create dining areas and assign tables to them.
\n- \n
- A restaurant section without a designated Dining Area, will return
other\n
\n- A restaurant section without a designated Dining Area, will return
Table Type describes the attributes of the table itself. The available table types are: Regular (API sees
\ndefault), High top, Counter, Bar and Outdoor- \n
- A table without a designated Table Type, will return
default\n
\n- A table without a designated Table Type, will return
When all the Dining Areas and Tables Types are assigned and these are not provided in the request, you will get the following error because the API has no value to default to.
\nNote: Don't forget include these in your Slot Lock and Make Reservation endpoints
\n{\n \"errors\": [\n {\n \"code\": \"NoAvailability\",\n \"message\": \"No availability found for the given parameters\"\n }\n ],\n \"requestid\": \"53e15428-79dc-888-a55a-3e4fb50f5\"\n}\n\n📝 Note:
\nTo retrieve full dining area details, make a call to:https://platform.opentable.com/v1/availability-metadata?rid={}
Common Error Messaging
\n\n
Search - Common Errors
\n\n","_postman_id":"ab80c4d3-3c2e-44a5-9289-e47e8eabcbbb"},{"name":"Experiences","item":[{"name":"Experience-Specific Cancellation Policies","item":[],"id":"96a444bc-6fe4-4b19-8ce0-d5e1e146f89e","description":"
Experience-Specific Policies
\nOpenTable supports customizable policies for individual experiences, allowing restaurants to tailor booking, cancellation, and terms and conditions to each unique offering. These policies apply only to reservations made for a specific experience and do not affect standard reservations.
\nPolicy Hierarchy
\nRestaurants can choose to:
\n- \n
- Define experience-specific policies for each experience, or use default policies that apply to all reservations via OpenTable for Restaurants (OT4R). \n
Types of Experience-Specific Policies
\n- \n
Prepaid Experiences
\nAlways use a
\nPrepaymentpolicy type. \nFree and non pre paid Experiences:
\n- \n
- Will inherit the restaurant level/default policy only when the policy is hold \n
\n
📝 Note - Free Experiences: they inherit the restaurant level policy when it's hold.
\nLegacy Experiences
\nExperiences created before the launch of experience-specific policies will retain their original configurations. These are referred to as legacy experiences and do not adopt the new policy structures unless updated manually.
\n\n
API Changes: Availability Search
\nTo support these policies, a new structure has been introduced in the availability search response:
\n- \n
New Field:
\navailability_types.experienceCancellationPolicy- \n
This field is included only when the
\ntypeis\"Experience\". Developers should use this new structure to retrieve cancellation policies for experience-based availability. \nExperiences cannot be cancelled nor modified
\n \n
\n
Backward Compatibility Notice:
\nDuring the transition period, the legacy cancellationPolicy field will continue to appear for \"Experience\" availability types. This allows developers to integrate the new field while maintaining compatibility with existing implementations.
\n
Example API Response
\n{\n \"times_available\": [\n {\n \"time\": \"2025-03-31T11:30\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"cancellationPolicy\": {\n \"type\": \"Deposit\",\n \"id\": \"605388198f76d3d97a5e6964:v13\",\n \"amount\": 500,\n \"denominator\": 100,\n \"currency\": \"USD\",\n \"depositType\": \"PerGuest\"\n }\n },\n {\n \"type\": \"Experience\",\n \"cancellationPolicy\": {\n \"type\": \"Deposit\",\n \"id\": \"605388198f76d3d97a5e6964:v13\",\n \"amount\": 500,\n \"denominator\": 100,\n \"currency\": \"USD\",\n \"depositType\": \"PerGuest\"\n },\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 513366,\n \"type\": \"Prepayment\",\n \"id\": \"67d3235f4c20509ba6dce0d6:v1\"\n },\n {\n \"experienceId\": 512230,\n \"type\": \"Deposit\",\n \"id\": \"605388198f76d3d97a5e6964:v13\",\n \"amount\": 500,\n \"denominator\": 100,\n \"currency\": \"USD\",\n \"depositType\": \"PerGuest\"\n },\n {\n \"experienceId\": 513364,\n \"type\": \"Hold\",\n \"id\": \"67d31ba38762da53f4b1df07:v1\"\n },\n {\n \"experienceId\": 512940,\n \"type\": \"Prepayment\",\n \"id\": \"67b89d527e04fd46b4435295:v1\"\n }\n ]\n }\n ]\n }\n ]\n}\n\nThe experienceCancellationPolicy object is the authoritative source for cancellation details associated with experience-based reservations and will eventually replace the general cancellationPolicy field.
\n","_postman_id":"96a444bc-6fe4-4b19-8ce0-d5e1e146f89e"},{"name":"Active Experiences","id":"4c0ae07b-5ac7-4db2-9b7a-f1cb2f1562ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/inhouse/v1/booking/experiences/{{rid4}}","description":"
Active Experiences API
\nOverview
\nThe Active Experiences endpoint allows clients to retrieve a list of active bookable experiences associated with a specific restaurant. It includes rich metadata such as descriptions, pricing, gratuity, and availability details.
\nImportant Note: This endpoint may return experiences that are not bookable by phone. Partners must validate bookability using the availability search endpoint, based on date, time, and party size.
\n\n
Request
\n- \n
Method:
\nGET\nURL:
\n{{base-url}}/inhouse/v1/booking/experiences/{{rid}}\n
Path Parameter
\n\n
Response
\n\n
The data Array: Active Experience
\n\n
The price_info Object
\n\n
The gratuity Object
\nGratuity = tip: it is an additional charge added to the cost of an experience and It can be mandatory or optional. If it gratuity is mandantory, it should be mentioned.
\n\n
The prices Array
\nExperiences return an array of prices to enable flexible, category-based pricing for the same event or service. This design allows for:
\n- \n
Differentiated pricing for various guest types (e.g., adults, children, seniors)
\n \nAccommodation of promotional rates or packages within a single experience
\n \nGreater configurability for venues to tailor pricing based on demand, time, or guest characteristics
\n \n
By storing prices as an array, the system can seamlessly present appropriate options for each booking without requiring separate experience entries for each pricing scenario.
\n\n
Common Error Messaging
\nError Response Structure
\n\n
Active Experiences - Common Errors
\n\n","urlObject":{"path":["inhouse","v1","booking","experiences","{{rid4}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"a332eb9a-1a7d-4287-8082-a6d3c561b6e5","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://platform.opentable.com/inhouse/v1/booking/experiences/1038007"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"012192af-5919-4d95-9629-e56a2d2659ef"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"8957e661-7832-44c8-8cd1-a503a9b3d65c"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/experiences/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"597"},{"key":"Date","value":"Thu, 05 Jun 2025 16:33:54 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"otuvid=1D9E2108-2191-4176-B6BF-A6F651D643C8; Path=/; Domain=opentable.com; Max-Age=31536000; Expires=Fri, 05 Jun 2026 16:33:54 GMT; Secure; SameSite=None"},{"key":"Set-Cookie","value":"ak_bmsc=C127FE2E39AD8A57F525EC974CF02C6E~000000000000000000000000000000~YAAQUKvWF2Sb5DOXAQAAxiHxQBweTh73hMU1iL/14ts/0eGlmcw0MbXkU7ZCKHEahy9NRVN8n4ZyCtInXSiPA58g+OMghgdZPHceuZEGuL5j2d0Sspw8aVkdEXVIqQ5j5x+SqJsFSHFUuNF6dbAxiQw7bpQs471mBB140OCFfYe2YYkRRaE9gyZRWI67vTC9fntO+V0O+ZlXT/mIBHr/DR+GjCKZowBwB5w2pklmGWadyH7gjMoKxW/lXHPpZrbq51MpzBcMEdinR9+7w8WrS2Pip9UfIPNgd5IZSTLZc7xo1HAEeDxkhIHKcDL2vO7xuCbQ0ZBucfVCBaXGkCVfbqD3IL/gPHJh2bbeaA==; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:33:51 GMT; Max-Age=7197"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"bookable\": true,\n \"currency\": \"USD\",\n \"description\": \"test test test test\",\n \"experience_id\": 111800,\n \"name\": \"Tequila Dinner\",\n \"rid\": 1038007,\n \"version\": 3,\n \"price_info\": {\n \"price_type\": \"PER_PERSON\",\n \"prepayment_required\": false,\n \"currency_code\": \"USD\",\n \"multiplier\": 100,\n \"prices\": [\n {\n \"price_id\": 239721,\n \"min_unit_amount\": 5000,\n \"price_all_inclusive\": true\n }\n ]\n }\n },\n {\n \"bookable\": true,\n \"currency\": \"USD\",\n \"description\": \"Enjoy an amazing evening with the best pizza, that has won 3 Michelin stars.\",\n \"experience_id\": 324887,\n \"name\": \"Michelin Pizza Dinner\",\n \"rid\": 1038007,\n \"version\": 5,\n \"price_info\": {\n \"price_type\": \"PER_PERSON\",\n \"prepayment_required\": false,\n \"currency_code\": \"USD\",\n \"multiplier\": 100,\n \"gratuity\": {\n \"label\": \"Gratuity\",\n \"numerator\": 1000,\n \"denominator\": 10000,\n \"mandatory\": true,\n \"taxable\": false\n },\n \"prices\": [\n {\n \"price_id\": 626016,\n \"price_title\": \"price 1\",\n \"min_unit_amount\": 10000,\n \"price_all_inclusive\": false\n },\n {\n \"price_id\": 635228,\n \"price_title\": \"Kid\",\n \"min_unit_amount\": 5000,\n \"price_all_inclusive\": false\n }\n ]\n }\n },\n {\n \"bookable\": true,\n \"currency\": \"USD\",\n \"description\": \"Non prepaid Rakesh\",\n \"experience_id\": 441127,\n \"name\": \"Non prepaid Rakesh\",\n \"rid\": 1038007,\n \"version\": 1,\n \"price_info\": {\n \"price_type\": \"PER_PERSON\",\n \"prepayment_required\": false,\n \"currency_code\": \"USD\",\n \"multiplier\": 100,\n \"prices\": [\n {\n \"price_id\": 719518,\n \"min_unit_amount\": 3300,\n \"price_all_inclusive\": true\n }\n ]\n }\n },\n {\n \"bookable\": true,\n \"currency\": \"USD\",\n \"description\": \"Rakesh Non prepaid with custom cancellation\",\n \"experience_id\": 449565,\n \"name\": \"Rakesh Non prepaid with custom cancellation\",\n \"rid\": 1038007,\n \"version\": 1,\n \"price_info\": {\n \"price_type\": \"PER_PERSON\",\n \"prepayment_required\": false,\n \"currency_code\": \"USD\",\n \"multiplier\": 100,\n \"prices\": [\n {\n \"price_id\": 726466,\n \"min_unit_amount\": 2000,\n \"price_all_inclusive\": true\n }\n ]\n }\n },\n {\n \"bookable\": true,\n \"currency\": \"USD\",\n \"description\": \"Experience with hold\",\n \"experience_id\": 480995,\n \"name\": \"Experience with hold\",\n \"rid\": 1038007,\n \"version\": 1,\n \"price_info\": {\n \"price_type\": \"PER_PERSON\",\n \"prepayment_required\": false,\n \"currency_code\": \"USD\",\n \"multiplier\": 100,\n \"prices\": [\n {\n \"price_id\": 751251,\n \"min_unit_amount\": 100,\n \"price_all_inclusive\": true\n }\n ]\n }\n },\n {\n \"bookable\": true,\n \"currency\": \"USD\",\n \"description\": \"Special menu with CC required\",\n \"experience_id\": 345068,\n \"name\": \"Special menu with CC required\",\n \"rid\": 1038007,\n \"version\": 4,\n \"price_info\": {\n \"price_type\": \"PER_PERSON\",\n \"prepayment_required\": true,\n \"currency_code\": \"USD\",\n \"multiplier\": 100,\n \"gratuity\": {\n \"label\": \"Gratuity\",\n \"numerator\": 2000,\n \"denominator\": 10000,\n \"mandatory\": true,\n \"taxable\": false\n },\n \"prices\": [\n {\n \"price_id\": 638112,\n \"min_unit_amount\": 2000,\n \"price_all_inclusive\": true\n }\n ]\n }\n }\n ]\n}"}],"_postman_id":"4c0ae07b-5ac7-4db2-9b7a-f1cb2f1562ed"},{"name":"Experience Total","id":"36f79fcf-eeda-4645-b6c0-421c296960e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"experience_id\":324887,\n \"party_size_per_price_type\": [\n {\n \"id\":626016,\n \"count\":2\n },\n {\n \"id\":635228,\n \"count\":1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/inhouse/v1/booking/experiences/{{rid4}}","description":"
Experience Total API
\nOverview
\nThe Experience Total endpoint calculates the full cost breakdown for a selected experience, including optional add-ons, service fees, taxes, and gratuity, based on the party size and price types.
\n\n
Request
\n- \n
Method:
\nPOST\nURL:
\n/booking/experiences/{RID}\n
Path Parameter
\nRequest Body
\n\n
Response
\n\n
Common Error Messaging
\nError Response Format
\n\n
Experience Total – Common Errors
\n","urlObject":{"path":["inhouse","v1","booking","experiences","{{rid4}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"9bc63cd3-922d-4ac8-998d-dfeb0754766d","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"experience_id\":324887,\n \"party_size_per_price_type\": [\n {\n \"id\":626016,\n \"count\":2\n },\n {\n \"id\":635228,\n \"count\":1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.opentable.com/inhouse/v1/booking/experiences/1038007"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"2f63e3a5-bf58-4a0e-900e-4bdb1b6d3c68"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"18db26ec-ae84-47f5-b02a-ef7bb0b090af"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/experiences/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 16:55:18 GMT"},{"key":"Content-Length","value":"88"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQSXQyF/TrZC+XAQAAj7wEQRxJIJ6/LUZFW9fRPvb4C21Kdpzvx6Uy4JQuSjBqWBsIXbYO/IfVe/Edw3BLDspzBuuRuYGEQhZ9XnCBmUCeBkJnybwlBme45dv40KwDh4D9Gl3luGqNMxclSj5dshaC0V+mgyP4r32HS7VVhUIqB4yaWl/SHMj4v+fq5iAQgEXKFi3TdtsFrDxAfmze1TI93Cg6KAtI7jCoBnKfe9eC4n/UY8zNVP14zg9TH5sLDQ6v~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=7161; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"subtotal_amount\": 25000,\n \"service_fee_amount\": 2500,\n \"taxes_amount\": 2750,\n \"tip_amount\": 2500,\n \"total_amount\": 32750\n}"}],"_postman_id":"36f79fcf-eeda-4645-b6c0-421c296960e6"}],"id":"85c6db54-f3af-4e90-95ee-121d415123d9","description":"Description
\nOVERVIEW
\nExperiences allow restaurants to use their availability for special events. From happy hour to winery tours, $1 oysters to exquisite 12-course tasting menus and more. When restaurants offer Experiences on OpenTable, the Voice AI API will allow you to book, confirm and even collect deposits.
\nAvailability for the experiences are real-time and reservations are confirmed in the system once the reservation is completed. You can choose to show only standard availability or also include experiences by using the include_experiences query parameter.
HOW WILL THIS IMPACT RESTAURANTS?
\nWhile these APIs are optional, restaurants that offer experiences will have inventory dedicated to the experiences. Here is how it looks on OpenTable.com for a restaurant with an experience and standard availability.
\nDescription
\nOVERVIEW
\nSlot Locks allow for the inventory that has been chosen by the booker to be locked for a total of 5 minutes. This allows that no other user can book the reservation while the initial booker completes their transaction. If a booking is attempted after the slot lock expiry, the booking can be re-tried, but availability is not guareenteed.
\nAvailability has already been verified via the APIs, this step will block the availability for the diner and allow for booking.
\nThe five minute window is hard coded and cannot be edited.
\nHOW WILL THIS IMPACT RESTAURANTS?
\nRestaurant availability will be blocked for that specific user for the allotment of the slot lock window.
\nEndpoint Details
\n- \n
Method:
\nPOST\nURL:
\n{{base-url}}/inhouse/v1/booking/{{rid}}/locks\n
Path Parameter
\nRequest Body
\nThe body of the request must be a JSON object containing the following fields:
\nExample Request Body for Slot Locks
\n{\n \"restaurant_id\": 1234,\n \"party_size\": 2,\n \"date_time\": \"2025-07-28T12:45\",\n \"table_type\": \"default\",\n \"dining_area_id\": 1\n \"experience_id\": 542699 # If applicable\n}\n\nDescription:
\nCreates a new reservation at the specified restaurant. This endpoint supports both standard and experience-based reservations. Depending on the payload, OpenTable will validate availability, pricing, guest information, and—if applicable—any associated experience rules (e.g., prepaid charges or deposit holds).
\nHow will this impact restaurants?
\nThis will create a phone reservation with all applicable details in the OpenTable for Restaurants table management software.
\nEndpoint Details
\n- \n
Method:
\nPOST\nURL:
\n{{base-url}}/inhouse/v1/booking/{{rid}}/reservations\n
Path Parameter
\nRequest Body (Standard)
\nThe body of the request must be a JSON object containing the following fields:
\nThe phone_number Object
\nNote: please reach out to you account manager if you're interested in using this.
\nExample Request Body for Make Reservations (Standards)
\n{\n \"first_name\": \"Savannah\",\n \"last_name\": \"GourmetExplorer\",\n \"phone\": {\n \"number\": \"4153444200\",\n \"country_code\": 1\n },\n \"special_request\": \"Date night\",\n \"restaurant_id\": \"1038007\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiIyMTA0NzI2NzU1fDR8MjAyNC0wMy0wOVQxNjowMHwxMDM4MDA3In0.bxxF9zraEtxu9OIVMjfJm-WPZ9J2xicurQpIO8MFx384Dg4sz6zxyjs5itZt4gVvL7NiAj029cmjcqK74fiJ2Q\",\n \"table_type\": \"default\",\n \"dining_area_id\": 1,\n \"sms_notifications_opt_in\": true\n}\n\nRequest Body (with Experiences)
\nThe experience object
\nWhen a booking is for a specific experience, the experience object must be added to the body of the standard Make Reservation request and must include the following nested fields
The party_size_per_price_type Array
\nNote: For free experiences omit this array but keep the experience object with just the id and version
Each object in the party_size_per_price_type array contains:
Example Request Body for Make Reservation with Experiences - This reservation is for 6 people.
\n{\n \"first_name\": \"Savannah\",\n \"last_name\": \"GourmetExplorer\",\n \"phone\": {\n \"number\": \"4153444200\",\n \"country_code\": 1\n },\n \"special_request\": \"Date night\",\n \"restaurant_id\": \"1038007\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiIyMTA0NzI2NzU1fDR8MjAyNC0wMy0wOVQxNjowMHwxMDM4MDA3In0.bxxF9zraEtxu9OIVMjfJm-WPZ9J2xicurQpIO8MFx384Dg4sz6zxyjs5itZt4gVvL7NiAj029cmjcqK74fiJ2Q\",\n \"table_type\": \"default\",\n \"dining_area_id\": 1,\n \"sms_notifications_opt_in\": true,\n \"experience\": {\n \"id\": 542724,\n \"version\": 1,\n \"party_size_per_price_type\": [ \n {\n \"id\": 12345,\n \"count\": 4\n },\n {\n \"id\": 321,\n \"count\": 2\n }\n ]\n }\n}\n\nBooking Policies API Documentation
\nEndpoint
\n{{base-url}}/v2/booking-policies/{{rid}}/{YEAR-MONTH-DAY}/{TIME}/{PartySize}
Path Parameters
\n- \n
rid (restaurant id): A static identifier for each restaurant.
\n \ndate (YEAR-MONTH-DAY): Specifies the booking date. Example:
\n2024-12-01. \ntime (TIME): Specifies the time of the reservation. Must be in 15-minute intervals (
\n7:00,7:15,7:30,7:45). \nPartySize: Specifies the number of guests for the booking policy query.
\n \n
Query Parameters
\nResponse Elements
\nPolicies Attributes
\nLanguage Attributes
\n","urlObject":{"path":["v2","booking-policies","{{rid4}}","{{date}}","{{time}}","{{partysize}}"],"host":["{{base-url}}"],"query":[{"key":"dinerContext","value":"details"}],"variable":[]}},"response":[{"id":"b5a5cbdc-b85d-4423-8aea-07ecc1264944","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"bearer ","type":"text"}],"url":{"raw":"{{base-url}}/v2/booking-policies/{{rid}}/{{date}}/{{time}}/{{partysize}}?dinerContext=details","host":["{{base-url}}"],"path":["v2","booking-policies","{{rid}}","{{date}}","{{time}}","{{partysize}}"],"query":[{"key":"dinerContext","value":"details"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin,Access-Control-Request-Method,Access-Control-Request-Headers"},{"key":"OT-RequestId","value":"72ea2a04-bb79-4f41-8eed-4d9669ded136"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"73"},{"key":"x-ot-backend","value":"partnerfeeds"},{"key":"x-ot-uritemplate","value":"/partnerfeeds/v1/booking-policies/{rid}/{date}/{time}/{partySize}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 20:21:52 GMT"},{"key":"Content-Length","value":"266"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Policies\": [\n {\n \"Message\": \"We have a 15 minute grace period. Please call us if you are running later than 15 minutes after your reservation time.Your table will be reserved for 1 hour 30 minutes for parties of up to 2; 2 hours for parties of up to 4; 2 hours 30 minutes for parties of up to 6; and 3 hours for parties of 7+.\",\n \"Type\": \"General\",\n \"Language\": {\n \"Code\": \"en\",\n \"Region\": \"US\",\n \"IETF\": \"en-US\"\n }\n }\n ]\n}"}],"_postman_id":"669c7bd2-764b-4519-8bfc-38eed2c34328"},{"name":"Cancellation Policies","id":"581c1f0b-8876-4273-9287-d78301449e0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"bearer ","type":"text"}],"url":"{{base-url}}/v2/cancellation-policies/{{rid}}/{{cancelation-ID}}","description":"
Cancellation Policies API Documentation
\nEndpoint
\nURL: {{base-url}}/v2/cancellation-policies/{rid}/{cancelationid}
Method: GET
\nDescription
\nThe cancellation policy endpoint allows you to retrieve the cancellation policy for a reservation based on the restaurant ID and cancellation ID. The cancelationid is obtained from the response of the GET Availability call.
Responsne (Deposit)
\n{\n \"partySize\": 5,\n \"policyType\": \"Deposit\",\n \"depositDetails\": {\n \"amount\": 1500,\n \"currency\": \"USD\",\n \"denominator\": 100,\n \"type\": \"PerGuest\"\n },\n \"cutOff\": {\n \"cutoffType\": \"DaysBefore\",\n \"daysBeforeCutoff\": 2\n }\n}\n\nResponse Attributes
\nRespone (Hold)
\n{\n \"name\": \"CC Hold\",\n \"partySize\": 2,\n \"policyType\": \"Hold\",\n \"holdDetails\": {\n \"cancellationPenaltyAmount\": 5,\n \"guestCountChangePenaltyAmount\": 5\n },\n \"cutOff\": {\n \"cutoffType\": \"DaysBefore\",\n \"daysBeforeCutoff\": 2\n },\n \"schedules\": [\n {\n \"priority\": 2,\n \"startDate\": \"2026-02-13\",\n \"endlate\": \"2028-01-01\",\n \"startTime\": \"12:00\",\n \"endTime\": \"13:45\"\n }\n ]\n}\n\nNotes
\n- \n
Ensure you use a valid
\ncancelationPolicy.idretrieved from the Make Reservation or Availability call. \nThe cutoff policy specifies the period within which cancellations are allowed.
\n \nThe deposit amount is specified in minor currency units (e.g., cents for USD).
\n \nAmount for desposit is in fractional unit. For hold, it's in whole numbers
\n \nRemember that cancelling
\nholdordepositreservations outside the cancellation is not supported through this API \n
OVERVIEW
\nBooking Policies allow the restaurants to expose any specific details they would like the diner to know when they book the reservation.
\nThese details should be exposed when the diner is confirming the reservation so that they understand the terms of the reservations. These can be as simple as \"We offer valet parking...\" to \"Deposit of $50.00 will be collected if there is a no show\".
\nA few notes:
\n- \n
Booking and Cancellation Policies can vary by date and party size.
\n \nIf no policies are available, the APIs will return an empty response.
\n \n
Booking – Cancel
\nOverview
\nThis API allows partners to cancel an existing reservation. Cancellations may be subject to cancellation policies such as credit card holds or deposits. Depending on the policy and timing, the cancellation may either be processed automatically or require human intervention.
\n\n
Endpoint
\nMethod: DELETE
URL: {{base-url}}/inhouse/v1/booking/{{rid}}/reservations/{{reservation-id}}
\n
Path Parameters
\n\n
Cancellation Policy Considerations
\nCancellation behavior is determined by the cancellation window defined in the reservation’s policy. This window specifies the timeframe during which diners can cancel without losing deposits or incurring charges.
\nIf a cancellation is attempted after the window has closed, the diner may forfeit their deposit or be charged, depending on the restaurant’s terms. In these cases, OpenTable may not be able to complete the cancellation directly.
\nWhen cancellation is not supported automatically, the API will return a 403 Forbidden with error code RedirectToHost, indicating that the restaurant must be contacted directly.
\n
Response Codes
\n\n
Error Structure
\nExample:
\n{\n \"errors\": [\n {\n \"code\": \"InvalidRidOrReservationId\",\n \"message\": \"Restaurant id or reservation id is invalid\"\n }\n ],\n \"requestid\": \"8414fadb-eac6-4869-80aa-3ee999974cd7\"\n}\n\n\n
Common Errors
\n\n","_postman_id":"43f5b44e-dc22-4711-8fbe-8fae0219e467"},{"name":"Lookup API","item":[{"name":"Lookup API","id":"e50492ab-d8e8-42eb-9879-b47f260550f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"phone_number\":{\n \"number\": \"4155555555\",\n \"country_code\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/inhouse/v1/booking/{{rid4}}/reservations/search","urlObject":{"path":["inhouse","v1","booking","{{rid4}}","reservations","search"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"84627144-0cf4-4b85-8f9e-19d3d846c28c","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"phone_number\": {\n \"number\": \"4153444200\",\n \"country_code\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.opentable.com/inhouse/v1/booking/1038007/reservations/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"f4e841ed-982e-4bfd-bb62-b8eb4e0df1ce"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"cfdcc958-df21-439a-bcb6-df2f053508e6"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/{rid}/reservations/search"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Sun, 08 Jun 2025 21:39:32 GMT"},{"key":"Content-Length","value":"192"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=DEB77D133D433A987AD21C15F197330E~YAAQUdYhF1a2czOXAQAANAd8URz0YNNr566OjWU01q/LfTk5WQV+nDrkL/FolV0t42BwdiNJ6Eo6FhxikFcp7Ypf0XCQ0DdEok1dvF1EMajqirnHchB/VM6JIs7yWM/p0NzQwXYY1ioGlB+wiJrcKC590A6TW9ZkhWhmxvEFdYh/SDs3djdNejTVleASprYU64VUN6QlvtDO8ufhgeG2XB09mImrRPiwqopx96/AO1q0eJ16zBE+L3kFtdK0VXBMBHOg~1; Domain=.opentable.com; Path=/; Expires=Sun, 08 Jun 2025 23:36:01 GMT; Max-Age=6989; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"reservations\": [\n {\n \"special_request\": \"Date night\",\n \"confirmation_number\": 2592,\n \"reservation_id\": \"6841dffddc6521cc719cebaa\",\n \"restaurant_id\": 1038007,\n \"date_time\": \"2025-07-28T12:45:00\",\n \"party_size\": 2,\n \"status\": \"Modifiable\"\n }\n ]\n}"}],"_postman_id":"e50492ab-d8e8-42eb-9879-b47f260550f8"}],"id":"cadd112d-1811-4f88-a724-3168148e347a","description":"
Booking – Lookup
\nOverview
\nThis API endpoint allows partners to search for and identify diners who have upcoming reservations at a specific restaurant. By submitting a phone number partners can retrieve a list of matching reservations. Additional optional parameters, such as reservation date or diner’s first and last name, can be included to narrow the search and improve accuracy.
\n\n
Endpoint
\nMethod: POST
\nURL: {{base-url}}/inhouse/v1/booking/{{rid}}/reservations/search
\n
Path Parameters
\n\n
Request Body Parameters
\nNotes:
\n- \n
The reservations being returned is NOT a guarantee that any given update request will succeed; the client must at least execute a subsequent availability check to find available times for the reservation. However, certain internal conditions, such as a change in cancellation policy (for example, if the time or party size change), may still cause the update to fail. Also, currently we do not distinguish in the response whether a reservation is updatable or cancellable.
\n \nOpenTable will retrieve all reservations associated with the phone number provided on the specified date(00:00-23:59) in the request. It is the responsibility of the partners to accurately identify the specific reservation the diner is calling about.
\n \n
\n
Behavior and Limitations
\n- \n
The endpoint performs exact match searches based on the input data.
\n \nDoes not return first and last name.
\n \nThe response does not explicitly indicate whether a reservation is updatable or cancellable.
\n \n
\n
Response Structure
\nReturns an array of matching reservations with the following attributes:
\n\n
Error Handling
\nIf the request fails, the response includes:
\n\n
Common Errors
\n\n","_postman_id":"cadd112d-1811-4f88-a724-3168148e347a"},{"name":"Change Reservation","item":[{"name":"Change Request","id":"7977ec45-1f90-4376-820d-1800082f7024","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"party_size\": \"2\",\n \"date_time\": \"2025-07-29T12:45\",\n \"special_request\": \"Birthday celebration\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/inhouse/v1/booking/{{rid4}}/reservations/{{id}}","urlObject":{"path":["inhouse","v1","booking","{{rid4}}","reservations","{{id}}"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"3e4f5f49-b57b-4ece-b8b1-c9579f7e405e","name":"200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"party_size\": \"2\",\n \"date_time\": \"2025-07-29T12:45\",\n \"special_request\": \"Birthday celebration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.opentable.com/inhouse/v1/booking/1038007/reservations/6841dffddc6521cc719cebaa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"27e586f9-661f-4196-8f4c-6a7c2c81c7a4"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"a9fa039c-fb3b-46f6-aee5-5d78e0018ce7"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/{rid}/reservations/{reservationId}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Sun, 08 Jun 2025 21:50:15 GMT"},{"key":"Content-Length","value":"157"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=DEB77D133D433A987AD21C15F197330E~YAAQjXLMF4YqbDuXAQAAK9iFURxmWeImptwEyGXE3l7nyBVFcZ9VjeDw1S7oV8qRo6eWrxczEQ28+jDHJ7OgyeoyTTMfrSwO2QEyUNbYN+NaWvhYZr+Yl3SvTl5/z36/uf38ivPlRkvxVVrdCxGV9nIrpOmer5bmmqE1gBjHdP9DvDdBtxFGKXuXiAp3QHIfb4E68YNlmClaIgdWiX1oCTIIcOPfTEencX65Cszp5J8VI/bs+CNNBG4Thtu6r2Kfm9kYVA==~1; Domain=.opentable.com; Path=/; Expires=Sun, 08 Jun 2025 23:36:01 GMT; Max-Age=6346; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"confirmation_number\": 2592,\n \"reservation_id\": \"6841dffddc6521cc719cebaa\",\n \"date_time\": \"2025-07-29T12:45\",\n \"party_size\": 2,\n \"special_request\": \"Birthday celebration\"\n}"}],"_postman_id":"7977ec45-1f90-4376-820d-1800082f7024"}],"id":"ec9dfb1a-17eb-42bf-8a79-ec61b543b91c","description":"
Booking – Change
\nOverview
\nThe Change API allows partners to modify an existing reservation by updating fields such as date/time, party size, or special requests. However, OpenTable cannot guarantee the success of the modification due to various constraints (e.g., restaurant closure, slot unavailability, or policy changes).
\nTo ensure a seamless user experience, it is strongly recommended to check availability for the requested changes prior to invoking this endpoint. In most flows, a search or lookup call should precede a change request.
\n
Endpoint
\nMethod: PUT
URL: /booking/{rid}/reservations/{id}
\n
Path Parameters
\n\n
Request Body Parameters
\n\n
Cancellation Policy Transitions
\nUpdating a reservation may involve a change in the cancellation policy, which can impact whether the update is allowed automatically. Some transitions are permitted by OpenTable; others require manual intervention and will return an error.
\nWhen a transition is not automatically supported, the API will return a 403 Forbidden response with error code RedirectToHost, indicating that human intervention (e.g., contact with the restaurant) is required.
\n
Response Structure
\n\n
Error Handling
\n\n
Common Errors
\n","_postman_id":"ec9dfb1a-17eb-42bf-8a79-ec61b543b91c"}],"id":"ca3db9c1-2857-4fbb-a4c6-f5776d8f91cd","_postman_id":"ca3db9c1-2857-4fbb-a4c6-f5776d8f91cd","description":""},{"name":"FAQs","item":[],"id":"8a0838db-64a6-41a2-9b0a-82d0486af37d","description":"Does a reservation booked online show in the Booking Lookup Endpoint?
\nYes, all future, active reservations, regardless of booking method, will be returned. Past or cancelled reservations will not be included.
\nIs it possible to change or cancel reservations returned in the Booking Lookup Endpoint?
\nThe system returns all future reservations, but does not differentiate between updatable and cancellable reservations in the response. OpenTable retrieves all reservations associated with the provided phone number for the specified date (00:00-23:59). Partners are responsible for accurately identifying the specific reservation the diner is referencing.
\nNote: Experience reservations are not cancellable or changeable by the APIs.
\nWhy is the API not returning availability when it is visible online?
\nRestaurants have the option to segment their inventory into categories such as “All Availability,” “Online Reservations,” “In-House Reservations,” or “Walk-In.” Ensure restaurant settings align with desired availability displays.
\nShould the experience_id always be sent?
\nThe experience_id should only be sent if the diner is specifically booking an experience. Otherwise, it should be omitted.
\nWhat occurs if cancellation is attempted after the cancellation window?
\nThe booking will not be cancelled, and a 403 RedirectToHost error will be returned.
\nIs pricing handled uniformly across all bookings?
\nNo, pricing varies. Standard bookings may involve only a card hold. Experiences may require prepaid or deposit charges.
\nWhat details should be communicated to the diner when booking a reservation?
\nFor Experiences: Communicate the experience name, description, and pricing (total or per guest). For all reservations: Communicate cancellation and refund policies.
\nWhat’s the difference between deposit and prepaid?
\nSummary Table: Experience vs. Standard Bookings
\nHow does a restaurant capture credit card details? For certain reservations, credit card details are mandatory.
\nOpenTable provides a secure method for acquiring these details and manages all necessary credit card processing. A link will be provided to the guest to enter their card information and remit the deposit.
\nHow do restaurants check the status of credit card deposits and payments?
\nRestaurants use the reservation listing in the Front of House system to see deposit status and balances, and can generate a Reservation Report to review credit card status for many reservations, using the Payment Details column to filter by Prepayment Method, Status, and Paid Total.
\nHow are reservations booked via the API distinguished from standard phone interactions?
\nAPI-originated reservations are identified with an \"phone/in-housed\" tag in reservation history details. The Reservation Report displays \"phone/in-house\" as the booking source for API reservations, as opposed to \"Phone/In-House\" for standard bookings.
\n","_postman_id":"8a0838db-64a6-41a2-9b0a-82d0486af37d"},{"name":"Use Cases","item":[{"name":"In-House Booking API Use Case - Standard Reservation","item":[{"name":"Availability","id":"d448c781-9f53-4a9f-bbbd-2419756c61d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{base-url}}/inhouse/v1/availability/{{rid4}}?party_size={{party_size}}&start_date_time={{start_date_time}}&forward_minutes={{minutes}}&backward_minutes={{minutes}}&include_experiences={{true_false}}","description":"\n","urlObject":{"path":["inhouse","v1","availability","{{rid4}}"],"host":["{{base-url}}"],"query":[{"key":"party_size","value":"{{party_size}}"},{"key":"start_date_time","value":"{{start_date_time}}"},{"key":"forward_minutes","value":"{{minutes}}"},{"key":"backward_minutes","value":"{{minutes}}"},{"key":"include_experiences","value":"{{true_false}}"}],"variable":[]}},"response":[{"id":"3d977348-ea11-48e7-8825-821e4dfdee11","name":"200","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://platform.opentable.com/inhouse/v1/availability/1038007?party_size=2&start_date_time=2025-07-28T13:00&forward_minutes=15&backward_minutes=15&include_experiences=true","protocol":"https","host":["platform","opentable","com"],"path":["inhouse","v1","availability","1038007"],"query":[{"key":"party_size","value":"2"},{"key":"start_date_time","value":"2025-07-28T13:00"},{"key":"forward_minutes","value":"15"},{"key":"backward_minutes","value":"15"},{"key":"include_experiences","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"3fbf5a39-4f60-4831-97e3-7dab461790f3"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"6b58e986-e618-4ee8-86f5-e6dbb65c1f94"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/availability/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 18:14:38 GMT"},{"key":"Content-Length","value":"324"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQSXQyF4XwZy+XAQAAb15NQRzJzELvqIEK1SScITAKraItPQdCM10BMwtB5+mD2NtLQf9AhJarXVi8L2qNLmx/tFWTJvy6d4WaMIpz8aYbX5q+KUVk5Cgg9Tu9dkWlBy0Yh6lmm0wV9gNsgUHeQyJ/4DNN0Dp89wDbIOcUiUoZaI96OFSKyKtuWdbW39gajY2/JtbLYJCs2Zx0rYXJ/9mspoBAn8BVv5kor0g7uZLd0dDs7KMVvyOWtjyt+V/JVdh1VQ==~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=2401; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"rid\": 1038007,\n \"party_size\": 2,\n \"restaurant_settings\": {\n \"scc_enabled\": true\n },\n \"times\": [\n \"2025-07-28T12:45\",\n \"2025-07-28T13:00\",\n \"2025-07-28T13:15\"\n ],\n \"times_available\": [\n {\n \"time\": \"2025-07-28T12:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-07-28T13:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-07-28T13:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"d448c781-9f53-4a9f-bbbd-2419756c61d8"},{"name":"Slot Lock","id":"a1343fa3-2d66-4289-b583-97d1a3ff52b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"restaurant_id\": {{rid4}},\n \"party_size\": 2,\n \"date_time\": \"2025-07-28T12:45\",\n \"table_type\": \"default\",\n \"dining_area_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/inhouse/v1/booking/{{rid4}}/locks","urlObject":{"path":["inhouse","v1","booking","{{rid4}}","locks"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"3fe3344e-8010-4a2f-9fcd-cbd3ba0a5743","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"restaurant_id\": 1038007,\n \"party_size\": 2,\n \"date_time\": \"2025-07-28T12:45\",\n \"table_type\": \"default\",\n \"dining_area_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.opentable.com/inhouse/v1/booking/1038007/locks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"6170d56a-5ddd-43ff-a2bd-52d178799fb7"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"f15df2b9-67a7-45ef-b305-e8bc08f6ddfd"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/{rid}/locks"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 18:16:34 GMT"},{"key":"Content-Length","value":"229"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQSXQyF78WaC+XAQAAsiBPQRzMqV54qLWVZHeugIN4t7s9K2HZdSUjX+a9IvVB8zbmegCPS3fHgHrkCqW9gqlAV8Q8yaBWUIAo2dZJj8ySmC/CUlUUSKUo12GMPVZL5dyiy9ocmZN/twTHZvjm86KAv+6TnwVx7nDM6Ripc5Al723XjVloaz73m/hlmTgYntuH+BgaieGkrWSXbio0x3zrT0oUwlvmNTIFhZ0vbVi2QqDa4Qs5eeKxJwoug5Ta5GLkpw==~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=2285; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"expires_at\": \"2025-06-05T18:21\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0NDYwNTc4NDR8MnwyMDI1LTA3LTI4VDEyOjQ1fDEwMzgwMDcifQ.7Ej6x8wkOqZFsrq09M0YX7FbmohWbrrKwTj00hcHMlaRqxfnOZHa8fLrtoKvbfFtJeyEmi4LAZtOuZfjnA3ohw\"\n}"}],"_postman_id":"a1343fa3-2d66-4289-b583-97d1a3ff52b0"},{"name":"Make Reservation","id":"003cd795-a90a-42ae-8a01-cb03a00610b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n \"first_name\": \"Han\",\n \"last_name\": \"Solo\",\n \"phone\": {\n \"number\": \"4155555555\",\n \"country_code\": 1\n },\n \"restaurant_id\": \"1038007\",\n \"special_request\": \"Date night\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0NDYwNTc4NDR8MnwyMDI1LTA3LTI4VDEyOjQ1fDEwMzgwMDcifQ.7Ej6x8wkOqZFsrq09M0YX7FbmohWbrrKwTj00hcHMlaRqxfnOZHa8fLrtoKvbfFtJeyEmi4LAZtOuZfjnA3ohw\",\n \"sms_notifications_opt_in\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/inhouse/v1/booking/{{rid4}}/reservations","urlObject":{"path":["inhouse","v1","booking","{{rid4}}","reservations"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"3afb964b-e6e9-45ed-9d83-e77d032511a6","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n \"first_name\": \"Han\",\n \"last_name\": \"Solo\",\n \"phone\": {\n \"number\": \"4153444200\",\n \"country_code\": 1\n },\n \"restaurant_id\": \"1038007\",\n \"special_request\": \"Date night\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0NDYwNTc4NDR8MnwyMDI1LTA3LTI4VDEyOjQ1fDEwMzgwMDcifQ.7Ej6x8wkOqZFsrq09M0YX7FbmohWbrrKwTj00hcHMlaRqxfnOZHa8fLrtoKvbfFtJeyEmi4LAZtOuZfjnA3ohw\",\n \"sms_notifications_opt_in\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.opentable.com/inhouse/v1/booking/1038007/reservations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"c1c69000-3a2f-4b23-9cb9-a8c2993923ec"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"73353440-2483-411a-886d-cd5979f84dd4"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/{rid}/reservations"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 18:20:45 GMT"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQTKvWF9gqxDyXAQAAkvZSQRz3brJXg+b/XNmm8C0kvCgula3l/8F7tdZg8C6W4nwNtdgKfpXm9+j8hKzGI7smw9jslT8EHnvYTEC0BOh2KnJzg95cN9X1qTuPS3EIrimEbeuKIQJtrutO1dCKbmvBFQDD2Prowvj9/S4iAD4mv2N4b5mKrSwFEZRUJb3K+y5cYEtRCtq+46vPJIsw8pI8z/MFbujjU4dTlJsLYUxL5vFwKcy3NJuc+Jdpr5pELG3igw==~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=2034; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"confirmation_number\": 2592,\n \"reservation_id\": \"6841dffddc6521cc719cebaa\",\n \"date_time\": \"2025-07-28T12:45\",\n \"party_size\": 2,\n \"special_request\": \"Date night\"\n}"}],"_postman_id":"003cd795-a90a-42ae-8a01-cb03a00610b8"}],"id":"d3865ad5-d724-4ffb-a718-5d92ed5d9275","description":"
As a diner, I would like to make a reservation via the phone. The reservation does not have any applicable credit card restrictions or holds.
\nAPIs to use:
\nIn House Booking API:
\n- \n
Availability APIs (Search)
\n \nSlot Lock
\n \nMake Reservation
\n \n
\n","urlObject":{"path":["inhouse","v1","availability","{{rid4}}"],"host":["{{base-url}}"],"query":[{"key":"party_size","value":"{{party_size}}"},{"key":"start_date_time","value":"{{start_date_time}}"},{"key":"forward_minutes","value":"{{minutes}}"},{"key":"backward_minutes","value":"{{minutes}}"},{"key":"include_experiences","value":"{{true_false}}"}],"variable":[]}},"response":[{"id":"8e986634-48bd-4a8f-9bf4-4fb2465caefc","name":"200","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://platform.opentable.com/inhouse/v1/availability/1038007?party_size=2&start_date_time=2025-07-28T13:00&forward_minutes=15&backward_minutes=15&include_experiences=true","protocol":"https","host":["platform","opentable","com"],"path":["inhouse","v1","availability","1038007"],"query":[{"key":"party_size","value":"2"},{"key":"start_date_time","value":"2025-07-28T13:00"},{"key":"forward_minutes","value":"15"},{"key":"backward_minutes","value":"15"},{"key":"include_experiences","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"3fbf5a39-4f60-4831-97e3-7dab461790f3"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"6b58e986-e618-4ee8-86f5-e6dbb65c1f94"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/availability/{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 18:14:38 GMT"},{"key":"Content-Length","value":"324"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQSXQyF4XwZy+XAQAAb15NQRzJzELvqIEK1SScITAKraItPQdCM10BMwtB5+mD2NtLQf9AhJarXVi8L2qNLmx/tFWTJvy6d4WaMIpz8aYbX5q+KUVk5Cgg9Tu9dkWlBy0Yh6lmm0wV9gNsgUHeQyJ/4DNN0Dp89wDbIOcUiUoZaI96OFSKyKtuWdbW39gajY2/JtbLYJCs2Zx0rYXJ/9mspoBAn8BVv5kor0g7uZLd0dDs7KMVvyOWtjyt+V/JVdh1VQ==~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=2401; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"rid\": 1038007,\n \"party_size\": 2,\n \"restaurant_settings\": {\n \"scc_enabled\": true\n },\n \"times\": [\n \"2025-07-28T12:45\",\n \"2025-07-28T13:00\",\n \"2025-07-28T13:15\"\n ],\n \"times_available\": [\n {\n \"time\": \"2025-07-28T12:45\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-07-28T13:00\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n },\n {\n \"time\": \"2025-07-28T13:15\",\n \"availability_types\": [\n {\n \"type\": \"Standard\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\",\n \"outdoor\"\n ]\n }\n ]\n },\n {\n \"type\": \"Experience\",\n \"diningArea\": [\n {\n \"id\": 1,\n \"table_type\": [\n \"default\"\n ],\n \"experience_ids\": [\n 480995\n ]\n },\n {\n \"id\": 1,\n \"table_type\": [\n \"outdoor\"\n ],\n \"experience_ids\": [\n 480995\n ]\n }\n ],\n \"experienceCancellationPolicy\": [\n {\n \"experienceId\": 480995,\n \"type\": \"Hold\",\n \"id\": \"681a0cc3731b95b6c4dd1aa1:v1\"\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"b0fc0397-ccb8-45ba-8f23-5f850d038796"},{"name":"Slot Lock","id":"cfc0269b-f50f-493c-bde0-f0005f7f0f66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"restaurant_id\": {{rid4}},\n \"party_size\": 2,\n \"date_time\": \"2025-07-28T12:45\",\n \"table_type\": \"default\",\n \"dining_area_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/inhouse/v1/booking/{{rid4}}/locks","urlObject":{"path":["inhouse","v1","booking","{{rid4}}","locks"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"49830b49-29f7-4aa6-b879-fcfa5aa1e0cc","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"restaurant_id\": 1038007,\n \"party_size\": 2,\n \"date_time\": \"2025-07-28T12:45\",\n \"table_type\": \"default\",\n \"dining_area_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.opentable.com/inhouse/v1/booking/1038007/locks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"6170d56a-5ddd-43ff-a2bd-52d178799fb7"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"f15df2b9-67a7-45ef-b305-e8bc08f6ddfd"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/{rid}/locks"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 18:16:34 GMT"},{"key":"Content-Length","value":"229"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQSXQyF78WaC+XAQAAsiBPQRzMqV54qLWVZHeugIN4t7s9K2HZdSUjX+a9IvVB8zbmegCPS3fHgHrkCqW9gqlAV8Q8yaBWUIAo2dZJj8ySmC/CUlUUSKUo12GMPVZL5dyiy9ocmZN/twTHZvjm86KAv+6TnwVx7nDM6Ripc5Al723XjVloaz73m/hlmTgYntuH+BgaieGkrWSXbio0x3zrT0oUwlvmNTIFhZ0vbVi2QqDa4Qs5eeKxJwoug5Ta5GLkpw==~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=2285; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"expires_at\": \"2025-06-05T18:21\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0NDYwNTc4NDR8MnwyMDI1LTA3LTI4VDEyOjQ1fDEwMzgwMDcifQ.7Ej6x8wkOqZFsrq09M0YX7FbmohWbrrKwTj00hcHMlaRqxfnOZHa8fLrtoKvbfFtJeyEmi4LAZtOuZfjnA3ohw\"\n}"}],"_postman_id":"cfc0269b-f50f-493c-bde0-f0005f7f0f66"},{"name":"Make Reservation","id":"72f3c75d-de20-4b91-a95f-9a7338f870b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n \"first_name\": \"Han\",\n \"last_name\": \"Solo\",\n \"phone\": {\n \"number\": \"4155555555\",\n \"country_code\": 1\n },\n \"restaurant_id\": \"1038007\",\n \"special_request\": \"Date night\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0NDYwNTc4NDR8MnwyMDI1LTA3LTI4VDEyOjQ1fDEwMzgwMDcifQ.7Ej6x8wkOqZFsrq09M0YX7FbmohWbrrKwTj00hcHMlaRqxfnOZHa8fLrtoKvbfFtJeyEmi4LAZtOuZfjnA3ohw\",\n \"sms_notifications_opt_in\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/inhouse/v1/booking/{{rid4}}/reservations","urlObject":{"path":["inhouse","v1","booking","{{rid4}}","reservations"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"81fba3f5-79eb-42f8-9aea-f7b9861090a6","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n \"first_name\": \"Han\",\n \"last_name\": \"Solo\",\n \"phone\": {\n \"number\": \"4153444200\",\n \"country_code\": 1\n },\n \"restaurant_id\": \"1038007\",\n \"special_request\": \"Date night\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0NDYwNTc4NDR8MnwyMDI1LTA3LTI4VDEyOjQ1fDEwMzgwMDcifQ.7Ej6x8wkOqZFsrq09M0YX7FbmohWbrrKwTj00hcHMlaRqxfnOZHa8fLrtoKvbfFtJeyEmi4LAZtOuZfjnA3ohw\",\n \"sms_notifications_opt_in\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.opentable.com/inhouse/v1/booking/1038007/reservations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"c1c69000-3a2f-4b23-9cb9-a8c2993923ec"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"1D9E2108-2191-4176-B6BF-A6F651D643C8"},{"key":"OT-SessionID","value":"73353440-2483-411a-886d-cd5979f84dd4"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"partnerfeeds"},{"key":"X-OT-UriTemplate","value":"/partnerfeeds/inhouse/v1/booking/{rid}/reservations"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 05 Jun 2025 18:20:45 GMT"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=F4EC3569D5235DFAC0139CF3428A35BA~YAAQTKvWF9gqxDyXAQAAkvZSQRz3brJXg+b/XNmm8C0kvCgula3l/8F7tdZg8C6W4nwNtdgKfpXm9+j8hKzGI7smw9jslT8EHnvYTEC0BOh2KnJzg95cN9X1qTuPS3EIrimEbeuKIQJtrutO1dCKbmvBFQDD2Prowvj9/S4iAD4mv2N4b5mKrSwFEZRUJb3K+y5cYEtRCtq+46vPJIsw8pI8z/MFbujjU4dTlJsLYUxL5vFwKcy3NJuc+Jdpr5pELG3igw==~1; Domain=.opentable.com; Path=/; Expires=Thu, 05 Jun 2025 18:54:39 GMT; Max-Age=2034; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"confirmation_number\": 2592,\n \"reservation_id\": \"6841dffddc6521cc719cebaa\",\n \"date_time\": \"2025-07-28T12:45\",\n \"party_size\": 2,\n \"special_request\": \"Date night\"\n}"}],"_postman_id":"72f3c75d-de20-4b91-a95f-9a7338f870b3"}],"id":"c185d08b-14ba-402d-a177-cb3a9ccea182","description":"
As a diner, I would like to make a reservation via the phone. The reservation has a credit card hold required.
\nAPIs to use:
\nIn House Booking API:
\n- \n
Availability APIs (Search)
\n \nSlot Lock
\n \nMake Reservation
\n \n
As a diner, I would like to cancel a reservation via the phone.
\nAPIs to use:
\nIn House Booking API:
\n- \n
Diner Lookup API
\n \nCancellation Endpoint
\n \n
Note: The APIs do not currently support the ability to cancel or change Experience reservations, only Standard Reservations.
\nOverview
\nThe In-House Booking API facilitates the seamless booking of reservations directly into a restaurant's inventory, encompassing both In-House and Online availability. This powerful API is specifically engineered to support a range of reservation management functionalities, particularly for Voice AI driven reservation systems.
\nPrimarily developed to power Voice AI reservation systems, this API is designed for efficiency and integration with advanced conversational interfaces. Its architecture supports automated and real-time interactions, crucial for voice-based booking experiences.
\nPartners are expected to develop solutions for Voice AI, Onboarding and offboard functionality, with the onboarding process for restaurants to opt into your integration being crucial to our partnership. We offer two methods for this: OAuth flow or Unique Identifier flow.
\nPlease note that we require product certification and full onboarding flow for go-live. To view detailed documentation, please visit - docs.opentable.com.
\nDetails and Documentation
\nIn House Booking API (aka Voice Al API): The only APIs you have access to are under In House Booking API (aka Voice Al API) -> APIs
\nHelpful Tips
\n- \n
Search Window: Although not required, the maximum number of minutes forwards and backwards to search for times is 180 +/-, giving you a significant window -- Does your implementation allow for a maximized search window or have you accounted for actively limiting the search results?
\n \nDining Areas: Although not required, Dining Areas are part of over 90% of our current restaurant base
\n \nSMS opt-in: Ensuring diner SMS opt-in is essential for successful reservation communications, including confirmations and credit card details. Capture this information as part of the required diner details.
\n \nReservations/Experiences that require deposit or CC hold: make sure to inform the diner about the amount and for deposit reservations and CC details are required for hold reservations before the reservation is made. OpenTable must send these transactional SMS
\n \nExperiences: Make sure your LLM can handle the following experiences IDs (pre prod) for RID
\n1040230- The experiences are the same production but with a different ID:- \n
\n518093: This experience has multiplepriceTitles(these titles can be anything) and mandatory tips.priceId, 129261 haspriceAllInclusive=false. Meaning that it has taxes and service which affects the total price \n
\n129260: This experience is per party, the request body is slighty different. \n
\n518092: The name isBreakfast - Pay at the restaurantmake sure your LLM is not relying on the name to inform the diner that they must pay at the restaurant. (use thepricearray) \n
\n518091: Experiences with no policy inherits the restaurant level/default policy only when the policy is“hold”. Make your LLM can handle it on Mondays where there is no policy and Friday to Sunday where there’s a“hold”policy. \n
\n
Testing Environment
\nBelow are some Test Restaurant ID’s (RIDs) that you can use for API. These are meant to be used for Pre-Production testing only. We have also included some nuances around availability and requirements for each. This should help you test numerous scenarios.
\nNote we consider the following days “Special Days”:
\n- \n
Thanksgiving Day (US Observance date)
\n \nChristmas Eve
\n \nChristmas Day
\n \nNew Year's Day
\n \nMemorial Day
\n \nIndependence Day
\n \nLabor Day
\n \n
RID : 264001
\n- \n
Party Size: 1-20
\n \nShift: 6AM-2AM, Sun-Sat
\n \nSpecial Days closed
\n \n
RID 1040230: With Credit Card Requirements and Experiences
\n- \n
Party Size: 1-20
\n \nReservations:
\n- \n
Monday: standard
\n \nTues to Thur: deposit | party size > 2
\n \nFri to Sun: credit card hold | party size > 2
\n \nExperiences: everyday 6am-12am
\n \nShifts: 6AM-12PM, 1PM-5PM, 6PM-11.30PM.
\n \n
\n
RID 268549:
\n- \n
Party Size: 1-10
\n \nShifts: 7AM-6PM, 8PM-12AM, Sun-Sat
\n \nSpecial Days closed
\n \n
RID 138712:
\n- \n
Party Size: 1-6
\n \nShifts: 8AM-2AM, Sun & Sat only
\n \nSpecial Days closed
\n \n
Certification Process
\nOpenTable will need to review and approve your pre-production implementation of the API prior to granting production publication. A minimum window of 14 days for OpenTable to review a pre-production submission is required. We use RID 1040230 for our testing, so please provide a phone number for us to call.
\nAn account to your platform will be useful to test the onboarding flow and to point you to the right transcripts in case any errors during the certification.
\nRequirements:
\nScenarios and Validation:
\nAvailability Search
\n- \n
Confirm the partner can call /availability with various party sizes and date/times.
\n \nConfirm response includes accurate availability including experience options when requested.
\n \nConfirm response when no availability is present
\n \n
Experience Retrieval
\n- \n
Confirm partners can successfully retrieve /experiences for a restaurant.
\n \nValidate correct explanation of price types, prepaid flags, and cancellation policies.
\n \n
Reservation Creation
\n- \n
Test creating standard bookings without experience fields.
\n \nTest creating experience bookings with valid experience_id and correct price.
\n \nConfirm booking with prepaid and deposit logic behaves as expected.
\n \n
Reservation Modification
\n- \n
Test modifying standard bookings with date/time/party size/special request updates.
\n \nTest modifying experience bookings, including changes triggering RedirectToHost.
\n \nConfirm changes fail if reservation is in the past.
\n \n
Reservation Cancellation
\n- \n
Test cancellation of standard bookings with no policies – expect success (204).
\n \nTest cancellation of bookings with CC holds or deposits within and outside cancellation windows – confirm correct RedirectToHost errors where applicable.
\n \n
Additional Validation
\n- \n
Verify Lookup API behavior when multiple reservations in the future are present
\n \nVerify correct attribution of reservations to partner ID
\n \n
Support
\nOpenTable is committed to ensuring that we have a successful partnership, during all phases of the partnership. Please ensure to go through the FAQs and Known Limitations before asking any questions
\n- \n
Partnership Questions: Questions about the contract and general partnership terms, including marketing opportunities, contact your Partnership Manager
\n \nIntegration Onboarding Help: OpenTables shares a document that is accessible by partners. Questions will be answered as soon as possible, but usually take 3-5 business days.
\n \nOngoing Support (post Go-Live): For any technical support post implementation. Please email api@opentable.com Emails will automatically create a ticket in our support queue. Questions will be answered as soon as possible, but usually take 3-5 business days.
\n \nOutages and Maintenance Windows: Please visit and subscribe to alerts on our status website. status-api.opentable.com
\n \n
Overview:
\nThe In-House Booking API facilitates the seamless booking of reservations directly into a restaurant's inventory, encompassing both In-House and Online availability. This powerful API is specifically engineered to support a range of reservation management functionalities, particularly for Voice AI driven reservation systems.
\nThis API also allows partners to book 2 types of reservations: Standard reservations and/or Experiences reservations.
\nPrimarily developed to power Voice AI reservation systems, this API is designed for efficiency and integration with advanced conversational interfaces. Its architecture supports automated and real-time interactions, crucial for voice-based booking experiences.
\nKey Endpoints and Functionality:
\n- \n
Availability Search (Standard or Experiences): Allows for querying the restaurant's availability based on specific criteria, enabling users or systems to check for suitable reservation slots.
\n \nGet Experiences (Experiences only): Provides the capability to retrieve information about special dining experiences offered by the restaurant, potentially including events, tasting menus, or themed dinners.
\n \nCreate Reservation (Standard or Experience): Supports the creation of new reservations, whether standard dining bookings or reservations for special experiences. This endpoint is critical for registering new customers and securing their dining arrangements.
\n \nModify Reservation (Standard Only): Enables users or systems to alter existing reservation details, such as time, party size, or special requests, providing flexibility and accommodating changing plans.
\n \nCancel Reservation (Standard Only): Allows for the cancellation of previously made reservations, ensuring inventory is accurately updated and available slots are released for other bookings.
\n \n
Eligibility and Technical Requirements
\nThis Integration is available only to approved partners that have signed the applicable paperwork and agreed to the terms and conditions. Also note before a Voice AI partner is approved, there will be a Quality Assurance process to ensure the integration is successful.
\nKnown limitations
\n- \n
Voice AI cannot pass the 2% OpenTable service charge on to guests.
\n \nA diner profile is created and identified based on phone number, first and last name.
\n \nIf there are more than 10 guests linked to the same phone number and there are more than 10 active resersation, Lookup API will return 10 random reservations (tends to be the earliest reservations)
\n \nBlocking availability only works for online reservations, for in-house, the shift must be edited under \"Availability Planning\" and remove in-house or create a \"Special Day\" in Availability planning, then edit shift settings on that special day, then go to each table type and make that table type \"walk-in\" only. (Yes, this is more manual so make sure that you as the partner let your customers know this) For more information, go to -> https://support.opentable.com/
\n \nIf the customer is running, this cannot updated through this API
\n \nAll reservations show as
\nmodifiable\nRequires a mobile number capable of receiving SMS. Landline numbers are not supported.
\n \nTicketed experiences are not supported
\n \nFor credit card holds or deposits, if
\n\"sms_notifications_opt_in: false\"the reservation gets booked but the diner doesn't get a link to enter the credit card information \nExperiences cannot be cancelled or modified through this API
\n \n
OpenTable provides two distinct Application Programming Interfaces (APIs) for the purpose of reserving tables within OpenTable for Restaurants, its table management software.
\nThe Online Booking API, also referred to as Consumer API, facilitates online reservation processing, contingent upon user acceptance of OpenTable's terms and conditions within a visually accessible interface. Conversely, the In-House Booking API, alternatively known as the Voice AI API, is specifically designed for environments lacking a visual interface, such as voice-activated systems. Although both APIs ultimately accomplish the same objective—the successful creation of a reservation—they differ significantly in methodology, functionality, and intended application.
\nIt is imperative to acknowledge that the utilization of the Voice AI API for online reservations and the Consumer API for voice reservations is strictly prohibited and constitutes a violation of OpenTable's terms of service. Please work with the business development teams for access to and contracting for each of the APIs.
\n","_postman_id":"9157e3fb-fc94-4dfc-8b39-0160e955cc65"},{"name":"CRM APIs","item":[{"name":"APIs","item":[{"name":"Loyalty Programs","item":[{"name":"CRM V3 Loyalties","id":"88f58a48-4ea9-4c96-a035-ed7eb144c50e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"loyalties\": [\r\n {\r\n \"accountId\": \"Diner Loyalty Program ID\",\r\n \"programName\": \"OpenTable Loyalty\",\r\n \"loyaltyTier\": \"Diamond\",\r\n \"pointsBalance\": \"2100\",\r\n \"flexFields\": [\r\n {\r\n \"label\": \"Favorite Meal\",\r\n \"value\": \"Jalapeno & Tomato Pizza\"\r\n },\r\n {\r\n \"label\": \"Benefits\",\r\n \"value\": \"VIP\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/loyalties","description":"CRM v3 - Loyalty API Documentation
\nOverview
\nThe Loyalty API enables external partners to manage guest loyalty information within the OpenTable ecosystem. This API allows for adding, managing guest loyalty program data to enhance guest experiences and personalize services.
\n\n
Endpoints: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/loyalties
Purpose
\nRetrieve the loyalty details for a specific guest in a restaurant.
\nResponse Body
\n\n
Managing Loyalty Data
\nPOST: Add or Append Loyalty Data
\nURL: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/loyalties
Purpose
\nAdd new loyalty data or append additional loyalty programs to an existing resource.
\nRequest Body
\n\n
PUT: Update Loyalty Data
\n{{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/loyalties
Purpose
\nUpdate an existing loyalty resource by replacing the entire object. Use this method for deletions as well by omitting fields you wish to remove.
\nRequest Body
\nThe structure is identical to the POST method.
\n\n
Deleting Data
\nTo delete specific loyalty data, use the PUT method with an updated object that excludes the items you wish to delete. Partial deletions are not supported; you must submit the complete object.
\n\n","urlObject":{"path":["api","v3","external","partners","{{partner-id}}","restaurants","{{rid}}","guests","{{guest-id}}","loyalties"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"098be3cd-8512-4081-9dbc-658fc106e2f3","name":"200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"loyalties\": [\r\n {\r\n \"accountId\": \"Diner Loyalty Program ID\",\r\n \"programName\": \"OpenTable Loyalty\",\r\n \"loyaltyTier\": \"Diamond\",\r\n \"pointsBalance\": \"2100\",\r\n \"flexFields\": [\r\n {\r\n \"label\": \"Favorite Meal\",\r\n \"value\": \"Jalapeno & Tomato Pizza\"\r\n },\r\n {\r\n \"label\": \"Benefits\",\r\n \"value\": \"VIP\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/loyalties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"c3567e90-9c6f-4d6c-a878-0ff4ded80ce7"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"419"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/loyalties"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 20 Dec 2024 18:59:29 GMT"},{"key":"Content-Length","value":"201"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"loyalties\": [\n {\n \"programName\": \"OpenTable Loyalty\",\n \"loyaltyTier\": \"Diamond\",\n \"pointsBalance\": \"2100\",\n \"accountId\": \"Diner Loyalty Program ID\",\n \"flexFields\": [\n {\n \"label\": \"Favorite Meal\",\n \"value\": \"Jalapeno & Tomato Pizza\"\n },\n {\n \"label\": \"Benefits\",\n \"value\": \"VIP\"\n }\n ]\n }\n ]\n}"},{"id":"cb433365-061f-4d74-8e53-97f336dae83e","name":"401","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"loyalties\": [\r\n {\r\n \"accountId\": \"Test ID-3b97d36d-e93c-41e3-8442-12c0cb632b99\",\r\n \"programName\": \"OpenTable Loyalty\",\r\n \"loyaltyTier\": \"Gem\",\r\n \"pointsBalance\": \"2100\",\r\n \"flexFields\": [\r\n {\r\n \"label\": \"Favorite Meal\",\r\n \"value\": \"Jalapeno & Tomato Pizza\"\r\n },\r\n {\r\n \"label\": \"Benefits\",\r\n \"value\": \"VIP\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/loyalties"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"74ac7097-e37c-4ff2-9b32-bbe9abb082a6"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"BAABB029-248E-48E9-B8DA-E35FB5F257B7"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/loyalties"},{"key":"x-envoy-upstream-service-time","value":"24"},{"key":"Content-Length","value":"311"},{"key":"Date","value":"Tue, 29 Oct 2024 06:28:27 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-29T06:28:27.098+0000\",\n \"path\": \"/gateway/proxies/restaurantpartnerapigateway/partnerGuestDataService/api/v3/external/partners/5850/restaurants/188878/guests/96c1ca88-a5f5-4949-9474-8a9922925a4b/loyalties\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Not authorized\",\n \"requestId\": \"7aeca0ca\"\n}"}],"_postman_id":"88f58a48-4ea9-4c96-a035-ed7eb144c50e"}],"id":"9a98a0de-1c74-4ebc-8ba9-15b6aa476d4b","description":"
Description
\nOverview
\nThis endpoint will allow developers to expose information about diner's loyalty program participation to the OpenTable for Restaurants table management software. These details will show in the Guestbook, Reso Card, Chit and the Owner’s App.
\nHow will this impact restaurants?
\nInformation about the diner’s loyalty program and status will show in the diner card, allowing for additional insight.
\nTag Management API Documentation
\nOverview
\nThe Tag Management API enables external partners to manage guest tags within the OpenTable system. This API allows for the creation, updating, and management of custom tags that can be associated with specific guests, providing flexibility and customization for restaurants to enhance guest relationships and experiences.
\n\n
Endpoint
\nURL
\nPUT: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{restaurantId}/tags/{tagId}
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body must be in JSON format and contain the following fields:
\n\n
Response Details
\nResponse Format
\nThe response is returned in JSON format and confirms the successful creation or update of the tag.
\nResponse Fields
\n\n
Error Codes
\n\n
Notes
\n- \n
Ensure that the
\npartnerId,restaurantId, andtagIdare valid and correspond to existing records in the OpenTable system. \nUse meaningful
\ndisplayNameandcategoryvalues to streamline guest classification and management. \nIf a guest profile is merged and there is an attempt to update the secondary
\nguestId, a 409 conflict error will occur. The error will return theprimaryGuestIdof the merged guest profile. ThisguestIdwhich should be stored as the primaryguestIdfor all future updates. \n
Tag Listing API Documentation
\nOverview
\nThe Tag Listing API allows external partners to retrieve a list of all tags associated with a specific restaurant. These tags enable restaurants to classify guests based on specific attributes, preferences, or needs, facilitating a more personalized dining experience.
\n\n
Endpoint
\nURL
\nGET: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{restaurantId}/tags
\n
Request Details
\nHeaders
\nPath Parameters
\n\n
Response Details
\nResponse Format
\nThe response is returned in JSON format and contains a list of tags associated with the specified restaurant.
\nResponse Fields
\n\n
Error Codes
\n\n
Notes
\n- \n
Ensure that the
\npartnerIdandrestaurantIdare valid and correspond to existing records in the OpenTable system. \nTags retrieved are specific to the specified restaurant and are not shared across restaurants.
\n \n
Endpoint
\nURL
\nDELETE: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{restaurantId}/tags/{tagId}
\n
Request Details
\nHeaders
\nPath Parameters
\n\n
Error Codes
\n\n
Notes
\n- \n
Ensure that the
\npartnerId,restaurantId, andtagIdare valid and correspond to existing records in the OpenTable system. \nThis endpoint only deletes the specified tag and does not affect other tags or guest data.
\n \n
Endpoint
\nURL
\nPOST: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{restaurantId}/guests/{guestId}/tags
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body must be in JSON format and contain the following field:
\n\n
Response Details
\nResponse Format
\nA successful tag assignment returns a 200 OK status code along with the assigned tags in the response body.
Response Fields
\n\n
Error Codes
\n\n
Notes
\n- \n
Ensure that the
\npartnerId,restaurantId,guestId, andtagsare valid and correspond to existing records in the OpenTable system. \nTags that do not get created via the API will not be assigned.
\n \nIf a guest profile is merged and there is an attempt to update the secondary
\nguestId, a 409 conflict error will occur. The error will return theprimaryGuestIdof the merged guest profile. ThisguestIdwhich should be stored as the primaryguestIdfor all future updates. \n
Description
\nOverview
\nThis endpoint within the CRM API catalog allows for creating Guest Tags and as well as the ability to assign these Guest Tags to guests. The updated guest information records associated with a specific partner's restaurant will have the data exposed within the guest data in the restaurant’s OpenTable table management software.
\nHow will this impact restaurants?
\nThe CRM tag creation will allow for partners to create and add new tags to guest profiles without the limitation of needing a tag to exist with the restaurant’s OpenTable for Restaurants system.
\nTags from CRM API will appear on the guest profile and will not be editable.
\nEndpoints
\nPUT: Update or Add Guest Properties
\nURL: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/properties
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body must be in JSON format and contain the following fields:
\n\n
Response Details
\nResponse Format
\nA successful request returns a 200 OK status code along with the updated properties in the response body.
Response Fields
\n\n
Notes
\n- \n
\n{partnerId},{rid}, and{guestId}are dynamic path parameters.- \n
\npartnerId: Assigned by OpenTable during onboarding. \n
\nrid: Unique identifier for the restaurant, available via OpenTable. \n
\nguestId: Found in the Sync API guest payload; remove the preceding RID from the guest ID. \n
\nTo delete specific property data, submit the full object excluding the items to be removed (partial deletions are not supported).
\n \n
Overview
\nThis API allows for updating guest information records associated with a partner's restaurant. The data is exposed within the guest data in the restaurant’s OpenTable table management software.
\nHow will this impact restaurants?
\nInformation about the diner’s property stay will show in the diner card, allowing for additional insight.
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdydWFjOwg5zcv5m0_3OoIzgoxG4dlA0vVahNOZeAhruvDtGqR9Ha7ovrwXX2-teu8nZWYmKaVDppKyn53KaIqtYcwvxMcM1SwYcmkHLGq5YuJ2qk3wsegv7FntFxVc6QlO0tIzajRcPo1Bw1Xv8jLnKp4?key=tCuggL7VGnyy_zNrj0r2Ag\")
\n\nChange Log
\nThe previous CRM API available was v2. We have also made some slight changes to v3 since we last provided documentation. The following changes have been made since:
\n- \n
New Endpoint URLs
\n \nEnhanced security limiting partners to only certain attributes
\n \nRemoval of the Integrations Object. That information is static and will be kept stored in the OpenTable system. For adjustments to the integration name, please work with OpenTable.
\n \n
These changes were completed in April of 2024.
\n","_postman_id":"0a516ebe-bd9c-4e7d-9808-c3cde273ea94"},{"name":"Guest Creation and ID Retrieval","item":[{"name":"CRM API v3 - Guest Creation","id":"c8df7867-4246-4f9e-ba82-b886cc445306","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Jon\",\r\n \"lastName\": \"Appleseed\",\r\n \"email\": {\r\n \"emailAddress\": \"jon@appleseed.com\",\r\n \"isEmailMarketingOptedIn\": true\r\n },\r\n \"phoneNumbers\": [\r\n {\r\n \"countryCode\": \"1\",\r\n \"number\": \"4150000000\",\r\n \"isPrimary\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests","description":"Create Guest API Documentation
\nEndpoint
\n{base-url}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests
Method
\nPOST
\nPath Parameters
\n- \n
partnerId: A static identifier for the partner assigned by OpenTable after onboarding.
\n \nrid (restaurant id): A unique, static identifier for each restaurant provided by OpenTable.
\n \n
Request Body Attributes
\nPhone Number Object Attributes
\nEmail Object Attributes
\nSuccess and Error Codes
\nNotes
\n- \n
Either
\nphoneNumbersoremailmust be provided. \nIf multiple
\nisPrimary: truevalues are provided in the phone numbers array, only the first one will be retained. \nEnsure your
\npartnerIdandridvalues are correctly assigned by OpenTable during onboarding. \nIf a guest profile is merged and there is an attempt to update the secondary guestId, a 409 conflict error will occur. The error will return the primaryGuestId of the merged guest profile. This guestId which should be stored as the primary guestId for all future updates.
\n \n
Description
\nOverview
\nCustomer Relations Management API is a set of APIs that exposes additional guest and reservation details from other sources.
\nThe APIs will facilitate the addition of details in the diner profile and will leverage the Guest Sync API payload to accurately match and add information to specific guest profiles.
\nThis API allows for updating guest information records associated with a partner's restaurant. The data is exposed within the guest data in the restaurant’s OpenTable table management software.
\nHow will this impact restaurants?
\nThe Guest Creation API allows partners to create guest profiles in the OpenTable for Restaurants platform outside of the reservation making process.
\nBefore guest creation
\nAfter guest creation
\nGuest Matching / Creation Logic
\nWhen the Guest Creation API is called the following logic will be used to match to existing restaurant guest profiles or to create a brand new profile.
\nScenario 1: match
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone A, email A
\nScenario 2: match
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone A, no email
\nScenario 3: match
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, no phone, email A
\nScenario 4: no match, creation of a new guest
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone A, email B
\nScenario 5: no match, creation of a new guest
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone B, email A
\nRate Limit:
\nThe maximum allowable rate of API calls at this endpoint is set at 10 calls per second per partner. Please note that other endpoints may have different requirements or limits.
\nChange Log
\nThese changes were completed in April of 2024.
\n","_postman_id":"6119c2e2-8e40-45e6-9085-db44b0fa38a5"},{"name":"Guest Insights","item":[{"name":"CRM V3 Insights","id":"15f96b05-09df-4ab7-9e6f-d7d2a84a201c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"insights\":[\r\n {\r\n \"label\":\"Average check size\",\r\n \"value\":\"$62\"\r\n },\r\n {\r\n \"label\":\"Customer proximity\",\r\n \"value\":\"0.5 miles\"\r\n },\r\n {\r\n \"label\":\"Customer dining frequency\",\r\n \"value\":\"2 times per week\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/insights","urlObject":{"path":["api","v3","external","partners","{{partner-id}}","restaurants","{{rid}}","guests","{{guest-id}}","insights"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"bbbc1945-eaac-41d4-8cc8-552cca6b8fc2","name":"200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"insights\":[\r\n {\r\n \"label\":\"Average check size\",\r\n \"value\":\"$62\"\r\n },\r\n {\r\n \"label\":\"Customer proximity\",\r\n \"value\":\"0.5 miles\"\r\n },\r\n {\r\n \"label\":\"Customer dining frequency\",\r\n \"value\":\"2 times per week\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/11111/guests/{{guest-id}}/insights"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"09d3baa8-0d01-437e-88aa-39af45b73fd4"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"BAABB029-248E-48E9-B8DA-E35FB5F257B7"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"102"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/insights"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Wed, 30 Oct 2024 05:04:12 GMT"},{"key":"Content-Length","value":"146"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"insights\": [\n {\n \"label\": \"Average check size\",\n \"value\": \"$62\"\n },\n {\n \"label\": \"Customer proximity\",\n \"value\": \"0.5 miles\"\n },\n {\n \"label\": \"Customer dining frequency\",\n \"value\": \"2 times per week\"\n }\n ]\n}"},{"id":"f7569ec0-75ef-4d55-b3c4-c4448ad44b0d","name":"401","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"insights\":[\r\n {\r\n \"label\":\"Average check size\",\r\n \"value\":\"$62\"\r\n },\r\n {\r\n \"label\":\"Customer proximity\",\r\n \"value\":\"0.5 miles\"\r\n },\r\n {\r\n \"label\":\"Customer dining frequency\",\r\n \"value\":\"2 times per week\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/insights"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"b2aeba87-70af-450c-a5e4-e4a9b6f50c6c"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"BAABB029-248E-48E9-B8DA-E35FB5F257B7"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/insights"},{"key":"x-envoy-upstream-service-time","value":"15"},{"key":"Content-Length","value":"310"},{"key":"Date","value":"Tue, 29 Oct 2024 08:59:49 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-29T08:59:49.683+0000\",\n \"path\": \"/gateway/proxies/restaurantpartnerapigateway/partnerGuestDataService/api/v3/external/partners/5850/restaurants/188878/guests/96c1ca88-a5f5-4949-9474-8a9922925a4b/insights\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Not authorized\",\n \"requestId\": \"3f580b0f\"\n}"}],"_postman_id":"15f96b05-09df-4ab7-9e6f-d7d2a84a201c"}],"id":"6cf5b6bd-76c4-4a12-8f04-5518891ddd8d","description":"API Documentation for Updating Guest Insights
\nOverview
\nThis documentation outlines the process for using the PUT API endpoint to update guest insights for a specific restaurant. It includes the request format, headers, and example payload, as well as the expected response structure.
\nEndpoint
\nURL: {base-url}/api/v3/external/partners/{partner_id}/restaurants/{restaurant_id}/guests/{guest_id}/insights
Method: PUT
\nHeaders
\nRequest Parameters
\nPath Parameters:
\n- \n
\npartner_id: The unique identifier of the partner. \n
\nrestaurant_id: The unique identifier of the restaurant. \n
\nguest_id: The unique identifier of the guest. \n
Request Body
\nThe request body must include an array of insights, each with a label and a value.
Fields:
\nResponse
\nFields:
\nNotes
\n- \n
Ensure that the
\nAuthorizationtoken provided is valid and has sufficient permissions. \nAll
\nlabelandvaluepairs should be meaningful and relevant to the guest insights. \nThere is no character limit, but we recomend we keep it as succint as possible
\n \nThere is no limit on the amount of labels.
\n \nIncorrect or missing fields may result in validation errors.
\n \n
Error Handling
\nCommon Errors:
\n","_postman_id":"6cf5b6bd-76c4-4a12-8f04-5518891ddd8d"},{"name":"Guest Photo","item":[{"name":"CRM V3 Upload Photo","id":"e8d71f96-c1a8-483e-8e2a-e357ba078bb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://my-photo-url\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/photos","description":"CRM V3 - Guest Photo Upload API Documentation
\nOverview
\nThe upload of the Guest photos works in asynchronous fashion, meaning that the upload request is acknowledged but the actual upload will happen in the background. The status API will allow partners to monitor the status of the photo.
\n\n
Endpoint
\nURL
\nPUT: {base-url}/api/v3/external/partners/{partner_id}/restaurants/{restaurant_id}/guests/{guest_id}/photos
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body must be in JSON format and contain the following field:
\nResponse Details
\nResponse Format
\nThe response body returned will be empty for a successful photo upoad request.
\nAdditional Notes
\n- \n
Supported photo formats: JPEG, PNG
\n \nMinimum supported size: 512px x 512px
\n \nOne photo per guest (per partner, per rid): uploading a new photo for a guest, will overwrite the previously uploaded one
\n \nEvery new upload request will delete the previously uploaded photo for guest, regardless of the outcome of the upload (more about this below, in the
\nstatustable) \nPartner needs to ensure url is valid for at leat 30 days
\n \n
Guest Photo Delete API Documentation
\nOverview
\nThe deletion of the Guest photos works in asynchronous fashion, meaning that the deletion request is acknowledged but the actual deletion will happen in the background.
\n\n
Endpoint
\nURL
\nDELETE: {base-url}/api/v3/external/partners/{partner_id}/restaurants/{restaurant_id}/guests/{guest_id}/photos
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body for the DELETE call is empty.
\nResponse Format
\nThe response body returned will be empty for a successful photo deletion request.
\n","urlObject":{"path":["api","v3","external","partners","{{partner-id}}","restaurants","{{rid}}","guests","{{guest-id}}","photos"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"70226e1f-b36e-41fc-a985-8b1a38062336","name":"202","originalRequest":{"method":"DELETE","header":[],"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/photos"},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"OT-RequestId","value":"c1a2906f-eb36-47e5-9e2b-d5eb1a5688a7"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"x-envoy-upstream-service-time","value":"346"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/photos"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Fri, 31 Jan 2025 17:08:49 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"54213e36-65b7-4ab4-b94f-00a07908c6b6","name":"401","originalRequest":{"method":"DELETE","header":[],"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/photos"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"OT-RequestId","value":"3985cf7c-a09b-4980-82d1-d23e8a6dda77"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/photos"},{"key":"x-envoy-upstream-service-time","value":"5"},{"key":"Content-Length","value":"322"},{"key":"Date","value":"Mon, 03 Feb 2025 21:51:34 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-02-03T21:51:34.664+0000\",\n \"path\": \"/gateway/proxies/restaurantpartnerapigateway/partnerGuestDataService/api/v3/external/partners/7337/restaurants/1038007/guests/61dd968860ae9a0001c3da34/photos\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing authorization token for request\",\n \"requestId\": \"5f2e004d\"\n}"}],"_postman_id":"8b5baae7-a118-4a81-b231-439b695fd5aa"},{"name":"CRM V3 Photo Status API","id":"fda0faed-52e5-48ae-86f1-e267322cdbf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{pp_oauth}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/photos","description":"Overview
\nThe photo status API allows for the partner to monitor and check the status of a uploaded or deleted photo. This ApI will also return the timestamp of the latest status of the photo.
\nEndpoint
\nURL
\nGET: {base-url}/api/v3/external/partners/{partner_id}/restaurants/{restaurant_id}/guests/{guest_id}/photos
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body for the GET photo status call is empty.
\nResponse Details
\nResponse Format
\nThe response is returned in JSON format and provides the current status of the photo submitted for upload or deletion.
\nResponse Fields
\nStatus Descriptions
\n","urlObject":{"path":["api","v3","external","partners","{{partner-id}}","restaurants","{{rid}}","guests","{{guest-id}}","photos"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"27eaefa6-8293-4fab-ac08-6da4220d35ea","name":"200","originalRequest":{"method":"GET","header":[],"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/photos"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"95c857df-3c2f-4e3f-a99c-ad442af9de51"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"178"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/photos"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 31 Jan 2025 17:22:25 GMT"},{"key":"Content-Length","value":"84"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"APPROVED\",\n \"updatedAt\": \"2025-01-31T17:08:49.168Z\"\n}"},{"id":"2563012c-b709-4e59-a4eb-60707fb1b026","name":"401","originalRequest":{"method":"GET","header":[],"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/photos"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"fff258ec-171c-48c7-a72d-222f8ec277bd"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/photos"},{"key":"x-envoy-upstream-service-time","value":"6"},{"key":"Content-Length","value":"322"},{"key":"Date","value":"Mon, 03 Feb 2025 21:52:34 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-02-03T21:52:34.929+0000\",\n \"path\": \"/gateway/proxies/restaurantpartnerapigateway/partnerGuestDataService/api/v3/external/partners/7337/restaurants/1038007/guests/61dd968860ae9a0001c3da34/photos\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Missing authorization token for request\",\n \"requestId\": \"67df21d6\"\n}"},{"id":"c1f37872-db2b-4626-9c2a-3893fee7eab0","name":"404","originalRequest":{"method":"GET","header":[],"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/photos"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"6625252f-8966-4e31-ae78-0457e032144e"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Cache-Control","value":"must-revalidate,no-cache,no-store"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"122"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/photos"},{"key":"Content-Length","value":"203"},{"key":"Date","value":"Mon, 03 Feb 2025 22:19:29 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-02-03T22:19:29.071+0000\",\n \"status\": 404,\n \"error\": \"Not Found\",\n \"message\": \"Guest not found\",\n \"path\": \"/api/v3/external/partners/7337/restaurants/1038007/guests/61dd968860ae9a0001c3da3/photos\"\n}"}],"_postman_id":"fda0faed-52e5-48ae-86f1-e267322cdbf9"}],"id":"c868c53d-bfa1-4175-9119-ec2d341ccaa9","description":"Description
\nOverview
\nThis collection within the CRM API catalog allows for the upload, deletion and the status check of a guest photo to the OpenTable for Restaurants table management software. The photo will be visible within the diner's profile and in the reservation card.
\nHow will this impact restaurants?
\nThe guest profile photo available within the Opentable for Restaurants software allows for guest recognition and an increased level of hospitality.
\nOpenTable Guest Sync API Documentation
\nOverview
\nThe OpenTable Guest Sync API allows users to retrieve detailed information about guest profiles associated with a restaurant.
\n\n
Endpoint
\nURL: {{base-url}}/sync/v2/guests
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters:
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nGuest Object Attributes
\n\n
Error Response for Guests
\nError Messaging
\nThe error response DTO returned by the Sync API collections are in the below format. When reporting issues, always provide the OT-RequestId (located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","v2","guests"],"host":["{{base-url}}"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}],"variable":[]}},"response":[{"id":"303a4d20-b891-4f13-807f-a32503c21283","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"bearer [Access Token]","disabled":true},{"key":"Cache-Control","value":"no-cache","disabled":true}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"a05ce3ed-0058-403b-b7fc-cc3b2a3a4311"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"217"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 18:38:28 GMT"},{"key":"Content-Length","value":"395"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"href\": \"https://platform.otqa.com/sync/v2/guests/1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"rid\": 1234567,\n \"sequence_id\": 1,\n \"gpid\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"email_optin\": true,\n \"phone\": \"2125555555\",\n \"phone_type\": \"Mobile\",\n \"tags\": null,\n \"birth_date\": null,\n \"anniversary_date\": null,\n \"updated_at\": \"2024-12-20T08:09:19\",\n \"forgotten\": false,\n \"archived\": false,\n \"primary_guest\": null,\n \"address\": null,\n \"mail_opted_in\": false,\n \"company_name\": null,\n \"phone_numbers\": [\n {\n \"label\": \"Mobile\",\n \"number\": \"2125555555\",\n \"country_code\": \"1\",\n \"primary\": true\n }\n ],\n \"created_date\": \"2024-12-20T08:09:19\",\n \"updated_at_utc\": \"2024-12-20T16:09:19Z\",\n \"marketing_opted_out\": false,\n \"notes\": null,\n \"notes_special_relationship\": null,\n \"notes_food_and_drink\": null,\n \"notes_seating\": null,\n \"created_date_utc\": \"2024-12-20T16:09:19Z\",\n \"date_last_visit\": \"2024-12-20T05:00:00\",\n \"date_first_visit\": \"2024-12-20T05:00:00\",\n \"date_last_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"date_first_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"is_hidden\": false\n }\n ]\n}"},{"id":"df4fd08a-e223-4713-85ba-4da4274340c7","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"bbf348f6-37e0-45ed-9f83-b2cc6fd35877"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"97913951-9eea-4707-96a2-b96e17b6fe68"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"128"},{"key":"Date","value":"Tue, 15 Oct 2024 04:49:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T04:49:44.787+0000\",\n \"path\": \"/sync/v2/guests\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"3b6f9d3f\"\n}"}],"_postman_id":"f96cb0b4-3ca9-4ce4-b6e1-42d4e32f5d33"},{"name":"CRM V3 Loyalties","id":"3e8adb68-62ca-4d1f-9123-f221322bf316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"loyalties\": [\r\n {\r\n \"accountId\": \"Diner Loyalty Program ID\",\r\n \"programName\": \"OpenTable Loyalty\",\r\n \"loyaltyTier\": \"Diamond\",\r\n \"pointsBalance\": \"2100\",\r\n \"flexFields\": [\r\n {\r\n \"label\": \"Favorite Meal\",\r\n \"value\": \"Jalapeno & Tomato Pizza\"\r\n },\r\n {\r\n \"label\": \"Benefits\",\r\n \"value\": \"VIP\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/loyalties","description":"CRM v3 - Loyalty API Documentation
\nOverview
\nThe Loyalty API enables external partners to manage guest loyalty information within the OpenTable ecosystem. This API allows for adding, managing guest loyalty program data to enhance guest experiences and personalize services.
\n\n
Endpoints: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/loyalties
Purpose
\nRetrieve the loyalty details for a specific guest in a restaurant.
\nResponse Body
\n\n
Managing Loyalty Data
\nPOST: Add or Append Loyalty Data
\nURL: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/loyalties
Purpose
\nAdd new loyalty data or append additional loyalty programs to an existing resource.
\nRequest Body
\n\n
PUT: Update Loyalty Data
\n{{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/loyalties
Purpose
\nUpdate an existing loyalty resource by replacing the entire object. Use this method for deletions as well by omitting fields you wish to remove.
\nRequest Body
\nThe structure is identical to the POST method.
\n\n
Deleting Data
\nTo delete specific loyalty data, use the PUT method with an updated object that excludes the items you wish to delete. Partial deletions are not supported; you must submit the complete object.
\n\n","urlObject":{"path":["api","v3","external","partners","{{partner-id}}","restaurants","{{rid}}","guests","{{guest-id}}","loyalties"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"8c989adc-cd94-4a22-880c-4bf46d6e4f0a","name":"200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"loyalties\": [\r\n {\r\n \"accountId\": \"Diner Loyalty Program ID\",\r\n \"programName\": \"OpenTable Loyalty\",\r\n \"loyaltyTier\": \"Diamond\",\r\n \"pointsBalance\": \"2100\",\r\n \"flexFields\": [\r\n {\r\n \"label\": \"Favorite Meal\",\r\n \"value\": \"Jalapeno & Tomato Pizza\"\r\n },\r\n {\r\n \"label\": \"Benefits\",\r\n \"value\": \"VIP\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/loyalties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"c3567e90-9c6f-4d6c-a878-0ff4ded80ce7"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"419"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/loyalties"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 20 Dec 2024 18:59:29 GMT"},{"key":"Content-Length","value":"201"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"loyalties\": [\n {\n \"programName\": \"OpenTable Loyalty\",\n \"loyaltyTier\": \"Diamond\",\n \"pointsBalance\": \"2100\",\n \"accountId\": \"Diner Loyalty Program ID\",\n \"flexFields\": [\n {\n \"label\": \"Favorite Meal\",\n \"value\": \"Jalapeno & Tomato Pizza\"\n },\n {\n \"label\": \"Benefits\",\n \"value\": \"VIP\"\n }\n ]\n }\n ]\n}"},{"id":"9e5bd0f8-ba2a-49b9-83d2-70ef4fcfcdf4","name":"401","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"loyalties\": [\r\n {\r\n \"accountId\": \"Test ID-3b97d36d-e93c-41e3-8442-12c0cb632b99\",\r\n \"programName\": \"OpenTable Loyalty\",\r\n \"loyaltyTier\": \"Gem\",\r\n \"pointsBalance\": \"2100\",\r\n \"flexFields\": [\r\n {\r\n \"label\": \"Favorite Meal\",\r\n \"value\": \"Jalapeno & Tomato Pizza\"\r\n },\r\n {\r\n \"label\": \"Benefits\",\r\n \"value\": \"VIP\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/loyalties"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"74ac7097-e37c-4ff2-9b32-bbe9abb082a6"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"BAABB029-248E-48E9-B8DA-E35FB5F257B7"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"x-ot-backend","value":"partnerGuestDataService"},{"key":"x-ot-uritemplate","value":"/partnerGuestDataService/api/v3/external/partners/{partner_id}/restaurants/{rid}/guests/{guest_id}/loyalties"},{"key":"x-envoy-upstream-service-time","value":"24"},{"key":"Content-Length","value":"311"},{"key":"Date","value":"Tue, 29 Oct 2024 06:28:27 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-29T06:28:27.098+0000\",\n \"path\": \"/gateway/proxies/restaurantpartnerapigateway/partnerGuestDataService/api/v3/external/partners/5850/restaurants/188878/guests/96c1ca88-a5f5-4949-9474-8a9922925a4b/loyalties\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Not authorized\",\n \"requestId\": \"7aeca0ca\"\n}"}],"_postman_id":"3e8adb68-62ca-4d1f-9123-f221322bf316"}],"id":"45d78dc8-d266-4f2f-a04f-5f2713187389","description":"
As a restaurateur, I want to enhance the guest experience by integrating loyalty program details from my CRM system into OpenTable. By surfacing this information in the Diner Details view within OpenTable for Restaurants, staff can easily identify and better serve returning or high-value guests.
\nAPIs to use:
\n- \n
Sync API – Guests
\n \nCRM API – Loyalties
\n \n
Step 1:
\nRetrieve guest data by using the Sync API to pull guest information from OpenTable.
\nStep 2:
\nStore relevant guest attributes in your system for ongoing use and matching. Recommended fields from the guest payload:
\n- \n
\nid\n
\nfirst_name\n
\nlast_name\n
\nemail\n
\nphone\n
\nupdated_at\n
Step 3:
\nMatch with loyalty records by cross-referencing the retrieved OpenTable guest data with your existing loyalty program records.
\nStep 4:
\nUse the CRM Loyalties endpoint to submit loyalty program details using the guest’s guest_id and associated RID (restaurant ID). This will update the guest’s profile with loyalty information, making it available to restaurant staff in-platform.
OpenTable Guest Sync API Documentation
\nOverview
\nThe OpenTable Guest Sync API allows users to retrieve detailed information about guest profiles associated with a restaurant.
\n\n
Endpoint
\nURL: {{base-url}}/sync/v2/guests
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters:
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nGuest Object Attributes
\n\n
Error Response for Guests
\nError Messaging
\nThe error response DTO returned by the Sync API collections are in the below format. When reporting issues, always provide the OT-RequestId (located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","v2","guests"],"host":["{{base-url}}"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}],"variable":[]}},"response":[{"id":"15072537-a6bb-4b87-b765-361bb26871c7","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"bearer [Access Token]","disabled":true},{"key":"Cache-Control","value":"no-cache","disabled":true}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"a05ce3ed-0058-403b-b7fc-cc3b2a3a4311"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"217"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 18:38:28 GMT"},{"key":"Content-Length","value":"395"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"href\": \"https://platform.otqa.com/sync/v2/guests/1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"rid\": 1234567,\n \"sequence_id\": 1,\n \"gpid\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"email_optin\": true,\n \"phone\": \"2125555555\",\n \"phone_type\": \"Mobile\",\n \"tags\": null,\n \"birth_date\": null,\n \"anniversary_date\": null,\n \"updated_at\": \"2024-12-20T08:09:19\",\n \"forgotten\": false,\n \"archived\": false,\n \"primary_guest\": null,\n \"address\": null,\n \"mail_opted_in\": false,\n \"company_name\": null,\n \"phone_numbers\": [\n {\n \"label\": \"Mobile\",\n \"number\": \"2125555555\",\n \"country_code\": \"1\",\n \"primary\": true\n }\n ],\n \"created_date\": \"2024-12-20T08:09:19\",\n \"updated_at_utc\": \"2024-12-20T16:09:19Z\",\n \"marketing_opted_out\": false,\n \"notes\": null,\n \"notes_special_relationship\": null,\n \"notes_food_and_drink\": null,\n \"notes_seating\": null,\n \"created_date_utc\": \"2024-12-20T16:09:19Z\",\n \"date_last_visit\": \"2024-12-20T05:00:00\",\n \"date_first_visit\": \"2024-12-20T05:00:00\",\n \"date_last_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"date_first_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"is_hidden\": false\n }\n ]\n}"},{"id":"4824a5a7-e26d-466c-ab2c-193ddfa7aa3c","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"bbf348f6-37e0-45ed-9f83-b2cc6fd35877"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"97913951-9eea-4707-96a2-b96e17b6fe68"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"128"},{"key":"Date","value":"Tue, 15 Oct 2024 04:49:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T04:49:44.787+0000\",\n \"path\": \"/sync/v2/guests\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"3b6f9d3f\"\n}"}],"_postman_id":"c7ebabfd-d58b-4033-ac7d-702c1cdfebf3"},{"name":"CRM V3 Properties","id":"196a6ae8-3098-4265-8013-ff72c439d21c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"properties\":[\r\n {\r\n \"reservationID\":\"e8f72c21-442b-45e1-871a-af54304102e9\",\r\n \"propertyName\":\"OpenTable Grand Hotel\",\r\n \"resStatusCode\":\"RESERVED\",\r\n \"resArriveDate\":\"2024-06-16T16:00:00.000\",\r\n \"resDepartDate\":\"2024-06-20T11:00:00.000\",\r\n \"roomNumber\":\"1121\",\r\n \"rateCode\":\"9561797\",\r\n \"flexFields\":[\r\n {\r\n \"label\":\"Promotions\",\r\n \"value\":\"Free breakfast\"\r\n },\r\n {\r\n \"label\":\"Activities booked\",\r\n \"value\":\"Wine sampling\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/guests/{{guest-id}}/properties","description":"Endpoints
\nPUT: Update or Add Guest Properties
\nURL: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests/{guestId}/properties
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body must be in JSON format and contain the following fields:
\n\n
Response Details
\nResponse Format
\nA successful request returns a 200 OK status code along with the updated properties in the response body.
Response Fields
\n\n
Notes
\n- \n
\n{partnerId},{rid}, and{guestId}are dynamic path parameters.- \n
\npartnerId: Assigned by OpenTable during onboarding. \n
\nrid: Unique identifier for the restaurant, available via OpenTable. \n
\nguestId: Found in the Sync API guest payload; remove the preceding RID from the guest ID. \n
\nTo delete specific property data, submit the full object excluding the items to be removed (partial deletions are not supported).
\n \n
As a restaurateur in a hotel, I want to enhance the guest experience by integrating loyalty program details from my Hotel CRM system into OpenTable. By surfacing this information in the Diner Details view within OpenTable for Restaurants, staff can easily identify and better serve returning or high-value guests.
\nAPIs to use:
\n- \n
Sync API – Guests
\n \nCRM API – Properties
\n \n
Step 1:
\nRetrieve guest data by using the Sync API to pull guest information from OpenTable.
\nStep 2:
\nStore relevant guest attributes in your system for ongoing use and matching. Recommended fields from the guest payload:
\n- \n
\nid\n
\nfirst_name\n
\nlast_name\n
\nemail\n
\nphone\n
\nupdated_at\n
Step 3:
\nMatch with loyalty records by cross-referencing the retrieved OpenTable guest data with your existing loyalty program records.
\nStep 4:
\nUse the CRM Loyalties endpoint to submit loyalty program details using the guest’s guest_id and associated RID (restaurant ID). This will update the guest’s profile with loyalty information, making it available to restaurant staff in-platform.
Create Guest API Documentation
\nEndpoint
\n{base-url}/api/v3/external/partners/{partnerId}/restaurants/{rid}/guests
Method
\nPOST
\nPath Parameters
\n- \n
partnerId: A static identifier for the partner assigned by OpenTable after onboarding.
\n \nrid (restaurant id): A unique, static identifier for each restaurant provided by OpenTable.
\n \n
Request Body Attributes
\nPhone Number Object Attributes
\nEmail Object Attributes
\nSuccess and Error Codes
\nNotes
\n- \n
Either
\nphoneNumbersoremailmust be provided. \nIf multiple
\nisPrimary: truevalues are provided in the phone numbers array, only the first one will be retained. \nEnsure your
\npartnerIdandridvalues are correctly assigned by OpenTable during onboarding. \n
Description
\nOverview
\nCustomer Relations Management API is a set of APIs that exposes additional guest and reservation details from other sources.
\nThe APIs will facilitate the addition of details in the diner profile and will leverage the Guest Sync API payload to accurately match and add information to specific guest profiles.
\nThis API allows for updating guest information records associated with a partner's restaurant. The data is exposed within the guest data in the restaurant’s OpenTable table management software.
\nHow will this impact restaurants?
\nThe Guest Creation API allows partners to create guest profiles in the OpenTable for Restaurants platform outside of the reservation making process.
\nBefore guest creation
\nAfter guest creation
\nGuest Matching / Creation Logic
\nWhen the Guest Creation API is called the following logic will be used to match to existing restaurant guest profiles or to create a brand new profile.
\nScenario 1: match
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone A, email A
\nScenario 2: match
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone A, no email
\nScenario 3: match
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, no phone, email A
\nScenario 4: no match, creation of a new guest
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone A, email B
\nScenario 5: no match, creation of a new guest
\nExisting guest: FirstName, LastName, Phone A, email A
\nPartnerGuest: FirstName, LastName, Phone B, email A
\nRate Limit:
\nThe maximum allowable rate of API calls at this endpoint is set at 10 calls per second per partner. Please note that other endpoints may have different requirements or limits.
\nChange Log
\nThese changes were completed in April of 2024.
\n","_postman_id":"12c9101a-2821-4d5b-ab64-e149f04f0a47"},{"name":"Tag Create, Delete and Post Copy","item":[{"name":"CRM V3 - Tag Create","id":"206252a8-529a-4b10-ac3e-84eb07cd511d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"displayName\": \"Friend of manager\",\n \"category\": \"special_guests\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v3/external/partners/{{partner-id}}/restaurants/{{rid}}/tags/{{tag-id}}","description":"Tag Management API Documentation
\nOverview
\nThe Tag Management API enables external partners to manage guest tags within the OpenTable system. This API allows for the creation, updating, and management of custom tags that can be associated with specific guests, providing flexibility and customization for restaurants to enhance guest relationships and experiences.
\n\n
Endpoint
\nURL
\nPUT: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{restaurantId}/tags/{tagId}
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body must be in JSON format and contain the following fields:
\n\n
Response Details
\nResponse Format
\nThe response is returned in JSON format and confirms the successful creation or update of the tag.
\nResponse Fields
\n\n
Error Codes
\n\n
Notes
\n- \n
Ensure that the
\npartnerId,restaurantId, andtagIdare valid and correspond to existing records in the OpenTable system. \nUse meaningful
\ndisplayNameandcategoryvalues to streamline guest classification and management. \n
Tag Listing API Documentation
\nOverview
\nThe Tag Listing API allows external partners to retrieve a list of all tags associated with a specific restaurant. These tags enable restaurants to classify guests based on specific attributes, preferences, or needs, facilitating a more personalized dining experience.
\n\n
Endpoint
\nURL
\nGET: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{restaurantId}/tags
\n
Request Details
\nHeaders
\nPath Parameters
\n\n
Response Details
\nResponse Format
\nThe response is returned in JSON format and contains a list of tags associated with the specified restaurant.
\nResponse Fields
\n\n
Error Codes
\n\n
Notes
\n- \n
Ensure that the
\npartnerIdandrestaurantIdare valid and correspond to existing records in the OpenTable system. \nTags retrieved are specific to the specified restaurant and are not shared across restaurants.
\n \n
Endpoint
\nURL
\nPOST: {{base-url}}/api/v3/external/partners/{partnerId}/restaurants/{restaurantId}/guests/{guestId}/tags
\n
Request Details
\nHeaders
\nPath Parameters
\nRequest Body
\nThe request body must be in JSON format and contain the following field:
\n\n
Response Details
\nResponse Format
\nA successful tag assignment returns a 200 OK status code along with the assigned tags in the response body.
Response Fields
\n\n
Error Codes
\n\n
Notes
\n- \n
Ensure that the
\npartnerId,restaurantId,guestId, andtagsare valid and correspond to existing records in the OpenTable system. \nTags that do not get created via the API will not be assigned.
\n \n
Description
\nOverview
\nThis endpoint within the CRM API catalog allows for creating Guest Tags and as well as the ability to assign these Guest Tags to guests. The updated guest information records associated with a specific partner's restaurant will have the data exposed within the guest data in the restaurant’s OpenTable table management software.
\nHow will this impact restaurants?
\nThe CRM tag creation will allow for partners to create and add new tags to guest profiles without the limitation of needing a tag to exist with the restaurant’s OpenTable for Restaurants system.
\nTags from CRM API will appear on the guest profile and will not be editable.
\nAs a restaurateur, I want to identify and highlight VIPs or special guests from my database by adding them to OpenTable and tagging their profiles with custom labels. These tags will appear in the Diner Details view within OpenTable for Restaurants, allowing my staff to provide personalized service.
\nAPIs to Use:
\n- \n
CRM API – Guest Creation
\n \nCRM API – Tag Create
\n \nCRM API – Tag Assign
\n \n
Implementation Steps:
\nStep 1:
\nUse the Guest Creation endpoint to add the guest to OpenTable. Store the guest_id returned in the API response for use in subsequent steps.
Step 2:
\nYou must create or retrieve a tag. If the tag does not already exist, use the Tag Create endpoint to define a new tag id, including its displayName. For existing tags, use the Tag Retrieval endpoint to fetch the tag id and displayName.
Step 3:
\nUse the Tag Assign endpoint to associate the tag with the guest using the previously stored guest_id. This ensures the tag is visible in the OpenTable for Restaurants interface.
OpenTable's CRM API enhances restaurant's ability to leverage guest data within the OpenTable Pro system, unlocking deeper insights and more personalized interactions. By integrating with the CRM API, restaurants can access enriched guest data that goes beyond basic reservations, enabling restaurants to better understand your diners’ preferences, habits, and history. With this information, restaurants and hospitality partners can deliver more tailored and memorable dining experiences, creating stronger guest relationships and driving customer loyalty.
\nThe CRM API allows you to seamlessly post third party insights and updates to the OpenTable Pro system. This two-way data exchange ensures your team is equipped with real-time, actionable information, helping you optimize operations and elevate guest satisfaction. Whether you’re tracking special occasions, preferences, or dining patterns, the CRM API empowers you to transform insights into impactful, guest-centered service.
\nCRM APIs are subject to a Rate Limit:
\nThe maximum allowable rate of API calls for all CRM API endpoints is set at 10 calls per second per partner. Please note that other endpoints or APIs may have different requirements or limits.
\nChange Log
\nThe previous CRM API available was v2. We have also made some slight changes to v3 since we last provided documentation. The following changes have been made since:
\n- \n
New Endpoint URLs
\n \nEnhanced security limiting partners to only certain attributes
\n \nRemoval of the Integrations Object. That information is static and will be kept stored in the OpenTable system. For adjustments to the integration name, please work with OpenTable.
\n \n
These changes were completed in April of 2024.
\nEndpoints Notes
\n- \n
POST will allow you to add or append details (appends items to the resource)
\n \nPUT will allow you to update (overwrites the resource)
\n \n
OpenTable Directory API Documentation
\nOverview
\nThe Directory API gives approved developers the ability to acquire and synchronize restaurants that are visible as search results on the OpenTable website. The Directory API is only available to our Consumer Partners and is not offered to our Restaurant Partners.
\n\n
Endpoint
\nURL: {{base-url}}/sync/directory
\nMethod: GET
\nQuery Parameters
\nResponse Attributes
\nRestaurant Object Attributes
\nProfile_Photo Array
\nProfile_Photo Size Array
\nError Response for Directory
\nError Messaging
\nThe error response details returned by the Directory API collection is in the below format. When reporting issues with the API, always provide the OT-RequestId (requestid from the error body and located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","directory"],"host":["{{base-url}}"],"query":[{"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"87e4ec26-11b6-40be-9d61-46ce0b6c7be8","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/sync/directory?limit=10","host":["{{base-url}}"],"path":["sync","directory"],"query":[{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_items\": 60895,\n \"offset\": 0,\n \"limit\": 10,\n \"items\": [\n {\n \"rid\": 10,\n \"name\": \"Harris'\",\n \"address\": \"2100 Van Ness Avenue\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.7950668\",\n \"longitude\": \"-122.4229237\",\n \"postal_code\": \"94109\",\n \"phone_number\": \"4156731888\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/10\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/10\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/harris-san-francisco\",\n \"natural_profile_url\": \"http://www.opentable.com/r/harris-san-francisco\",\n \"profile_photo\": {\n \"id\": 79882553,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/3/79882553.png\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/3/79882553.png\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/3/79882553.png\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/3/79882553.png\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/3/79882553.png\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/3/79882553.png\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/3/79882553.png\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/3/79882553.png\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/3/79882553.png\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/3/79882553.png\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/3/79882553.png\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/3/79882553.png\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/3/79882553.png\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/3/79882553.png\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.800\",\n \"price_quartile\": \"$$$$\",\n \"review_count\": 5864,\n \"category\": [\n \"Steakhouse\",\n \"American\",\n \"Steak\"\n ],\n \"hours\": \"Sun 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"openingtimes\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 24,\n \"name\": \"INDO Restaurant & Lounge\",\n \"address\": \"3295 El Camino Real\",\n \"address2\": \"\",\n \"city\": \"Palo Alto\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.4209159\",\n \"longitude\": \"-122.1369480\",\n \"postal_code\": \"94306\",\n \"phone_number\": \"+16504947168\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/24\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/24\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/indo-restaurant-and-lounge-palo-alto\",\n \"natural_profile_url\": \"http://www.opentable.com/r/indo-restaurant-and-lounge-palo-alto\",\n \"profile_photo\": {\n \"id\": 26286947,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/5/26286947.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/5/26286947.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/5/26286947.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/5/26286947.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/5/26286947.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/5/26286947.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/5/26286947.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/5/26286947.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/5/26286947.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/5/26286947.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.700\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 1163,\n \"category\": [\n \"Asian\",\n \"Southeast Asian\",\n \"Indonesian\"\n ],\n \"hours\": \"Lunch\\nDaily 11:00 am–2:00 pm\\n
Dinner\\n
Daily 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"sun\",\n \"mon\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"sun\",\n \"mon\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 33,\n \"name\": \"Wildfire - Chicago\",\n \"address\": \"159 West Erie St.\",\n \"address2\": \"\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"latitude\": \"41.8937860\",\n \"longitude\": \"-87.6334978\",\n \"postal_code\": \"60654\",\n \"phone_number\": \"3127879000\",\n \"metro_name\": \"Chicago / Illinois\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/33\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/33\",\n \"natural_reservation_url\": \"http://www.opentable.com/wildfire-chicago\",\n \"natural_profile_url\": \"http://www.opentable.com/wildfire-chicago\",\n \"profile_photo\": {\n \"id\": 23682457,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/1/23682457.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/1/23682457.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/1/23682457.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/1/23682457.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/1/23682457.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/1/23682457.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/1/23682457.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/1/23682457.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/1/23682457.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/1/23682457.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.400\",\n \"price_quartile\": \"$$\",\n \"review_count\": 8416,\n \"category\": [\n \"American\",\n \"Steak\",\n \"Seafood\"\n ],\n \"hours\": \"Mon–Thu, Sun 4:00 pm–8:30 pm\\n
Fri, Sat 4:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"openingtimes\",\n \"shiftStarts\": \"16:00\",\n \"shiftEnds\": \"20:30\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"sun\"\n ]\n },\n {\n \"name\": \"openingtimes\",\n \"shiftStarts\": \"16:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"sat\",\n \"fri\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 47,\n \"name\": \"Shaw's Crab House & Oyster Bar - Chicago\",\n \"address\": \"21 East Hubbard St.\",\n \"address2\": \"\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"latitude\": \"41.8899100\",\n \"longitude\": \"-87.6274230\",\n \"postal_code\": \"60611\",\n \"phone_number\": \"3125272722\",\n \"metro_name\": \"Chicago / Illinois\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/47\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/47\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/shaws-crab-house-and-oyster-bar-chicago-chicago\",\n \"natural_profile_url\": \"http://www.opentable.com/r/shaws-crab-house-and-oyster-bar-chicago-chicago\",\n \"profile_photo\": {\n \"id\": 68954757,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/2/68954757.png\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/2/68954757.png\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/2/68954757.png\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/2/68954757.png\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/2/68954757.png\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/2/68954757.png\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/2/68954757.png\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/2/68954757.png\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/2/68954757.png\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/2/68954757.png\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/2/68954757.png\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/2/68954757.png\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/2/68954757.png\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/2/68954757.png\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.800\",\n \"price_quartile\": \"$$$$\",\n \"review_count\": 14734,\n \"category\": [\n \"Seafood\",\n \"American\",\n \"Sushi\"\n ],\n \"hours\": \"Lunch\\n
Daily 11:30 am–3:00 pm\\n
Dinner\\n
Mon–Thu, Sun 3:00 pm–9:00 pm\\n
Fri, Sat 3:00 pm–10:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:30\",\n \"shiftEnds\": \"15:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"15:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"mon\",\n \"sun\",\n \"tue\",\n \"wed\",\n \"thu\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"15:00\",\n \"shiftEnds\": \"22:00\",\n \"days\": [\n \"sat\",\n \"fri\"\n ]\n },\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:30\",\n \"shiftEnds\": \"15:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 101,\n \"name\": \"Alcala\",\n \"address\": \"246 East 44th Street\",\n \"address2\": \"\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"latitude\": \"40.7511146\",\n \"longitude\": \"-73.9717761\",\n \"postal_code\": \"10017\",\n \"phone_number\": \"2123701866\",\n \"metro_name\": \"New York City\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/101\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/101\",\n \"natural_reservation_url\": \"http://www.opentable.com/alcala\",\n \"natural_profile_url\": \"http://www.opentable.com/alcala\",\n \"profile_photo\": {\n \"id\": 47526468,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/small.png\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/2/47526468.png\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/2/47526468.png\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/2/47526468.png\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/large.png\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/2/47526468.png\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/2/47526468.png\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/medium.png\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/2/47526468.png\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/2/47526468.png\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/huge.png\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/2/47526468.png\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/2/47526468.png\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/2/47526468.png\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.400\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 617,\n \"category\": [\n \"Spanish\",\n \"Latin / Spanish\",\n \"Comfort Food\"\n ],\n \"hours\": \"Lunch\\n
Mon–Fri 12:00 pm–4:30 pm\\n
Dinner\\n
Mon–Fri 5:00 pm–11:00 pm\\n
Sat, Sun 5:30 pm–11:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"12:00\",\n \"shiftEnds\": \"16:30\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"23:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:30\",\n \"shiftEnds\": \"23:00\",\n \"days\": [\n \"sun\",\n \"sat\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": false\n }\n },\n {\n \"rid\": 112,\n \"name\": \"Marin\",\n \"address\": \"1101 4th Ave.\",\n \"address2\": \"\",\n \"city\": \"Seattle\",\n \"state\": \"WA\",\n \"country\": \"US\",\n \"latitude\": \"47.6069535\",\n \"longitude\": \"-122.3340941\",\n \"postal_code\": \"98101\",\n \"phone_number\": \"+12066247755\",\n \"metro_name\": \"Seattle / Eastern Washington\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/112\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/112\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/marin-seattle\",\n \"natural_profile_url\": \"http://www.opentable.com/r/marin-seattle\",\n \"profile_photo\": {\n \"id\": 79033572,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/4/79033572.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/4/79033572.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/4/79033572.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/4/79033572.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/4/79033572.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/4/79033572.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/4/79033572.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/4/79033572.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/4/79033572.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/4/79033572.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/4/79033572.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/4/79033572.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/4/79033572.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/4/79033572.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.300\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 30,\n \"category\": [\n \"Mediterranean\",\n \"American\",\n \"Contemporary American\"\n ],\n \"hours\": \"Breakfast\\n
Mon–Fri 7:00 am–10:00 am\\n
Bar\\n
Sat, Sun 7:00 am–10:00 pm\\n
Brunch\\n
Sat, Sun 8:00 am–2:00 pm\\n
Lunch\\n
Mon–Fri 11:00 am–2:00 pm\\n
Happy Hour\\n
Daily 3:00 pm–5:00 pm\\n
Dinner\\n
Daily 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"10:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"fri\",\n \"wed\",\n \"thu\"\n ]\n },\n {\n \"name\": \"brunch\",\n \"shiftStarts\": \"08:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n },\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"happyhour\",\n \"shiftStarts\": \"15:00\",\n \"shiftEnds\": \"17:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"sun\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"sat\",\n \"sun\",\n \"fri\"\n ]\n },\n {\n \"name\": \"bar\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"22:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 130,\n \"name\": \"Boulevard\",\n \"address\": \"1 Mission St.\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.7932194\",\n \"longitude\": \"-122.3929750\",\n \"postal_code\": \"94105\",\n \"phone_number\": \"+14155436084\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/130\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/130\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/boulevard-san-francisco\",\n \"natural_profile_url\": \"http://www.opentable.com/r/boulevard-san-francisco\",\n \"profile_photo\": {\n \"id\": 51634215,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/2/51634215.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/2/51634215.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/2/51634215.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/2/51634215.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/2/51634215.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/2/51634215.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/2/51634215.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/2/51634215.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/2/51634215.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/2/51634215.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.900\",\n \"price_quartile\": \"$$$$\",\n \"review_count\": 9311,\n \"category\": [\n \"Californian\",\n \"Contemporary French / American\",\n \"Contemporary American\"\n ],\n \"hours\": \"Bar\\n
Mon–Sat 5:00 pm–9:30 pm\\n
Dinner\\n
Mon–Sat 5:15 pm–9:30 pm\",\n \"hours_raw\": [\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:15\",\n \"shiftEnds\": \"21:30\",\n \"days\": [\n \"thu\",\n \"fri\",\n \"sat\",\n \"wed\",\n \"tue\",\n \"mon\"\n ]\n },\n {\n \"name\": \"bar\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:30\",\n \"days\": [\n \"wed\",\n \"tue\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"mon\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 141,\n \"name\": \"ANZU\",\n \"address\": \"222 Mason St.\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.7860081\",\n \"longitude\": \"-122.4092959\",\n \"postal_code\": \"94102\",\n \"phone_number\": \"+14153941100\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/141\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/141\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/anzu-san-francisco\",\n \"natural_profile_url\": \"http://www.opentable.com/r/anzu-san-francisco\",\n \"profile_photo\": {\n \"id\": 92081614,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/1/92081614.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/1/92081614.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/1/92081614.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/1/92081614.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/1/92081614.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/1/92081614.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/1/92081614.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/1/92081614.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/1/92081614.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/1/92081614.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/1/92081614.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/1/92081614.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/1/92081614.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/1/92081614.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.100\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 2578,\n \"category\": [\n \"Breakfast\",\n \"Californian\",\n \"Japanese\"\n ],\n \"hours\": \"Breakfast\\n
Mon–Fri 6:30 am–10:30 am\\n
Sat, Sun 7:00 am–12:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"06:30\",\n \"shiftEnds\": \"10:30\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"12:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": false\n }\n },\n {\n \"rid\": 144,\n \"name\": \"Il Solito\",\n \"address\": \"627 SW Washington St.\",\n \"address2\": \"\",\n \"city\": \"Portland\",\n \"state\": \"OR\",\n \"country\": \"US\",\n \"latitude\": \"45.5206798\",\n \"longitude\": \"-122.6785073\",\n \"postal_code\": \"97205\",\n \"phone_number\": \"+15032281515\",\n \"metro_name\": \"Portland / Oregon\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/144\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/144\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/il-solito-portland\",\n \"natural_profile_url\": \"http://www.opentable.com/r/il-solito-portland\",\n \"profile_photo\": {\n \"id\": 82056458,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/3/82056458.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/3/82056458.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/3/82056458.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/3/82056458.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/3/82056458.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/3/82056458.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/3/82056458.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/3/82056458.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/3/82056458.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/3/82056458.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/3/82056458.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/3/82056458.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/3/82056458.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/3/82056458.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.300\",\n \"price_quartile\": \"$$\",\n \"review_count\": 1364,\n \"category\": [\n \"Breakfast\",\n \"Contemporary Italian\",\n \"Northwest\"\n ],\n \"hours\": \"Breakfast\\n
Mon–Fri 7:00 am–11:00 am\\n
Brunch\\n
Sat, Sun 8:00 am–2:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"11:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"brunch\",\n \"shiftStarts\": \"08:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": false\n }\n },\n {\n \"rid\": 147,\n \"name\": \"Birk's\",\n \"address\": \"3955 Freedom Circle\",\n \"address2\": \"\",\n \"city\": \"Santa Clara\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.3854527\",\n \"longitude\": \"-121.9728830\",\n \"postal_code\": \"95054\",\n \"phone_number\": \"4089806400\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/147\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/147\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/birks-santa-clara\",\n \"natural_profile_url\": \"http://www.opentable.com/r/birks-santa-clara\",\n \"profile_photo\": {\n \"id\": 25175460,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/1/25175460.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/1/25175460.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/1/25175460.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/1/25175460.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/1/25175460.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/1/25175460.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/1/25175460.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/1/25175460.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/1/25175460.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/1/25175460.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.700\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 3715,\n \"category\": [\n \"American\",\n \"Steakhouse\",\n \"Steak\"\n ],\n \"hours\": \"Lunch\\n
Mon–Fri 11:00 am–2:30 pm\\n
Happy Hour\\n
Mon–Fri 3:30 pm–6:00 pm\\n
Sat 5:00 pm–7:00 pm\\n
Dinner\\n
Daily 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:00\",\n \"shiftEnds\": \"14:30\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"mon\"\n ]\n },\n {\n \"name\": \"happyhour\",\n \"shiftStarts\": \"15:30\",\n \"shiftEnds\": \"18:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"mon\"\n ]\n },\n {\n \"name\": \"happyhour\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"19:00\",\n \"days\": [\n \"sat\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"mon\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n }\n ]\n}"},{"id":"7664773d-faed-4286-a09d-bd239a90dff8","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/sync/directory?limit=10","host":["{{base-url}}"],"path":["sync","directory"],"query":[{"key":"limit","value":"10"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"1800b854-25d4-42a7-b046-92449c438ed5"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"10"},{"key":"Content-Length","value":"91"},{"key":"Date","value":"Wed, 22 Jan 2025 20:46:56 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"invalid_token\"\n }\n ],\n \"requestid\": \"1800b854-25d4-42a7-b046-92449c438ed5\"\n}"}],"_postman_id":"b9b311ee-1284-4fa4-861f-e20ae5417b5f"}],"id":"c43080e9-565f-4d4e-991f-616b70bdf533","description":"
The Directory API gives approved developers the ability to acquire and synchronize restaurants that are visible as search results on the OpenTable website. The Directory API is only available to our Consumer Partners and is not offered to our Restaurant Partners.
\n","_postman_id":"c43080e9-565f-4d4e-991f-616b70bdf533"}],"id":"c43e6c99-e40c-415a-b38b-3527753b7ac4","description":"Affiliates Guide
\nIntroduction
\nThis section contains instructions to retrieve the directory information of all OpenTable restaurants and implement reservation links to OpenTable.com, the OpenTable iOS app, and OpenTable Android app. This provides affiliates with the ability to easily link to restaurants that accept online reservations via OpenTable.
\nRetrieving Restaurant Data via Directory API
\nThe Directory API returns a complete directory of restaurants that accept online reservations via OpenTable so that will need to first be called. The restaurant directory will be returned by the API in JSON format. The links can then be built using the data returned by the Directory API. The restaurant data is refreshed nightly, so it is recommended to call the API at least once a day to get the most current restaurant directory data.
\nLinking Guidelines
\nAffiliates must comply with the following guidelines when using OpenTable data and linking to the OpenTable site
\nOpenTable reserve links must be displayed either next to or in lieu of the restaurant’s phone number. Additionally, the the link text must use one of the following conventions:
\n- \n
“Online Reservations”
\n \n“[RestaurantName]”
\n \n“[RestaurantName] Reservations”
\n \n“Restaurant Reservations”
\n \n
Linking to Individual Restaurants on OpenTable.com
\nThe process of linking to each restaurant’s reservation page involves using the natural_profile_url value contained in the JSON response of the Directory API for each restaurant, along with your unique referral ID which is provided by OpenTable:
\nhttps://www.opentable.com/boulevard-san-francisco?ref=zzzz
\nWhere 'https://www.opentable.com/r/boulevard-san-francisco' is the restaurant’s natural_profile_url value as returned from the Directory API and zzzz is the numerical referral ID (this allows OpenTable to track reservations coming from your site). Your referral ID will be provided to you if approved for partnership.
\nAs an example, the link for Boulevard San Francisco for a referral ID of 1234: https://www.opentable.com/r/boulevard-san-francisco?ref=1234
“Deep Linking” into the OpenTable iOS App
\nThe OpenTable iOS app supports universal links (e.g., opening desktop/mobile web links directly into the app).
\nThis is the preferred way of deep linking into the app. The main benefit is that these links will always work, even if the app is not installed, taking the user to Safari.
\n","_postman_id":"c43e6c99-e40c-415a-b38b-3527753b7ac4"},{"name":"Menus API","item":[{"name":"Publish Menus","item":[{"name":"Menu Example Request - Webhook","id":"abf080a3-11c4-4726-af4c-54ba1bc5c403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" \"menus\": [\n {\n \"MENU WEBHOOK FORMAT
\nOpenTable expects restaurant level menus to be pushed via the webhook API in below format.
\nAPI Path
\n/v1/partnermenu/{partnername}/location/{locationId}/menus
\nMethod: POST
\nPOST a request with all menus of the restaurant whenever there is a change in any part of any menu on a restaurant level.
\nThe sync will happen asynchronously whenever a webhook event with these details are received and the same will get reflected on UI. OpenTable will process these menus in real time.
\nParameters
\nMenu
\nGroup
\nItem
\nItem Size
\nModifier Group
\nModifier
\nPreModifier Group
\nPreModifier
\nImage
\nRelationMapping
\nPriceMetadata
\nTax Details
\nMetadata
\nNutritional Info
\nCalories
\nAvailability
\n","urlObject":{"path":["v1","partnermenu","{{partnername}}","location","{{rid}}","menus"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"926859d4-c704-44d3-94d5-1ba20e4b7dd3","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" {\n \"menus\": [\n {\n \"8daa98e0-cfd0-11ed-afa1-0242ac120002\": {\n \"id\": \"8daa98e0-cfd0-11ed-afa1-0242ac120002\",\n \"name\": \"Example Menu\",\n \"description\": \"Menu description\",\n \"type\": \"DINE_IN\",\n \"defaultCurrency\": \"USD\",\n \"ordinal\": 100,\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"groups\": [\n {\n \"id\": \"3981f08e-cfd4-11ed-afa1-0242ac120002\",\n \"ordinal\": 1\n },\n {\n \"id\": \"3d11d670-cfe7-11ed-afa1-0242ac120002\",\n \"ordinal\": 2\n }\n ],\n \"footnote\": \"Lorem ipsum dolor sit amet\",\n \"metadata\": {\n \"nameTranslations\": {\n \"en-CA\": \"Example Menu\"\n },\n \"descriptionTranslations\": {\n \"en-CA\": \"Menu description\"\n },\n \"availabilities\": [\n {\n \"dayOfWeek\": 1,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n },\n {\n \"dayOfWeek\": 2,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n },\n {\n \"dayOfWeek\": 3,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n },\n {\n \"dayOfWeek\": 4,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n },\n {\n \"dayOfWeek\": 5,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n },\n {\n \"dayOfWeek\": 6,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n },\n {\n \"dayOfWeek\": 6,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n },\n {\n \"dayOfWeek\": 7,\n \"endTime\": \"13:00\",\n \"startTime\": \"17:00\"\n }\n ],\n \"images\": [\n {\n \"thumbnailUrl\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR6xETmD993L7e611V1UOcwCDDaIRlpbpVbwQ&usqp=CAU\",\n \"url\": \"https://img.freepik.com/free-photo/flat-lay-batch-cooking-composition_23-2148765597.jpg\",\n \"featured\": true\n },\n {\n \"url\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRTmp-CfQ-albJX7ez9aZxkJ6Pbr-eZj3r5cA&usqp=CAU\",\n \"featured\": false\n }\n ],\n \"enabled\": true\n }\n },\n \"groups\": {\n \"3981f08e-cfd4-11ed-afa1-0242ac120002\": {\n \"id\": \"3981f08e-cfd4-11ed-afa1-0242ac120002\",\n \"name\": \"Starters\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"subGroups\": [\n {\n \"id\": \"50f7dd8c-cfd4-11ed-afa1-0242ac120002\",\n \"ordinal\": 1\n }\n ],\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"50f7dd8c-cfd4-11ed-afa1-0242ac120002\": {\n \"id\": \"50f7dd8c-cfd4-11ed-afa1-0242ac120002\",\n \"name\": \"Vegetarian Starters\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"items\": [\n {\n \"id\": \"edbd3b14-cfe1-11ed-afa1-0242ac120002\",\n \"ordinal\": \"1\"\n },\n {\n \"id\": \"736ab346-d18a-11ed-afa1-0242ac120002\",\n \"ordinal\": \"2\"\n }\n ],\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"3d11d670-cfe7-11ed-afa1-0242ac120002\": {\n \"id\": \"3d11d670-cfe7-11ed-afa1-0242ac120002\",\n \"name\": \"Pizzas\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"items\": [\n {\n \"id\": \"64d162de-cfe7-11ed-afa1-0242ac120002\",\n \"ordinal\": \"1\"\n }\n ],\n \"metadata\": {\n \"enabled\": true\n }\n }\n },\n \"items\": {\n \"edbd3b14-cfe1-11ed-afa1-0242ac120002\": {\n \"id\": \"edbd3b14-cfe1-11ed-afa1-0242ac120002\",\n \"name\": \"Corn Cheese Balls\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"PRICE\",\n \"minPrice\": 20.0,\n \"maxPrice\": 20.0,\n \"tax\": [\n {\n \"taxCategory\": \"Sales Tax\",\n \"taxAmount\": 5.0\n }\n ]\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"modifierGroups\": [\n {\n \"id\": \"1e4a2ed8-cfe5-11ed-afa1-0242ac120002\",\n \"ordinal\": \"1\"\n }\n ],\n \"metadata\": {\n \"calories\": {\n \"min\": 90,\n \"max\": 90\n },\n \"multiMax\": 1,\n \"ingredients\": [\n \"Baby Corn\",\n \"Potato\",\n \"Processed Cheese\"\n ],\n \"prepackaged\": false,\n \"nutritionalInfo\": {\n \"nutrients\": {\n \"fat\": 2.8,\n \"protein\": 2\n },\n \"unit\": \"g\"\n },\n \"tags\": [\n \"dairy\",\n \"vegetarian\"\n ],\n \"images\": [\n {\n \"thumbnailUrl\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSVo-QysTFpXtr_ZbR36jsdPDW1PX0mtaOaYg&usqp=CAU\",\n \"url\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTpQtTEeqnJGFpRUlHmLGloA-5EzR29eszHwg&usqp=CAU\",\n \"featured\": true\n }\n ],\n \"enabled\": true\n }\n },\n \"736ab346-d18a-11ed-afa1-0242ac120002\": {\n \"id\": \"736ab346-d18a-11ed-afa1-0242ac120002\",\n \"name\": \"Kebab\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"CUSTOM_PRICE_TEXT\",\n \"customPriceText\": \"Special Price\"\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"modifierGroups\": [\n {\n \"id\": \"1e4a2ed8-cfe5-11ed-afa1-0242ac120002\",\n \"ordinal\": \"1\"\n }\n ],\n \"metadata\": {\n \"tags\": [\n \"vegetarian\"\n ],\n \"images\": [\n {\n \"thumbnailUrl\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRlLm_cKCgTv67yYcWm6_dxNepV5CcHCYijlw&usqp=CAU\",\n \"url\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRlLm_cKCgTv67yYcWm6_dxNepV5CcHCYijlw&usqp=CAU\",\n \"featured\": true\n }\n ],\n \"enabled\": true\n }\n },\n \"64d162de-cfe7-11ed-afa1-0242ac120002\": {\n \"id\": \"64d162de-cfe7-11ed-afa1-0242ac120002\",\n \"name\": \"Peppy Paneer Pizza\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"SIZE_PRICE\"\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"modifierGroups\": [\n {\n \"id\": \"df14ddd2-cfe7-11ed-afa1-0242ac120002\",\n \"ordinal\": \"1\"\n }\n ],\n \"sizes\": [\n {\n \"id\": \"cb69fd9e-cfe7-11ed-afa1-0242ac120002\",\n \"ordinal\": \"1\"\n },\n {\n \"id\": \"d9c600a4-cfe7-11ed-afa1-0242ac120002\",\n \"ordinal\": \"2\"\n }\n ],\n \"metadata\": {\n \"images\": [\n {\n \"thumbnailUrl\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSxf25fPlxLkIA0LQ4zE7OWiADZtqs844tUmQ&usqp=CAU\",\n \"url\": \"https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTLzSAu--BxXSY4QqRzgLKFwbsy43lpItTJjA&usqp=CAU\",\n \"featured\": true\n }\n ],\n \"enabled\": true\n }\n }\n },\n \"itemSizes\": {\n \"cb69fd9e-cfe7-11ed-afa1-0242ac120002\": {\n \"id\": \"cb69fd9e-cfe7-11ed-afa1-0242ac120002\",\n \"name\": \"Large\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"PRICE\",\n \"minPrice\": 20,\n \"maxPrice\": 20,\n \"tax\": [\n {\n \"taxCategory\": \"Sales Tax\",\n \"taxAmount\": 5.0\n }\n ]\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"d9c600a4-cfe7-11ed-afa1-0242ac120002\": {\n \"id\": \"d9c600a4-cfe7-11ed-afa1-0242ac120002\",\n \"name\": \"Medium\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"PRICE\",\n \"minPrice\": 15.0,\n \"maxPrice\": 15.0,\n \"tax\": [\n {\n \"taxCategory\": \"Sales Tax\",\n \"taxAmount\": 4.0\n }\n ]\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"metadata\": {\n \"enabled\": true\n }\n }\n },\n \"modifierGroups\": {\n \"1e4a2ed8-cfe5-11ed-afa1-0242ac120002\": {\n \"id\": \"1e4a2ed8-cfe5-11ed-afa1-0242ac120002\",\n \"name\": \"Dipping Sauce\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"minChoices\": 1,\n \"maxChoices\": 1,\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"preModifierGroup\": \"9ba2b81e-cfe5-11ed-afa1-0242ac120002\",\n \"modifiers\": [\n {\n \"id\": \"b7e0c0d6-cfe8-11ed-afa1-0242ac120002\",\n \"ordinal\": 1\n },\n {\n \"id\": \"bd7e9bc6-cfe8-11ed-afa1-0242ac120002\",\n \"ordinal\": 2\n }\n ],\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"df14ddd2-cfe7-11ed-afa1-0242ac120002\": {\n \"id\": \"df14ddd2-cfe7-11ed-afa1-0242ac120002\",\n \"name\": \"Toppings\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"minChoices\": 1,\n \"maxChoices\": 3,\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"modifiers\": [\n {\n \"id\": \"c4ef9cde-cfe8-11ed-afa1-0242ac120002\",\n \"ordinal\": 1\n },\n {\n \"id\": \"c93aea46-cfe8-11ed-afa1-0242ac120002\",\n \"ordinal\": 2\n }\n ],\n \"metadata\": {\n \"enabled\": true\n }\n }\n },\n \"modifiers\": {\n \"b7e0c0d6-cfe8-11ed-afa1-0242ac120002\": {\n \"id\": \"b7e0c0d6-cfe8-11ed-afa1-0242ac120002\",\n \"name\": \"Tomato Sauce\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"bd7e9bc6-cfe8-11ed-afa1-0242ac120002\": {\n \"id\": \"bd7e9bc6-cfe8-11ed-afa1-0242ac120002\",\n \"name\": \"Cheese Dip\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"c4ef9cde-cfe8-11ed-afa1-0242ac120002\": {\n \"id\": \"c4ef9cde-cfe8-11ed-afa1-0242ac120002\",\n \"name\": \"Cottage Cheese\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"PRICE\",\n \"minPrice\": 2,\n \"maxPrice\": 2,\n \"tax\": [\n {\n \"taxCategory\": \"Sales Tax\",\n \"taxAmount\": 1\n }\n ]\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"c93aea46-cfe8-11ed-afa1-0242ac120002\": {\n \"id\": \"c93aea46-cfe8-11ed-afa1-0242ac120002\",\n \"name\": \"Black Olives\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"PRICE\",\n \"minPrice\": 2,\n \"maxPrice\": 2,\n \"tax\": [\n {\n \"taxCategory\": \"Sales Tax\",\n \"taxAmount\": 1\n }\n ]\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"metadata\": {\n \"enabled\": true\n }\n }\n },\n \"preModifierGroups\": {\n \"9ba2b81e-cfe5-11ed-afa1-0242ac120002\": {\n \"id\": \"9ba2b81e-cfe5-11ed-afa1-0242ac120002\",\n \"name\": \"Example Premodifier\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"preModifiers\": [\n {\n \"id\": \"e83fcd60-cfe5-11ed-afa1-0242ac120002\",\n \"ordinal\": 1\n },\n {\n \"id\": \"f5d6cf1e-cfe5-11ed-afa1-0242ac120002\",\n \"ordinal\": 2\n }\n ],\n \"metadata\": {\n \"enabled\": true\n }\n }\n },\n \"preModifiers\": {\n \"e83fcd60-cfe5-11ed-afa1-0242ac120002\": {\n \"id\": \"e83fcd60-cfe5-11ed-afa1-0242ac120002\",\n \"name\": \"EXTRA\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"PRICE\",\n \"minPrice\": 1.5,\n \"maxPrice\": 1.5\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"displayMode\": \"PREFIX\",\n \"metadata\": {\n \"enabled\": true\n }\n },\n \"f5d6cf1e-cfe5-11ed-afa1-0242ac120002\": {\n \"id\": \"f5d6cf1e-cfe5-11ed-afa1-0242ac120002\",\n \"name\": \"ON SIDE\",\n \"description\": \"Lorem ipsum dolor sit amet\",\n \"priceMetadata\": {\n \"priceType\": \"PRICE\",\n \"multiplicationFactor\": 1.5\n },\n \"createdAt\": \"2023-03-17T06:37:27Z\",\n \"updatedAt\": \"2023-03-17T07:37:27Z\",\n \"displayMode\": \"SUFFIX\",\n \"metadata\": {\n \"enabled\": true\n }\n }\n }\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/partnermenu/{{partnername}}/location/{{rid}}/menus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"requestId\": 206,\n \"itemStatus\": [\n {\n \"itemId\": \"1\",\n \"sequenceId\": 205,\n \"status\": \"Processing\"\n }\n ],\n \"totalItems\": 1,\n \"totalProcessedItems\": 1,\n \"created\": \"2023-04-02T20:43:32.578478Z\"\n}"}],"_postman_id":"abf080a3-11c4-4726-af4c-54ba1bc5c403"}],"id":"b07ec18e-70a1-4347-bdd7-cebc5943a03d","description":"Overview
\nThis API allows OpenTable restaurants to integrate with 3rd party menus. This functionality allows restaurants to source menus from their preferred menu providers and have them available in OpenTable. Once integrated, the menus are kept in sync with the partner at all times. Restaurants will also be able to choose which menus they would like to display on their profile page as well as modify the order of the menus shown.
\nExposing a Menu on OpenTable for Restaurants:
\nThis API allows restaurants to view and publish partner menus on OpenTable. The ability to publish and order the menu(s) lives in OpenTable’s back of house functionality.
\nDetailed below: OpenTable for Restaurants Menu management section
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXchmLySQ4Qh3o0jfeV88geksp51kDYldHs_I8Bov-IGAl15BCOs5Y-i0frSSwJBU18PXFchSPn8Ut-irx56jFwK2X2aMlfVfb0fkasYJkDXS0ixZGPKvqFzF0G3QvUTeTwbSjOH0ufMdyCNmhNnzOYDMRA?key=L3GeeWxR_7y13hkkfv8K8A\")
\n\nThe Restaurant will also be able to preview their menu in web and mobile format.
\nDetailed below: Menu previews
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXd89RSomqLip5KLwzAVuVZUg8Ia3c-ZNV_QOOsbmcLq3nmMv6UNSsG1kb0RrujpbIKQFGHu4-NjNjCPPP_Yqta-4gb2SeAeLFEXB4RzDDDeE2fcajXHZ9MW5b6EU0vG-jF4FYjpNUFE-9P7BOe4YxsdPw?key=L3GeeWxR_7y13hkkfv8K8A\")
\n\nThese menus will also be exposed on the OpenTable marketplace
\nDetailed below: OpenTable marketplace profile page with menu
\n","_postman_id":"b07ec18e-70a1-4347-bdd7-cebc5943a03d"},{"name":"Access Menus","item":[{"name":"Get All Menus by Restaurant ID","id":"ea0ee001-de1c-4f49-abd2-a7afdf80a623","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true,"accept-encoding":true,"accept":true,"user-agent":true,"host":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get All Menus by Restaurant ID
\nRetrieves all menus configured for a specific restaurant. The response may contain either:
\n- \n
A direct URL to the restaurant’s web menu, or
\n \nA list of structured native menus including their groups, items, modifier groups, and modifiers.
\n \n
Description
\nThis API fetches all menus associated with a given restaurant ID.
\nDepending on how the restaurant menu is configured, the response may include:
\n- \n
restaurantMenuUrl – A direct link to the restaurant's hosted web menu.
\n \nmenus – A list of structured native menus defined within the platform.
\n \n
If a restaurant uses a web-hosted menu, the menus array will be empty and the restaurantMenuUrl field will contain the link.
If a restaurant uses native menus, the menus array will contain complete menu structures.
Description
\nThis API fetches all menus associated with a given restaurant ID.
\nDepending on how the restaurant menu is configured, the response may include:
\n- \n
restaurantMenuUrl – A direct link to the restaurant's hosted web menu.
\n \nmenus – A list of structured native menus defined within the platform.
\n \n
If a restaurant uses a web-hosted menu, the menus array will be empty and the restaurantMenuUrl field will contain the link.
If a restaurant uses native menus, the menus array will contain complete menu structures.
Menu Structure
\nEach entry in the menus array represents a complete menu hierarchy, including:
- \n
Menu metadata
\n \nGroups (menu categories)
\n \nItems
\n \nModifier groups
\n \nModifiers
\n \n
This structure allows clients to reconstruct the full menu with all relationships.
\n","urlObject":{"path":["v1","menus","rid","{rid}"],"host":["{base-url}"],"query":[],"variable":[]}},"response":[{"id":"4046bc1d-2e74-488a-89ad-3c21aaeeb98c","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 0f2ff294-496b-4294-aaa6-f3fec31f908b","disabled":true},{"key":"Cookie","value":"ak_bmsc=13F3EA593818AB549DBF58F7864B6873~000000000000000000000000000000~YAAQPq3OF4dzsOWcAQAAt2uq8h9PiQef954l+zi4ZaOUO9hQ4K6JJ3enZVc6RvIenuF3CJ9ly6nopMF1GcyYG2K5qi3bGknRmlFXO60MQzVhvxTd85fgNF8T44MFneO05e5M1FJ9R1d9JVMOkkH7IW8+rRYEWcSgfpJaCWuq8g1fC1sJnMSLI5wN2MrLvpyLIAAZ+oPe9zY1MJP/mnp/DgZd2jJ/sMe89+09gCh08g0YPjujlXJWISFFf3GQFlQSEVhFTZZh+d9hEATQNNlGLZ2+sO2HZOJ46xsanDp5GQSeYhfXh4w0k4EqTcwgTPb5U/XkUFDQKyjUbH6GqBovdHJ28Ht/6yyZGBwGS+hQA9k=; bm_sv=044A4770C36D0A06F1515E828C041518~YAAQxVM2Fx11UeWcAQAANoS18h+vOIRzPzGZSe5nFxNRzQXIbGuG58r7HwNOIuRx17HyOXGhJ7J0OYrNn2IqPKh2mlcagxfIegjjySXb0gxA3Er8au4YxgbxSS8Htbeea6GD6sOtFGmeoaE0RrMsW47JcPJ0bf2d+GXokFgR8SfjOECmNkrawOzcMATCGZQ3A8zUJ6VAPIqlgsdJOJEqTOcmfk//Oz8TzEm7ljN+57WYnY3RDTAzUfzczSczF2I68Nfr~1; otuvid=63155CAD-FC36-40BD-8B58-5E2F0AAD8AB6","disabled":true}],"url":"https://platform.opentable.com/v1/menus/rid/1435321"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"f8ea7d0d-c2e9-48fa-9ec6-9552c2ae3663"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"63155CAD-FC36-40BD-8B58-5E2F0AAD8AB6"},{"key":"ot-sessionid","value":"9a723d11-48c2-4cf9-a18e-54f0b9776402"},{"key":"Content-Type","value":"application/json"},{"key":"x-ot-backend","value":"menusReadService"},{"key":"x-ot-uritemplate","value":"/menusReadService/api/v1/restaurants/flattened-menu/{rid}"},{"key":"x-envoy-upstream-service-time","value":"223"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"1988"},{"key":"Expires","value":"Mon, 16 Mar 2026 11:10:05 GMT"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Mar 2026 11:10:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=93E09010D3040F0E04B07E77AD03625D~YAAQFa3OF064kracAQAAsrxW9h9CuoaTWlFj0AxW+3QGvR1ID1HVrbd+HShWriPO3/rqvkRAdnIpYo5+LQqqQ9lZLhUoPlfJf7umGHMcjCCwIEumsTWwrJl5Q0ZESin7tLasVuE06uO4C7eCfIQ5kbsCXIpM32VtzI2Zzh/GdtHfcEETAYkuUSP1y28wvU5dWvKJFxUDNppFjTVhNfLs54gsl4JGdH4sLLLh2bO3NiXiK0U/cdZcc0UX90PUOc4897QA~1; Domain=.opentable.com; Path=/; Expires=Mon, 16 Mar 2026 13:06:03 GMT; Max-Age=6958; SameSite=None; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"rid\": 1435321,\n \"menus\": [\n {\n \"menu\": {\n \"id\": \"05c4f607-8162-442f-a9f6-f6357d286d78\",\n \"name\": \"Happy Hour\",\n \"description\": \"Daily, 3pm - 6pm & 9pm - close + All Day, Tuesdays\",\n \"currency\": \"USD\",\n \"updatedAt\": \"2026-02-20T21:42:47.812\",\n \"ordinal\": 1,\n \"groups\": [\n \"12ed7fb6-7bc5-4c18-8b95-51996088cc71\",\n \"5ee8d10a-3a3c-4fb7-bbbc-224d57c3f5c3\"\n ]\n },\n \"groups\": [\n {\n \"id\": \"12ed7fb6-7bc5-4c18-8b95-51996088cc71\",\n \"name\": \"From the Cocina\",\n \"ordinal\": 100,\n \"items\": [\n \"06500e7f-e48b-4317-8ab3-9150369c9c44\",\n \"692d4fc3-5481-4384-bb69-315c825576b5\",\n \"2bc6d339-4a80-4079-9979-99202d42dace\",\n \"33f05b45-450d-48bf-b15b-9d2fa5732fff\",\n \"86bfd600-0231-46ca-81cf-bc5765704d1d\"\n ]\n },\n {\n \"id\": \"5ee8d10a-3a3c-4fb7-bbbc-224d57c3f5c3\",\n \"name\": \"From the Bar\",\n \"ordinal\": 200,\n \"items\": [\n \"1d218933-83cd-4638-b155-fdf48e7e8e25\",\n \"ebae4aca-ca8b-41cb-a795-35730ee67917\",\n \"7797893f-1e33-44e1-8491-b5582d2bb7c8\",\n \"7bdd5152-cd21-42ea-941f-bdfe4658471e\",\n \"b0f084f9-3637-4b78-8354-6f0faa4e7613\"\n ]\n }\n ],\n \"items\": [\n {\n \"id\": \"692d4fc3-5481-4384-bb69-315c825576b5\",\n \"name\": \"Cachetada\",\n \"description\": \"cheese crusted tortilla\",\n \"ordinal\": 200,\n \"price\": {\n \"amount\": 6.25\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"2bc6d339-4a80-4079-9979-99202d42dace\",\n \"name\": \"Queso Fundido\",\n \"description\": \"melted manchego cheese / served with corn and flour tortillas\",\n \"ordinal\": 300,\n \"price\": {\n \"amount\": 6.5\n },\n \"tags\": [],\n \"modifierGroups\": [\n \"cccd5232-8ed8-49a4-ae5c-2eebced5385d\"\n ]\n },\n {\n \"id\": \"7bdd5152-cd21-42ea-941f-bdfe4658471e\",\n \"name\": \"Chile Pineapple Mango Margarita\",\n \"description\": \"Monte Alban Blanco / Ancho Reyes Chile / Pineapple / Mango / Lime\",\n \"ordinal\": 500,\n \"price\": {\n \"amount\": 10\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"b0f084f9-3637-4b78-8354-6f0faa4e7613\",\n \"name\": \"Tequila & Beer\",\n \"description\": \"Corazón Blanco & Modelo Especial\",\n \"ordinal\": 600,\n \"price\": {\n \"amount\": 11\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"33f05b45-450d-48bf-b15b-9d2fa5732fff\",\n \"name\": \"Churros\",\n \"description\": \"chocolate sauce / cajeta\",\n \"ordinal\": 400,\n \"price\": {\n \"amount\": 6\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"06500e7f-e48b-4317-8ab3-9150369c9c44\",\n \"name\": \"Guacamole\",\n \"ordinal\": 100,\n \"price\": {\n \"amount\": 8.25\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"7797893f-1e33-44e1-8491-b5582d2bb7c8\",\n \"name\": \"LP Margarita\",\n \"description\": \"Monte Alban Silver tequila / agave / lime / Cointreau ($7 on Taco Tuesday)\",\n \"ordinal\": 400,\n \"price\": {\n \"amount\": 8.5\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"ebae4aca-ca8b-41cb-a795-35730ee67917\",\n \"name\": \"Wine by the glass\",\n \"description\": \"House Red or White\",\n \"ordinal\": 300,\n \"price\": {\n \"amount\": 7.5\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"86bfd600-0231-46ca-81cf-bc5765704d1d\",\n \"name\": \"À la Carte Tacos\",\n \"description\": \"Ribeye / Carnitas / Chicken Tinga / Street Corn ($3 each on Taco Tuesday)\",\n \"ordinal\": 500,\n \"price\": {\n \"amount\": 4.25\n },\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"1d218933-83cd-4638-b155-fdf48e7e8e25\",\n \"name\": \"Draft Beer\",\n \"description\": \"\",\n \"ordinal\": 200,\n \"price\": {\n \"amount\": 6\n },\n \"tags\": [],\n \"modifierGroups\": [\n \"1dd57f8a-1546-4def-b6ef-5d28fb806d2d\"\n ]\n }\n ],\n \"modifierGroups\": [\n {\n \"id\": \"1dd57f8a-1546-4def-b6ef-5d28fb806d2d\",\n \"name\": \"Make it a Michelada\",\n \"ordinal\": 200,\n \"minChoices\": 1,\n \"maxChoices\": 1,\n \"modifiers\": [\n \"b20b34e8-ad0c-43a5-8cb7-b67f3dd88613\"\n ]\n },\n {\n \"id\": \"cccd5232-8ed8-49a4-ae5c-2eebced5385d\",\n \"name\": \"Chorizo\",\n \"ordinal\": 100,\n \"minChoices\": 1,\n \"maxChoices\": 1,\n \"modifiers\": [\n \"e9340049-5715-4981-ac05-302399556d3e\"\n ]\n }\n ],\n \"modifiers\": [\n {\n \"id\": \"e9340049-5715-4981-ac05-302399556d3e\",\n \"name\": \"Chorizo\",\n \"ordinal\": 0,\n \"price\": {\n \"amount\": 3\n }\n },\n {\n \"id\": \"b20b34e8-ad0c-43a5-8cb7-b67f3dd88613\",\n \"name\": \"Make it a Michelada\",\n \"ordinal\": 0,\n \"price\": {\n \"amount\": 1\n }\n }\n ]\n },\n {\n \"menu\": {\n \"id\": \"cdad1e9a-f269-4981-9173-50728be964df\",\n \"name\": \"Lunch Menu ($25 per guest)\",\n \"description\": \"Monday - Friday, 11am - 2pm\",\n \"currency\": \"USD\",\n \"updatedAt\": \"2026-02-20T21:42:47.811\",\n \"ordinal\": 2,\n \"groups\": [\n \"3f7411b1-e82b-4353-978f-82f2d67efb92\",\n \"e40966a0-9511-47ac-b05f-672e62c1123c\"\n ]\n },\n \"groups\": [\n {\n \"id\": \"3f7411b1-e82b-4353-978f-82f2d67efb92\",\n \"name\": \"Starter\",\n \"description\": \"Choice of one\",\n \"ordinal\": 200,\n \"items\": [\n \"fa8d9df2-6219-4e74-89bf-df31eb5538e9\",\n \"93c9f258-5105-438b-b5f8-9ea3af2be739\",\n \"baa68d08-9833-425b-8a08-291dd12920bf\"\n ]\n },\n {\n \"id\": \"e40966a0-9511-47ac-b05f-672e62c1123c\",\n \"name\": \"Entrée\",\n \"description\": \"Choice of one\",\n \"ordinal\": 100,\n \"items\": [\n \"64ea6966-6283-48b1-b117-ffce2440eef5\",\n \"28e2935b-61c2-4ed2-8cf1-1896828d146e\",\n \"feb6e710-4179-4ac5-bf02-5bc48e8b4d39\",\n \"41ba5fb1-6d66-4d50-96d6-f5047425622f\"\n ]\n }\n ],\n \"items\": [\n {\n \"id\": \"41ba5fb1-6d66-4d50-96d6-f5047425622f\",\n \"name\": \"Tacos\",\n \"description\": \"CARNITAS, CHICKEN TINGA, STEET CORN or RIBEYE served with rice and beans\",\n \"ordinal\": 300,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"28e2935b-61c2-4ed2-8cf1-1896828d146e\",\n \"name\": \"Torta\",\n \"description\": \"SHAVED RIBEYE, CHICKEN, or CARNITAS shredded lettuce / guacamole / pico de gallo / queso fresco / chipotle aioli / tajín fries\",\n \"ordinal\": 100,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"feb6e710-4179-4ac5-bf02-5bc48e8b4d39\",\n \"name\": \"Enchiladas\",\n \"description\": \"SUIZA CHICKEN or QUESO cheese blend / crema / cilantro / guacamole / red onion\",\n \"ordinal\": 200,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"baa68d08-9833-425b-8a08-291dd12920bf\",\n \"name\": \"Tortilla Soup\",\n \"description\": \"chicken / fried ancho chiles / tortilla strips / avocado / chicharrón / queso fresco / lime\",\n \"ordinal\": 200,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"fa8d9df2-6219-4e74-89bf-df31eb5538e9\",\n \"name\": \"Queso Fundido\",\n \"description\": \"melted cheese blend / corn & flour tortillas\",\n \"ordinal\": 0,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"64ea6966-6283-48b1-b117-ffce2440eef5\",\n \"name\": \"Corn Off the Cob Salad\",\n \"description\": \"STEAK or CHICKEN lettuce mix / corn / sweet peppers / cilantro / avocado / cotija / corn nuts / lime vinaigrette\",\n \"ordinal\": 0,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"93c9f258-5105-438b-b5f8-9ea3af2be739\",\n \"name\": \"Guacamole\",\n \"ordinal\": 100,\n \"tags\": [],\n \"modifierGroups\": []\n }\n ],\n \"modifierGroups\": [],\n \"modifiers\": []\n }\n ]\n}"}],"_postman_id":"ea0ee001-de1c-4f49-abd2-a7afdf80a623"},{"name":"GET MENU BY ID","id":"fa9bf88b-b19a-4a49-b308-b125e67c5e07","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"accept":true,"connection":true,"accept-encoding":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get Menu by ID
\nRetrieves the complete details of a specific menu for a given restaurant. The response includes the menu structure along with its groups, items, modifier groups, and modifiers.
\nDescription
\nThis API returns the full menu structure for a restaurant based on the provided restaurant ID (rid) and menu ID (menu-id).
The response includes:
\n- \n
Menu metadata
\n \nMenu groups (categories)
\n \nMenu items
\n \nModifier groups
\n \nModifiers
\n \n
This allows clients to reconstruct the entire menu hierarchy for display or processing.
\nPath Parameters
\nExample Request
\nGET {base-url}/v1/menus/rid/{RID}/menu/{menu-id}
\nError Responses
\n","urlObject":{"path":["v1","menus","rid","{rid}","menu","{menu-id}"],"host":["{base-url}"],"query":[],"variable":[]}},"response":[{"id":"3a51b2f7-1571-4bb3-a10a-1dfbddca2d4c","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 0f2ff294-496b-4294-aaa6-f3fec31f908b","disabled":true},{"key":"Cookie","value":"ak_bmsc=13F3EA593818AB549DBF58F7864B6873~000000000000000000000000000000~YAAQPq3OF4dzsOWcAQAAt2uq8h9PiQef954l+zi4ZaOUO9hQ4K6JJ3enZVc6RvIenuF3CJ9ly6nopMF1GcyYG2K5qi3bGknRmlFXO60MQzVhvxTd85fgNF8T44MFneO05e5M1FJ9R1d9JVMOkkH7IW8+rRYEWcSgfpJaCWuq8g1fC1sJnMSLI5wN2MrLvpyLIAAZ+oPe9zY1MJP/mnp/DgZd2jJ/sMe89+09gCh08g0YPjujlXJWISFFf3GQFlQSEVhFTZZh+d9hEATQNNlGLZ2+sO2HZOJ46xsanDp5GQSeYhfXh4w0k4EqTcwgTPb5U/XkUFDQKyjUbH6GqBovdHJ28Ht/6yyZGBwGS+hQA9k=; bm_sv=044A4770C36D0A06F1515E828C041518~YAAQvlI2F0FjKLecAQAAKh+t8h9PwqY2e5pl8nyFVMaRHspE6JUATR01/vJ5Jgp5hvMUx8G9D0eE9pSrB6fsVsJR0QL8KqJ2mqjRnKQWAkoS+rOIPbOMjRepkqLbKbVfASBCxq6shaZgvZWjmlop4AjYFf25+0xmFNBVnypOL5Tfhm+9WfpSqXE2kJAxFDrYZwSmvZU8P+xsklcFZz3JiIk3eWjsCEKzQHAkAzg2RxCnQDoDyiQ+iWpvSGeQJHITMFsG~1; otuvid=63155CAD-FC36-40BD-8B58-5E2F0AAD8AB6","disabled":true}],"url":"https://platform.opentable.com/v1/menus/rid/1435321//menu/cdad1e9a-f269-4981-9173-50728be964df"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"27887e61-e508-46b7-82a9-4463908894a6"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"63155CAD-FC36-40BD-8B58-5E2F0AAD8AB6"},{"key":"ot-sessionid","value":"eb9068b3-2aa6-45c7-a3c2-331de01c1ce5"},{"key":"Content-Type","value":"application/json"},{"key":"x-ot-backend","value":"menusReadService"},{"key":"x-ot-uritemplate","value":"/menusReadService/api/v1/restaurants/flattened-menu/{rid}/menu/{menuId}"},{"key":"x-envoy-upstream-service-time","value":"254"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"942"},{"key":"Expires","value":"Mon, 16 Mar 2026 11:06:03 GMT"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Mar 2026 11:06:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=93E09010D3040F0E04B07E77AD03625D~YAAQBf7UF4fTXuScAQAAwgtT9h/fdgs+II2tiNx9YDjtqh+Z2xyuUmMcBRzy98w2xguTAG5E8ZUh9+ldkEB8LxmEnfvk2jMoGo6rzHwhmPFS0++dpKCqcWXp2WofsFS6d67DZWwZmYQ3c75pTyIpdt0VmpdhYuSbL+e4K0RaLe0u/uEVx4wkt4USEf5XVZ+abuye6bA0VomVrCSLDp3XvzXcUb/wRr5XS4gCL/Q18lvDgwzN6RlLB2HjrZ98umkggcuf~1; Domain=.opentable.com; Path=/; Expires=Mon, 16 Mar 2026 13:06:03 GMT; Max-Age=7200; SameSite=None; Secure"}],"cookie":[],"responseTime":null,"body":"{\n \"menu\": {\n \"id\": \"cdad1e9a-f269-4981-9173-50728be964df\",\n \"name\": \"Lunch Menu ($25 per guest)\",\n \"description\": \"Monday - Friday, 11am - 2pm\",\n \"currency\": \"USD\",\n \"updatedAt\": \"2026-02-20T21:42:47.811\",\n \"ordinal\": 2,\n \"groups\": [\n \"3f7411b1-e82b-4353-978f-82f2d67efb92\",\n \"e40966a0-9511-47ac-b05f-672e62c1123c\"\n ]\n },\n \"groups\": [\n {\n \"id\": \"3f7411b1-e82b-4353-978f-82f2d67efb92\",\n \"name\": \"Starter\",\n \"description\": \"Choice of one\",\n \"ordinal\": 200,\n \"items\": [\n \"fa8d9df2-6219-4e74-89bf-df31eb5538e9\",\n \"93c9f258-5105-438b-b5f8-9ea3af2be739\",\n \"baa68d08-9833-425b-8a08-291dd12920bf\"\n ]\n },\n {\n \"id\": \"e40966a0-9511-47ac-b05f-672e62c1123c\",\n \"name\": \"Entrée\",\n \"description\": \"Choice of one\",\n \"ordinal\": 100,\n \"items\": [\n \"64ea6966-6283-48b1-b117-ffce2440eef5\",\n \"28e2935b-61c2-4ed2-8cf1-1896828d146e\",\n \"feb6e710-4179-4ac5-bf02-5bc48e8b4d39\",\n \"41ba5fb1-6d66-4d50-96d6-f5047425622f\"\n ]\n }\n ],\n \"items\": [\n {\n \"id\": \"41ba5fb1-6d66-4d50-96d6-f5047425622f\",\n \"name\": \"Tacos\",\n \"description\": \"CARNITAS, CHICKEN TINGA, STEET CORN or RIBEYE served with rice and beans\",\n \"ordinal\": 300,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"28e2935b-61c2-4ed2-8cf1-1896828d146e\",\n \"name\": \"Torta\",\n \"description\": \"SHAVED RIBEYE, CHICKEN, or CARNITAS shredded lettuce / guacamole / pico de gallo / queso fresco / chipotle aioli / tajín fries\",\n \"ordinal\": 100,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"feb6e710-4179-4ac5-bf02-5bc48e8b4d39\",\n \"name\": \"Enchiladas\",\n \"description\": \"SUIZA CHICKEN or QUESO cheese blend / crema / cilantro / guacamole / red onion\",\n \"ordinal\": 200,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"baa68d08-9833-425b-8a08-291dd12920bf\",\n \"name\": \"Tortilla Soup\",\n \"description\": \"chicken / fried ancho chiles / tortilla strips / avocado / chicharrón / queso fresco / lime\",\n \"ordinal\": 200,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"fa8d9df2-6219-4e74-89bf-df31eb5538e9\",\n \"name\": \"Queso Fundido\",\n \"description\": \"melted cheese blend / corn & flour tortillas\",\n \"ordinal\": 0,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"64ea6966-6283-48b1-b117-ffce2440eef5\",\n \"name\": \"Corn Off the Cob Salad\",\n \"description\": \"STEAK or CHICKEN lettuce mix / corn / sweet peppers / cilantro / avocado / cotija / corn nuts / lime vinaigrette\",\n \"ordinal\": 0,\n \"tags\": [],\n \"modifierGroups\": []\n },\n {\n \"id\": \"93c9f258-5105-438b-b5f8-9ea3af2be739\",\n \"name\": \"Guacamole\",\n \"ordinal\": 100,\n \"tags\": [],\n \"modifierGroups\": []\n }\n ],\n \"modifierGroups\": [],\n \"modifiers\": []\n}"}],"_postman_id":"fa9bf88b-b19a-4a49-b308-b125e67c5e07"}],"id":"d2d6aa8d-a8d9-4111-9811-1058b23c52a1","description":"Overview
\nThe Access Menus functionality allows partners to retrieve restaurant menu data from OpenTable for use in their own applications, such as websites, mobile apps, or ordering experiences. This is done via GET endpoints that return structured menu data, enabling partners to display menu items, categories, descriptions, and pricing in a consistent and scalable way. This supports a range of use cases, from enhancing restaurant discovery experiences to powering downstream integrations like ordering or guest engagement.
\nMenu availability is dependent on each restaurant’s configuration and OpenTable’s distribution rights. As a result, responses may not always include a restaurant’s full menu, and some restaurants may not return menu data at all. Partners should design their integrations to gracefully handle partial or missing data, and avoid assuming full menu coverage across all restaurants.
\n","_postman_id":"d2d6aa8d-a8d9-4111-9811-1058b23c52a1"}],"id":"189b21a3-c5f0-4ecf-a60e-9e8be41befcd","description":"The Menus APIs provide flexible integration options for managing restaurant menus within OpenTable. Partners can:
\n- \n
Publish menus by submitting menu data directly to OpenTable
\n \nAccess menus by retrieving available menu data for supported restaurants
\n \n
Request headers:
\n- \n
Content
\n- \n
Content-Encoding: gzip and zipped content (Preferred)
\n \nContent-Type: application/json (Supported)
\n \n
\nAuthorization: bearer
\n \n
Response: application/json
\nThis API is the most crucial for the OpenTable POS Integration, as it powers most of the functionality. It's important to note that while some attributes are considered optional from a technical perspective,all attributes are required for the integration to work properly.
\nAPI support:
\n- POST ticket within an envelope with a delivery timestamp
- Payload file size limit of 1 MB
- UTC format required for all times within the tickets and the batch payload
- Currency format:https://stripe.com/docs/currencies#zero-decimal
- API is asynchronous for faster performance
ticket
\norder_items
\nitem
\nmodifiers
\ncheck_total
\npayment_info
\nrevenue_center
\ntables
\ncheck_links
\nemployee
\n","urlObject":{"path":["pos","locations","{{rid}}","tickets",""],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"38a75a90-aa4c-42b9-b429-adea9c6a14f6","name":"200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Content-Encoding","value":"application/gzip","type":"text","disabled":true},{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"timestamp\": \"2024-11-07T14:20:12.000+00:00\",\n \"operation\": \"update\",\n \"ticket\": {\n \"ticket_id\": \"abcd12345\",\n \"ticket_number\": \"123456\",\n \"opened_at\": \"2024-11-07T14:20:12.000+00:00\",\n \"updated_at\": \"2024-11-07T14:20:12.000+00:00\",\n \"closed_at\": null,\n \"party_size\": 3,\n \"order_type\": \"Order in\",\n \"order_items\": [\n {\n \"id\": \"12345\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"quantity\": 1,\n \"sent_at\": \"2023-04-21T01:12:12.000+00:00\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"100\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"categories\": [\n {\n \"id\": \"99\",\n \"name\": \"SEAFOOD\",\n \"level\": 2,\n \"parent_menu_category\": {\n \"id\": \"16\",\n \"name\": \"MAINS\",\n \"level\": 1,\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"name\": \"FOOD\",\n \"level\": 0\n }\n }\n }\n ],\n \"open\": false\n },\n \"modifiers\": [],\n \"server_note\": null\n },\n {\n \"id\": \"15754\",\n \"name\": \"French Fries\",\n \"price\": 700,\n \"quantity\": 2,\n \"sent_at\": \"2018-07-26T14:10:12.000+00:00\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"110\",\n \"name\": \"French Fries\",\n \"price\": 350,\n \"categories\": [\n {\n \"id\": \"98\",\n \"name\": \"EXTRAS\",\n \"level\": 2,\n \"parent_menu_category\": {\n \"id\": \"15\",\n \"name\": \"SIDES\",\n \"level\": 1,\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"name\": \"FOOD\",\n \"level\": 0\n }\n }\n }\n ],\n \"open\": false\n },\n \"modifiers\": [],\n \"server_note\": null\n }\n ],\n \"check_total\": {\n \"items_total\": 1900,\n \"tax\": 190,\n \"service_charges\": 0,\n \"other_charges\": 0,\n \"menu_items\": 2,\n \"discount\": 0,\n \"sub_total\": 1900,\n \"total\": 2090,\n \"tip\": 0,\n \"due\": 2090,\n \"paid_amount\": 0\n },\n \"payment_info\": [],\n \"revenue_center\": {\n \"id\": \"112\",\n \"name\": \"Dine-In\"\n },\n \"tables\": {\n \"id\": \"121\",\n \"name\": \"1\",\n \"seats\": 2\n },\n \"check_links\": null,\n \"employee\": {\n \"id\": \"21382\",\n \"firstname\": \"Trevor\",\n \"lastname\": \"Parsons\"\n },\n \"notes\": null,\n \"table_status\": \"entree\",\n \"reservation_id\": \"60482a12-ce23-46e6-a41d-f16e922ced5c\",\n \"is_open\": true,\n \"void\": false\n }\n}"},"url":"{{base-url}}/pos/locations/{{rid}}/tickets/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"9f8f8d73-e2f9-4d54-8801-fc6e32c58e37"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"fa4fcfc3-ee2b-402c-ae61-b451b214d979"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"pdp"},{"key":"X-OT-UriTemplate","value":"/pdp/writeback/v2/pos/direct/rid/{id}/check"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:11:16 GMT"},{"key":"Content-Length","value":"110"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"itemStatus\": [\n {\n \"itemId\": \"abcd12345:2024-11-07\",\n \"status\": \"Processing\"\n }\n ],\n \"totalItems\": 1,\n \"totalProcessedItems\": 1\n}"}],"_postman_id":"119fa4c7-f03a-4805-875e-761971cd5328"},{"name":"POS Fetch Restaurants API","id":"ed6dda93-77f1-4b56-b6e9-e0207faace58","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [token]","type":"text"}],"url":"{{base-url}}/pos/restaurants","description":"Request headers:
\n- \n
Content-Type: application/json
\n \nAuthorization: bearer
\n \n
This is used for a POS Partner to know if a restaurant is available or online on the OpenTable partnership. This would be used after Onboarding to maintain an accurate list of restaurants. This will be considered optional functionality for the POS Partner.
\n","urlObject":{"path":["pos","restaurants"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"0c00dbac-b108-4cba-9900-7dd26ae58653","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [token]","type":"text"}],"url":"{{base-url}}/pos/restaurants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"8cc11712-7674-4a96-9bfc-f751060671f0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"5f9f6a89-304b-4154-8099-6af169716afb"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"posRestaurantService"},{"key":"X-OT-UriTemplate","value":"/posRestaurantService/api/v1/pos/restaurants/all"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:14:56 GMT"},{"key":"Content-Length","value":"217"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"ak_bmsc=3463BA8A2F5F898E431053FB11A4FC81~000000000000000000000000000000~YAAQrMgwFzVFvxSVAQAAeVpJJhqT4Q+RrwCMj6eV9YZ73di5fgE47UgzVvn5/Dj7JmO3MdDssZ1Es52ACr6QuguhqG9rakimmHM4CGWMuhrug8m41vdiT8Nq+EgNkb0MsSNgtEF57YplW/pGm3fvP5brV8anMVe8cU9+26gYbmv+IIxIU+ns2n4atOARAabg3Q6/39lJv0u68WbhTutL8R6hgbZRbfpkLCyonbQZL6+sA7bHj+2W61KirChF5M/IUM1uo+QcQsbiEWW1ybajDV3K+CBz9QK24YU8TpCruubKI2PPPtmUplAZsN23rw5WnSpMp5Y04qtml8MojOeOpNK2gcxxiN/FzVAbyvQ=; Domain=.opentable.com; Path=/; Expires=Fri, 21 Feb 2025 04:14:56 GMT; Max-Age=7200"}],"cookie":[],"responseTime":null,"body":"{\n \"pos_restaurants\": [\n {\n \"rid\": 1234567,\n \"restaurant_name\": \"Vogel's Bistro\",\n \"source_location_id\": \"1234567\",\n \"pos_type\": \"podbrand\",\n \"status\": \"enabled\",\n \"source_location_status\": \"online\",\n \"datetime_of_first_check\": \"2023-11-28T02:46:00Z\",\n \"datetime_of_last_check\": \"2025-02-11T17:41:00Z\"\n }\n ],\n \"total\": 1\n}"}],"_postman_id":"ed6dda93-77f1-4b56-b6e9-e0207faace58"},{"name":"POS Status API","id":"688d75fe-5a31-482c-aafc-04999ef3911e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"status\": \"online\",\n \"cancel_reason\": null,\n \"date_modified_utc\": \"2024-10-18T19:00:18.3878552Z\"\n },\n \"system_clock_time\": \"2024-10-18T19:00:18.3878552Z\"\n}"},"url":"{{base-url}}/pos/restaurants/{{rid}}/location/status","description":"An OT endpoint called by the POS partner per restaurant to provide a “heartbeat” status update of the restaurant’s integration status and local system clock time to check for drift. OpenTable expects the POS partner to send a status update per restaurant every 5 minutes.
\nThis API is required for On-Premise and Hybrid Integrations, but it is optional for Cloud-Based Integrations.
\nNote: Depending on the POS partner, this endpoint is also utilized during a restaurant’s initial onboarding process. It is also utilized by the POS partner if a restaurant’s cancellation of POS integration is initiated on the POS partner’s end by sending as Cancelled.
\n","urlObject":{"path":["pos","restaurants","{{rid}}","location","status"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"2de652f9-e5e6-44df-948e-e365a241600e","name":"200","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"status\": \"online\",\n \"cancel_reason\": null,\n \"date_modified_utc\": \"2024-10-18T19:00:18.3878552Z\"\n },\n \"system_clock_time\": \"2024-10-18T19:00:18.3878552Z\"\n}"},"url":"{{base-url}}/pos/restaurants/{{rid}}/location/status"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"204ab155-7805-4133-9bca-a2ef28926238"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"48d30d4d-31e0-42ea-be51-e9f1df61efea"},{"key":"X-OT-Backend","value":"posRestaurantService"},{"key":"X-OT-UriTemplate","value":"/posRestaurantService/api/v1/pos/restaurants/{id}/location/status"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Fri, 21 Feb 2025 03:22:48 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"bm_sv=4C55DCB38640892E7FBA1B7C6BC60581~YAAQVGrcF3f+tvqUAQAAH3+HJhpPSsz8ItXJmmVPpEYjyDcTyKMJwB4rCQcLyXkZkvc6ephzaEfv07Cins4aBhIRrz0mOO/DStyU7+lB/NcFk13G5+PEEhQMxn3DgHjA2ITBSqUZyurjm+4sVZjlahF5oJrE2GTCWMnE3DJ8lvk/ry5u5lLI67+HvPphDkwT9iL8Rlv0krNBhQtZ5gx556uMNmkQPGBA3MD0ETUcubtPN+JnXtPiiTYeQNjDuashT4F+~1; Domain=.opentable.com; Path=/; Expires=Fri, 21 Feb 2025 05:19:59 GMT; Max-Age=7031; Secure"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"688d75fe-5a31-482c-aafc-04999ef3911e"},{"name":"POS Bootstrap API","id":"95c9fd58-9062-4d81-ace6-a11d2174d75a","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"- POST ticket within an envelope with a delivery timestamp
- Payload file size limit of 1 MB
- UTC format required for all times within the tickets and the batch payload
- Currency format:https://stripe.com/docs/currencies#zero-decimal
- API is asynchronous for faster performance
Bootstrap API
\nURL: /v1/pos/restaurants/{{rid}}/tickets
\n- \n
Content
\n- \n
Content-Encoding: gzip and zipped content (Preferred)
\n \nContent-Type: application/json (Supported)
\n \n
\nAuthorization: bearer
\n \n
Response: application/json
\nAPI support:
\n- \n
GET ticket within an envelope with a delivery timestamp
\n \nUTC format required for all timestamps within the tickets and the batch payload
\n \nCurrency format: https://stripe.com/docs/currencies#zero-decimal
\n \n
Query Parameters
\nResponse Attributes
\nticket
\norder_items
\nitem
\nmodifiers
\ncheck_total
\npayment_info
\nrevenue_center
\ntables
\nemployee
\nguest
\nError Responses
\nResponse: application/json
\n","urlObject":{"path":["v1","pos","restaurants","{{rid}}","tickets"],"host":["{{base-url}}"],"query":[{"key":"updated_from","value":"{{YYYY-MM-DDThh:mm:ss.sssZ}}"},{"key":"updated_to","value":"{{YYYY-MM-DDThh:mm:ss.sssZ}}"},{"key":"limit","value":"{{limit}}"}],"variable":[]}},"response":[{"id":"40518596-c121-480f-8034-6a5e251ca296","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Content-Encoding","value":"application/gzip","type":"text","disabled":true},{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"timestamp\": \"2024-11-07T14:20:12.000+00:00\",\n \"operation\": \"update\",\n \"ticket\": {\n \"ticket_id\": \"abcd12345\",\n \"ticket_number\": \"123456\",\n \"opened_at\": \"2024-11-07T14:20:12.000+00:00\",\n \"updated_at\": \"2024-11-07T14:20:12.000+00:00\",\n \"closed_at\": null,\n \"party_size\": 3,\n \"order_type\": \"Order in\",\n \"order_items\": [\n {\n \"id\": \"12345\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"quantity\": 1,\n \"sent_at\": \"2023-04-21T01:12:12.000+00:00\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"100\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"categories\": [\n {\n \"id\": \"99\",\n \"name\": \"SEAFOOD\",\n \"level\": 2,\n \"parent_menu_category\": {\n \"id\": \"16\",\n \"name\": \"MAINS\",\n \"level\": 1,\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"name\": \"FOOD\",\n \"level\": 0\n }\n }\n }\n ],\n \"open\": false\n },\n \"modifiers\": [],\n \"server_note\": null\n }\n ],\n \"check_total\": {\n \"items_total\": 1200,\n \"tax\": 120,\n \"service_charges\": 0,\n \"other_charges\": 0,\n \"menu_items\": 1,\n \"discount\": 0,\n \"sub_total\": 1200,\n \"total\": 1320,\n \"tip\": 0,\n \"due\": 1320,\n \"paid_amount\": 0\n },\n \"payment_info\": [],\n \"revenue_center\": {\n \"id\": \"112\",\n \"name\": \"Dine-In\"\n },\n \"tables\": {\n \"id\": \"121\",\n \"name\": \"1\",\n \"seats\": 2\n },\n \"check_links\": null,\n \"employee\": {\n \"id\": \"21382\",\n \"firstname\": \"Trevor\",\n \"lastname\": \"Parsons\"\n },\n \"notes\": null,\n \"table_status\": \"entree\",\n \"reservation_id\": null,\n \"is_open\": true,\n \"void\": false\n }\n}"},"url":{"raw":"{{base-url}}/v1/pos/restaurants/{{rid}}/tickets?updated_from={{YYYY-MM-DDThh:mm:ss.sssZ}}&updated_to={{YYYY-MM-DDThh:mm:ss.sssZ}}&limit={{limit}}","host":["{{base-url}}"],"path":["v1","pos","restaurants","{{rid}}","tickets"],"query":[{"key":"updated_from","value":"{{YYYY-MM-DDThh:mm:ss.sssZ}}"},{"key":"updated_to","value":"{{YYYY-MM-DDThh:mm:ss.sssZ}}"},{"key":"limit","value":"{{limit}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"946d230e-3b22-430c-b49b-0bb9df77578a"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"c10bb83f-de4c-4a91-bf8e-b72c3d956443"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"posDataService"},{"key":"X-OT-UriTemplate","value":"/posDataService/api/v1/pos/restaurants/{id}/tickets"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:23:45 GMT"},{"key":"Content-Length","value":"860"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-02-21T02:23:45.921434493Z\",\n \"limit\": 10,\n \"offset\": 0,\n \"next_page_url\": null,\n \"tickets\": [\n {\n \"ticket\": {\n \"ticket_id\": \"abcd12345\",\n \"ticket_number\": \"123456\",\n \"opened_at\": \"2024-11-08T14:56:12.000Z\",\n \"updated_at\": \"2024-11-08T15:10:34.366Z\",\n \"party_size\": 3,\n \"order_type\": \"Order in\",\n \"order_items\": [\n {\n \"id\": \"12345\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"quantity\": 1,\n \"sent_at\": \"2023-04-21T01:12:12.000Z\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"100\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"categories\": [\n {\n \"id\": \"99\",\n \"level\": 2,\n \"name\": \"SEAFOOD\",\n \"parent_menu_category\": {\n \"id\": \"16\",\n \"level\": 1,\n \"name\": \"MAINS\",\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"level\": 0,\n \"name\": \"FOOD\"\n }\n }\n }\n ]\n },\n \"modifiers\": []\n },\n {\n \"id\": \"15754\",\n \"name\": \"French Fries\",\n \"price\": 700,\n \"quantity\": 2,\n \"sent_at\": \"2018-07-26T14:10:12.000Z\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"110\",\n \"name\": \"French Fries\",\n \"price\": 350,\n \"categories\": [\n {\n \"id\": \"98\",\n \"level\": 2,\n \"name\": \"EXTRAS\",\n \"parent_menu_category\": {\n \"id\": \"15\",\n \"level\": 1,\n \"name\": \"SIDES\",\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"level\": 0,\n \"name\": \"FOOD\"\n }\n }\n }\n ]\n },\n \"modifiers\": []\n }\n ],\n \"check_total\": {\n \"items_total\": 1900,\n \"tax\": 190,\n \"tip\": 0,\n \"paid_amount\": 0,\n \"other_charges\": 0,\n \"due\": 2090,\n \"discount\": 0,\n \"service_charges\": 0,\n \"sub_total\": 1900,\n \"total\": 2090\n },\n \"payment_info\": [],\n \"revenue_center\": {\n \"id\": \"112\",\n \"name\": \"Dine-In\"\n },\n \"tables\": {\n \"name\": \"1\"\n },\n \"employee\": {\n \"id\": \"21382\",\n \"firstname\": \"Trevor\",\n \"lastname\": \"Parsons\"\n },\n \"reservation_id\": \"db36e1d7-5b7f-4237-ba18-2064b3374fae\",\n \"is_open\": true,\n \"void\": false\n }\n },\n {\n \"ticket\": {\n \"ticket_id\": \"abcd12346\",\n \"ticket_number\": \"12347\",\n \"opened_at\": \"2024-11-12T18:35:12.000Z\",\n \"updated_at\": \"2024-11-12T18:37:32.200Z\",\n \"party_size\": 3,\n \"order_type\": \"Order in\",\n \"order_items\": [\n {\n \"id\": \"12345\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"quantity\": 1,\n \"sent_at\": \"2023-04-21T01:12:12.000Z\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"100\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"categories\": [\n {\n \"id\": \"99\",\n \"level\": 2,\n \"name\": \"SEAFOOD\",\n \"parent_menu_category\": {\n \"id\": \"16\",\n \"level\": 1,\n \"name\": \"MAINS\",\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"level\": 0,\n \"name\": \"FOOD\"\n }\n }\n }\n ]\n },\n \"modifiers\": []\n },\n {\n \"id\": \"15754\",\n \"name\": \"French Fries\",\n \"price\": 700,\n \"quantity\": 2,\n \"sent_at\": \"2018-07-26T14:10:12.000Z\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"110\",\n \"name\": \"French Fries\",\n \"price\": 350,\n \"categories\": [\n {\n \"id\": \"98\",\n \"level\": 2,\n \"name\": \"EXTRAS\",\n \"parent_menu_category\": {\n \"id\": \"15\",\n \"level\": 1,\n \"name\": \"SIDES\",\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"level\": 0,\n \"name\": \"FOOD\"\n }\n }\n }\n ]\n },\n \"modifiers\": []\n }\n ],\n \"check_total\": {\n \"items_total\": 1900,\n \"tax\": 190,\n \"tip\": 0,\n \"paid_amount\": 0,\n \"other_charges\": 0,\n \"due\": 2090,\n \"discount\": 0,\n \"service_charges\": 0,\n \"sub_total\": 1900,\n \"total\": 2090\n },\n \"payment_info\": [],\n \"revenue_center\": {\n \"id\": \"112\",\n \"name\": \"Dine-In\"\n },\n \"tables\": {\n \"name\": \"1\"\n },\n \"employee\": {\n \"id\": \"21382\",\n \"firstname\": \"Trevor\",\n \"lastname\": \"Parsons\"\n },\n \"guest\": {\n \"id\": \"1360462d-d01e-41f5-a620-aed7f29c4f27\"\n },\n \"reservation_id\": \"6b5d6fee-d268-4ea1-a318-c8bad8a25b1e\",\n \"is_open\": true,\n \"void\": false\n }\n },\n {\n \"ticket\": {\n \"ticket_id\": \"abcd12345\",\n \"ticket_number\": \"123456\",\n \"opened_at\": \"2024-11-18T17:56:12.000Z\",\n \"updated_at\": \"2024-11-18T18:03:48.236Z\",\n \"party_size\": 3,\n \"order_type\": \"Order in\",\n \"order_items\": [\n {\n \"id\": \"12345\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"quantity\": 1,\n \"sent_at\": \"2023-04-21T01:12:12.000Z\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"100\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"categories\": [\n {\n \"id\": \"99\",\n \"level\": 2,\n \"name\": \"SEAFOOD\",\n \"parent_menu_category\": {\n \"id\": \"16\",\n \"level\": 1,\n \"name\": \"MAINS\",\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"level\": 0,\n \"name\": \"FOOD\"\n }\n }\n }\n ]\n },\n \"modifiers\": []\n },\n {\n \"id\": \"15754\",\n \"name\": \"French Fries\",\n \"price\": 700,\n \"quantity\": 2,\n \"sent_at\": \"2018-07-26T14:10:12.000Z\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"110\",\n \"name\": \"French Fries\",\n \"price\": 350,\n \"categories\": [\n {\n \"id\": \"98\",\n \"level\": 2,\n \"name\": \"EXTRAS\",\n \"parent_menu_category\": {\n \"id\": \"15\",\n \"level\": 1,\n \"name\": \"SIDES\",\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"level\": 0,\n \"name\": \"FOOD\"\n }\n }\n }\n ]\n },\n \"modifiers\": []\n }\n ],\n \"check_total\": {\n \"items_total\": 1900,\n \"tax\": 190,\n \"tip\": 0,\n \"paid_amount\": 0,\n \"other_charges\": 0,\n \"due\": 2090,\n \"discount\": 0,\n \"service_charges\": 0,\n \"sub_total\": 1900,\n \"total\": 2090\n },\n \"payment_info\": [],\n \"revenue_center\": {\n \"id\": \"112\",\n \"name\": \"Dine-In\"\n },\n \"tables\": {\n \"name\": \"1\"\n },\n \"employee\": {\n \"id\": \"21382\",\n \"firstname\": \"Trevor\",\n \"lastname\": \"Parsons\"\n },\n \"reservation_id\": \"e3819c0a-b5c5-4bcd-b3ca-3eca89a19f92\",\n \"is_open\": true,\n \"void\": false\n }\n },\n {\n \"ticket\": {\n \"ticket_id\": \"abcd12345\",\n \"ticket_number\": \"123456\",\n \"opened_at\": \"2024-11-07T14:20:12.000Z\",\n \"updated_at\": \"2025-02-21T02:18:55.374Z\",\n \"party_size\": 3,\n \"order_type\": \"Order in\",\n \"order_items\": [\n {\n \"id\": \"12345\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"quantity\": 1,\n \"sent_at\": \"2023-04-21T01:12:12.000Z\",\n \"status\": \"sent\",\n \"item\": {\n \"id\": \"100\",\n \"name\": \"Cioppino\",\n \"price\": 1200,\n \"categories\": [\n {\n \"id\": \"99\",\n \"level\": 2,\n \"name\": \"SEAFOOD\",\n \"parent_menu_category\": {\n \"id\": \"16\",\n \"level\": 1,\n \"name\": \"MAINS\",\n \"parent_menu_category\": {\n \"id\": \"1\",\n \"level\": 0,\n \"name\": \"FOOD\"\n }\n }\n }\n ]\n },\n \"modifiers\": []\n }\n ],\n \"check_total\": {\n \"items_total\": 1200,\n \"tax\": 120,\n \"tip\": 0,\n \"paid_amount\": 0,\n \"other_charges\": 0,\n \"due\": 1320,\n \"discount\": 0,\n \"service_charges\": 0,\n \"sub_total\": 1200,\n \"total\": 1320\n },\n \"payment_info\": [],\n \"revenue_center\": {\n \"id\": \"112\",\n \"name\": \"Dine-In\"\n },\n \"tables\": {\n \"name\": \"1\"\n },\n \"employee\": {\n \"id\": \"21382\",\n \"firstname\": \"Trevor\",\n \"lastname\": \"Parsons\"\n },\n \"is_open\": true,\n \"void\": false\n }\n }\n ]\n}"}],"_postman_id":"95c9fd58-9062-4d81-ace6-a11d2174d75a"}],"id":"6fd35119-f22d-4e05-a5c1-25f6bb6f463f","description":"This section provides details related to OT’s POS API in which the POS partner writes to, allowing its relevant POS check data to be shared with OT. Additional endpoints allow for the POS partner to receive details on all RIDs’ associated with its POS integration and deliver POS current menu data to OT
\n","_postman_id":"6fd35119-f22d-4e05-a5c1-25f6bb6f463f"},{"name":"Reservation Webhook v3 Copper","item":[{"name":"Reservation Webhook v3 Copper","id":"983d0378-6cff-4f46-a989-2276bde66e35","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"A list of all OpenTable restaurant records specific to the POS partner.
\n","urlObject":{"protocol":"https","host":["partner","supplied","webhook","url"],"query":[],"variable":[]}},"response":[{"id":"8cc07193-b734-4d33-928f-cd0b34ef19bc","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [token]","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"12345\",\r\n \"href\": \"https://api.opentable.com/reservations/12345\",\r\n \"rid\": 6789,\r\n \"sequence_id\": 101112,\r\n \"guest_id\": \"guest-123\",\r\n \"guest\": \"https://api.opentable.com/guests/guest-123\",\r\n \"confirmation_id\": 34567,\r\n \"state\": \"Confirmed\",\r\n \"table_number\": [\"10\"],\r\n \"created_date\": \"2024-12-19T10:15:30\",\r\n \"scheduled_time\": \"2024-12-19T19:00:00\",\r\n \"party_size\": 4,\r\n \"visit_tags\": [\r\n \"birthday\", \r\n \"window seating\"\r\n ],\r\n \"origin\": \"Web\",\r\n \"updated_at\": \"2024-12-19T11:00:00\",\r\n \"seated_time\": null,\r\n \"done_time\": null,\r\n \"scheduled_time_utc\": \"2024-12-19T23:00:00\",\r\n \"guest_request\": \"Vegetarian meal\",\r\n \"venue_notes\": \"VIP customer\",\r\n \"opentable_notes\": \"10% discount applied\",\r\n \"table_category\": \"hightop\",\r\n \"seated_time_utc\": null,\r\n \"done_time_utc\": null,\r\n \"created_date_utc\": \"2024-12-19T15:15:30Z\",\r\n \"updated_at_utc\": \"2024-12-19T16:00:00Z\",\r\n \"server\": \"John Doe\",\r\n \"added_to_waitlist\": null,\r\n \"added_to_waitlist_utc\": null,\r\n \"deposit_details\": {\r\n\t\"totalPaid\": 5000,\r\n\t\"totalRefunded\": 0,\r\n\t\"currency\": \"USD\",\r\n\t\"currencyDenominator\": 100,\r\n\t\"status\": \"Paid\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner.supplied.webhook.url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"8cc11712-7674-4a96-9bfc-f751060671f0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"5f9f6a89-304b-4154-8099-6af169716afb"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"posRestaurantService"},{"key":"X-OT-UriTemplate","value":"/posRestaurantService/api/v1/pos/restaurants/all"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:14:56 GMT"},{"key":"Content-Length","value":"217"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"ak_bmsc=3463BA8A2F5F898E431053FB11A4FC81~000000000000000000000000000000~YAAQrMgwFzVFvxSVAQAAeVpJJhqT4Q+RrwCMj6eV9YZ73di5fgE47UgzVvn5/Dj7JmO3MdDssZ1Es52ACr6QuguhqG9rakimmHM4CGWMuhrug8m41vdiT8Nq+EgNkb0MsSNgtEF57YplW/pGm3fvP5brV8anMVe8cU9+26gYbmv+IIxIU+ns2n4atOARAabg3Q6/39lJv0u68WbhTutL8R6hgbZRbfpkLCyonbQZL6+sA7bHj+2W61KirChF5M/IUM1uo+QcQsbiEWW1ybajDV3K+CBz9QK24YU8TpCruubKI2PPPtmUplAZsN23rw5WnSpMp5Y04qtml8MojOeOpNK2gcxxiN/FzVAbyvQ=; Domain=.opentable.com; Path=/; Expires=Fri, 21 Feb 2025 04:14:56 GMT; Max-Age=7200"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"983d0378-6cff-4f46-a989-2276bde66e35"}],"id":"92b6f2e6-76df-4387-abc9-c6d6771c5332","description":"Overview
\nThe Reservation Webhook API provides real-time updates about changes in reservation status via webhooks. These updates enable restaurants to seamlessly integrate reservation management into their systems. The webhooks send a detailed JSON payload containing reservation attributes whenever a reservation status changes.
\nTo access Guest Data, please use the guest attribute to call the guest endpoint in Sync API. For more information about Sync API and other available data points via the GET query, please refer to the Sync API - Copper section of this Portal.
Data Delivery Method
\nWebhook Implementation
\nWebhooks are triggered on any change in reservation status. A POST request is sent to the specified endpoint with the payload data.
\nConfiguring Your Endpoint
\n- \n
Endpoint URL: Provide an URL where webhook data will be delivered.
\n- \n
- Webhook URL must use https and port 443 \n
\nAuthentication: Basic or bearer token is required to verify authenticity of request
\n \nEvent Handling: Ensure your system handles retries in case of delivery failures.
\n \n
Webhook Security & Validation Requirements
\nTo ensure secure and reliable integrations, all webhook endpoints must comply with the following requirements:
\n1. Redirect Handling
\nWebhook endpoints must not rely on HTTP redirects.
\n- \n
Requests that result in a redirect (3xx responses) will be blocked
\n \nThe configured endpoint must be the final destination URL
\n \nEnsure your endpoint responds directly without forwarding
\n \n
\n
2. URL Schema Validation
\nOnly approved URL schemas are supported for webhook endpoints:
\n- \n
https://— Required for all external endpoints \n
Any other schema (e.g., http://, ftp://) will be rejected.
\n
3. Private Network Restrictions
\nExternal webhook endpoints must resolve to publicly accessible IP addresses.
\n- \n
Endpoints resolving to private or reserved IP ranges will be blocked
\n \nThis includes (but is not limited to):
\n- \n
\n10.x.x.x\n
\n172.16.x.x – 172.31.x.x\n
\n192.168.x.x\n
\n
This restriction helps prevent misconfiguration and protects against unintended access to internal infrastructure.
\n\n
Summary
\n\n
Implementation Guidance
\n- \n
Always provide a fully qualified, final destination HTTPS endpoint
\n \nVerify DNS resolution points to a public IP address
\n \nAvoid intermediary routing layers that introduce redirects
\n \n
Retry Logic
\nWebhook delivery uses an exponential backoff strategy. After three failed attempts, the webhook is marked as undeliverable.
\nAttributes
\nThe webhook payload will not include the same attributes as available in the GET query. To get the additional attributes not delivered in the webhook, Sync API reservataions endpoint will need to be called. Please see the Sync API Copper Reservations API v2 documention for full list of additional attributes.
\nOpenTable reserves the right to update the data sent via the webhook with additional attributes. POS partner should build their ingestion of the webhook to accept any new additional attributes in the future. Partner can choose to process or ignore the additional attributes.
\nThe webhook payload includes the following attributes:
\n","_postman_id":"92b6f2e6-76df-4387-abc9-c6d6771c5332"},{"name":"Reservation Statuses / States","item":[],"id":"59bf1634-4a47-4ae6-a14e-87f8742ef1e2","description":"","_postman_id":"59bf1634-4a47-4ae6-a14e-87f8742ef1e2"}],"id":"69e2188f-d1dd-4811-b425-f9834622220d","description":"Overview
\nPOS Integration allows restaurants to connect their table and reservation data with their point-of-sale (POS) check data, in real time.
\nWith OpenTable POS Integration, restaurants can connect table and reservation data with your point-of-sale system (POS) for a smoother-running, faster-turning, front of house. The POS integration gives restaurants valuable insights into guests’ spend, helps status tables, and highlights your revenue from each diner.
\nAvailable Scenarios for a Standard Bi-Directional Integration
\nConnecting a Check to Reservations
\nThe first, and most important step in the OpenTable POS Integration is connecting a check to a reservation. We strive to connect all reservations to their respective checks on the POS. We connect checks to reservations via Table Matching.
\nAutomated Table Statuses
\nThis feature allows for tables to be automatically updated in OpenTable as menu items are added and fired, allowing the hosts to better understand when the next table may become available. By default, the system will allow show/status Paid.
\nAdditional table statuses include:
\n- \n
Drinks
\n \nAppetizer
\n \nEntree
\n \nDessert
\n \nCourse 1 through 12
\n \nPost Meal Drinks
\n \nBottle Service
\n \n
This OpenTable support article details the feature.
\nCheck Order Details
\nCheck Order details are available for the diner and the restaurant.
\nFor Restaurants:
\nThis allows the restaurant to view checks on the reservation card via the iPad app. You can also navigate to the guest history tab to view POS check details.
\nThis includes:
\n- \n
Total Spend, including subtotal, tax
\n \nTip Amount
\n \nOrdered Menu items
\n \nServer Name
\n \nDate and Time of POS Check
\n \nPOS Check Number
\n \n
Displaying guest data on POS (bidirectional)
\nAs a POS partner, checks can now include or display the guest profile & reservation profile from OpenTable on the POS. This information can be acted upon by a server, and can include dietary restrictions & special events. Reservation Webhooks will send the reservation details via Sync API and retrieve any additional necessary details.
\nReporting
\nRestaurants can dive deeper into their diners' spending as it relates to a diners' lifetime, a specific time frame, or specific reservations. This can better help restaurants identify their regulars and VIPs.
\nReport Options include:
\n- \n
Guest Frequency Report → Available details include: Total Spend, Tip Spend, Lifetime Total Spend, and Lifetime Tip Spend across a defined date range
\n \nReservation Report → Available details include: Total Spend (specific to a single reservation)
\n \nGuest Spend Tracking → Available details include: Lifetime Spend and Lifetime per Cover Spend
\n \n
Shift Revenue Tracking
\nWith POS integration, restaurants can view the restaurant's revenue and check averages within the current shift or a past one. This allows restaurants to compare revenue week-over-week and adjust planning accordingly.
\nEligibility and Technical Requirements
\nOpenTable POS Integration is available only to approved partners that have signed the applicable paperwork and agreed to the terms and conditions. Also note before a POS partner is approved, there will be a Quality Assurance process to ensure the integration is successful.
\nFurthermore, in order to provide users with the intended real-time experience, OT requires the POS partner to provide check updates to OT in as near real-time as possible. All ticket updates should be received by OT no later than 30 seconds after the event occurs in the restaurant’s POS system.
\nAlong with the onboarding, OpenTable requires a QA process to ensure correct functionality.
\n- \n
OpenTable will set up a test account for the POS Partner with the correct timezone.
\n \nThe POS Partner should download the OpenTable software on an iPad to access the system and view the integration in action
\n \nOpenTable and the POS Partner will hold scheduled calls during the QA process
\n \nWe will provide a QA Document to allow the POS Partner to test the functionality. To begin testing, the Ticket API must return code 200 and the POS Company must send us table information
\n \nAs an additional option, OpenTable can set up an external Slack Channel to answer any ad hoc questions or comments
\n \nOnce both parties feel comfortable with the integration, a handful of restaurants will be identified and used to test the integration in a live environment before rolling out completely.
\n \n
Partner Authorization
\nOpenTable POS API Integration is a cloud-based interface. Authorization to access resources on the OpenTable platform will be granted to partners on a single API key basis.
\nOn-premise systems accessing OpenTable resources must make API requests through an authorized cloud gateway (middle layer or proxy) between the calling client and OpenTable server endpoints. OpenTable POS Integration API is bi-directional and does not directly interfere with on-premise (non-cloud) systems.
\nDeveloper Details
\nTechnical Overview
\nData Flows
\n- \n
Reservation and guest data flow from OpenTable
\n \nCheck data flows from POS.
\n \n
Within these two flows, real-time events include the POS partner sending POS check events to OpenTable. And, OpenTable sending reservation events to the POS partner, as seen in the following visual:
\nRetry Policy
\n- \n
Real-time events are considered stale after 1 minute since its last update.
\n \nIf OpenTable fails to deliver a message to the POS partner within the 1 minute window, the event is dropped.
\n \nFor retries in publishing events to the POS partner OpenTable will retry a total of 3 times, with a 1-second interval, before dropping the event completely.
\n \n
If anything was missed after the 3 retries, the check bootstrapping can be leveraged at the end of the night.
\nSequence ID
\nA sequence ID is a unique identifier attributed to each publishing reservation event, in each of the event entities.
\nSequence ID is based on a sequence of numbers that monotonically increase for each restaurant every time a reservation event occurs for that restaurant.
\n- \n
Allows the POS partner to detect when an event has been missed from the real-time system.
\n \nAllows the POS partner to identify which events are more current if update events arrive out of order for the same object.
\n \nAllows the POS partner to synchronize between real-time events and the API data to ensure all events have been recovered.
\n \n
Due to the nature of distributed systems, it cannot be guaranteed that sequence IDs will be published in order. However, by looking at the sequence ID it should be assumed that a higher ID is more current than a lower ID for the same reservation. Hence, if an event with a higher sequence ID is sent first, and an event with lower ID is sent after for the same reservation, then the event with the lower ID should be ignored.
\nMissed Events
\nIn case of a missed event, the POS partner can use our Sync API to pull any necessary historical data to request a bootstrap of all reservation states for a particular restaurant for a particular day.
\nSee System Resiliency and Recovery for details on retrieving missed events.
\nCheck Events
\nThe POS partner publishes POS check events to OT in order to power real-time table statusing in OpenTable for Restaurants and provide data analytic capabilities in OpenTable for Restaurants reporting suite. There are two mechanisms that will be key to ensuring this behavior:
\n- \n
A monotonically-increasing sequence ID is sent along with every POS check event. This sequence ID will reset at the beginning of the restaurant's business day to allow it to be unique per day per restaurant.
\n \nA bootstrap API that takes in an OpenTable Restaurant ID (“RID”), updated_from, and updated_to parameters, and returns a full bootstrap of the restaurant's POS checks between the updated_from and updated_to time frames. The POS partner is expected to store POS checks for a minimum of 7 days.
\n \n
OT consumes POS check events in the following fashion:
\n- \n
Each event is received via REST hooks.
\n \nEvents with lower sequence IDs than previously received sequence IDs related to the same POS check are dropped. Higher sequence IDs are processed in real-time.
\n \nPeriodically calls the bootstrap API to obtain the latest sequence ID and POS checks.
\n \nVerifies each POS check event received from the bootstrap API has been processed. If not, reprocesses the missing POS check event.
\n \n
Matching OpenTable Reservations to POS Checks
\nWhen the POS partner receives an OpenTable for Restaurants reservation event from OT noting that a reservation has been seated in OpenTable for Restaurants, the POS partner either automatically creates a new POS check for that reservation, or visually identifies to the POS user there is an associated OpenTable for Restaurants party at the corresponding table. The POS partner also sends all POS check events to OT, with the option of including the OpenTable for Restaurants reservation_id value if known at the time, allowing OT to confidently match the POS check with the OpenTable for Restaurants reservation.
\nSecondary to that, OT also runs its matching algorithm, which includes:
\n- \n
An exact match of table number between the POS check and OpenTable for Restaurants table
\n \nThe POS check is created no earlier than 30 minutes before and no later than 60 minutes after the OpenTable for Restaurants reservation’s scheduled time
\n \n
OT’s secondary matching algorithm runs in the background in order to allow OT to audit and compare its results with the POS partner’s process. In the scenario that automatic POS check creation functionality has been disabled on the POS partner side, OT’s matching algorithm will step in as the primary matching process.
\nTable Course Statuses
\nOpenTable provides functionality to facilitate course statusing. The functionality can be achieved one of 2 ways.
\nIdeal approach:
\n- \n
- Based on categorization of menu items within the POS software, as applicable the POS partner explicitly sends a ‘table_status’ value _(\"drinks\", \"appetizer\", \"entree\", \"dessert\", \"course_1\" ,\"course_2\", \"course_3\", \"course_4\", \"course_5\", \"course_6\", \"course_7\", \"course_8\", \"course_9\" ,\"course_10\", \"course_11\", \"course_12\", \"post_meal_drinks\", \"bottle_service\", \"paid\")_with each ticket iteration based on ordered items. \n
Alternate, less ideal approach:
\n- \n
Using the POS partner’s menu item categories derived from the _‘ticket’_object, the OpenTable for Restaurants user is presented with an interface to map the various POS menu categories to either Appetizer, Entree, or Dessert.
\n \nOpenTable for Restaurants will adhere to the user designated mappings in determining when ordered POS menu items trigger OpenTable for Restaurants course status updates.
\n \n
Note: Automatic course status updates are progressive in nature, meaning they only move forward in a chronological sense. E.g if a OpenTable for Restaurants user manually updates a seated reservation’s table status to Dessert and later the server orders entrees in the POS, OpenTable for Restaurants will not regress through the meal by updating the reservation’s table status to Entree; the Dessert course status will persist.
\nPaid Status
\nThe “Paid” table status will be applied to a seated OpenTable for Restaurants reservation when either the POS partner provides a value of “paid” on the POS ticket’s ‘table_status’ attribute, or ‘due’ attribute’s value equals zero (after having previously accrued a positive value).
\nFor OpenTable for Restaurants reservations matched to split POS checks, OT will update the OpenTable for Restaurants reservation’s table status to _“Paid”_only when all split checks belonging to the reservation have a table_status value of “paid” or have a due value of zero.
\nSystem Resiliency and Recovery for On-Premise and Hybrid
\nFor On-Premise or Hybrid Integrations, OpenTable can provide a _“heartbeat”_endpoint that returns a list of all relevant RIDs and their latest sequence IDs. A 200 status code response indicates that OT’s system is successfully processing, while the body response with the sequence IDs will allow the POS partner to detect if it has missed any reservation events. This endpoint can be queried as often as desired to meet the POS partner’s need of maintaining consistency.
\n","_postman_id":"69e2188f-d1dd-4811-b425-f9834622220d"},{"name":"Private Dining API","item":[{"name":"Directory API","item":[{"name":"APIs","item":[{"name":"Directory API","id":"5e32bb61-d234-4264-afcb-9911e662ab8a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/sync/directory?limit=10","description":"OpenTable Directory API Documentation
\nOverview
\nThe Directory API gives approved developers the ability to acquire and synchronize restaurants that are visible as search results on the OpenTable website. The Directory API is only available to our Consumer Partners and is not offered to our Restaurant Partners.
\n\n
Endpoint
\nURL: {{base-url}}/sync/directory
\nMethod: GET
\nQuery Parameters
\nResponse Attributes
\nRestaurant Object Attributes
\nProfile_Photo Array
\nProfile_Photo Size Array
\nError Response for Directory
\nError Messaging
\nThe error response details returned by the Directory API collection is in the below format. When reporting issues with the API, always provide the OT-RequestId (requestid from the error body and located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","directory"],"host":["{{base-url}}"],"query":[{"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"c39b48c6-3cb0-4643-b293-e9dd8f798383","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/sync/directory?limit=10","host":["{{base-url}}"],"path":["sync","directory"],"query":[{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_items\": 60895,\n \"offset\": 0,\n \"limit\": 10,\n \"items\": [\n {\n \"rid\": 10,\n \"name\": \"Harris'\",\n \"address\": \"2100 Van Ness Avenue\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.7950668\",\n \"longitude\": \"-122.4229237\",\n \"postal_code\": \"94109\",\n \"phone_number\": \"4156731888\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/10\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/10\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/harris-san-francisco\",\n \"natural_profile_url\": \"http://www.opentable.com/r/harris-san-francisco\",\n \"profile_photo\": {\n \"id\": 79882553,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/3/79882553.png\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/3/79882553.png\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/3/79882553.png\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/3/79882553.png\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/3/79882553.png\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/3/79882553.png\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/3/79882553.png\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/3/79882553.png\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/3/79882553.png\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/3/79882553.png\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/3/79882553.png\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/3/79882553.png\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/3/79882553.png\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/3/79882553.png\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.800\",\n \"price_quartile\": \"$$$$\",\n \"review_count\": 5864,\n \"category\": [\n \"Steakhouse\",\n \"American\",\n \"Steak\"\n ],\n \"hours\": \"Sun 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"openingtimes\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 24,\n \"name\": \"INDO Restaurant & Lounge\",\n \"address\": \"3295 El Camino Real\",\n \"address2\": \"\",\n \"city\": \"Palo Alto\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.4209159\",\n \"longitude\": \"-122.1369480\",\n \"postal_code\": \"94306\",\n \"phone_number\": \"+16504947168\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/24\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/24\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/indo-restaurant-and-lounge-palo-alto\",\n \"natural_profile_url\": \"http://www.opentable.com/r/indo-restaurant-and-lounge-palo-alto\",\n \"profile_photo\": {\n \"id\": 26286947,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/5/26286947.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/5/26286947.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/5/26286947.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/5/26286947.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/5/26286947.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/5/26286947.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/5/26286947.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod/26286947/5/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/5/26286947.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/5/26286947.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/5/26286947.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.700\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 1163,\n \"category\": [\n \"Asian\",\n \"Southeast Asian\",\n \"Indonesian\"\n ],\n \"hours\": \"Lunch\\nDaily 11:00 am–2:00 pm\\n
Dinner\\n
Daily 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"sun\",\n \"mon\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"sun\",\n \"mon\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 33,\n \"name\": \"Wildfire - Chicago\",\n \"address\": \"159 West Erie St.\",\n \"address2\": \"\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"latitude\": \"41.8937860\",\n \"longitude\": \"-87.6334978\",\n \"postal_code\": \"60654\",\n \"phone_number\": \"3127879000\",\n \"metro_name\": \"Chicago / Illinois\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/33\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/33\",\n \"natural_reservation_url\": \"http://www.opentable.com/wildfire-chicago\",\n \"natural_profile_url\": \"http://www.opentable.com/wildfire-chicago\",\n \"profile_photo\": {\n \"id\": 23682457,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/1/23682457.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/1/23682457.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/1/23682457.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/1/23682457.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/1/23682457.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/1/23682457.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/1/23682457.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod/23682457/1/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/1/23682457.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/1/23682457.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/1/23682457.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.400\",\n \"price_quartile\": \"$$\",\n \"review_count\": 8416,\n \"category\": [\n \"American\",\n \"Steak\",\n \"Seafood\"\n ],\n \"hours\": \"Mon–Thu, Sun 4:00 pm–8:30 pm\\n
Fri, Sat 4:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"openingtimes\",\n \"shiftStarts\": \"16:00\",\n \"shiftEnds\": \"20:30\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"sun\"\n ]\n },\n {\n \"name\": \"openingtimes\",\n \"shiftStarts\": \"16:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"sat\",\n \"fri\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 47,\n \"name\": \"Shaw's Crab House & Oyster Bar - Chicago\",\n \"address\": \"21 East Hubbard St.\",\n \"address2\": \"\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"latitude\": \"41.8899100\",\n \"longitude\": \"-87.6274230\",\n \"postal_code\": \"60611\",\n \"phone_number\": \"3125272722\",\n \"metro_name\": \"Chicago / Illinois\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/47\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/47\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/shaws-crab-house-and-oyster-bar-chicago-chicago\",\n \"natural_profile_url\": \"http://www.opentable.com/r/shaws-crab-house-and-oyster-bar-chicago-chicago\",\n \"profile_photo\": {\n \"id\": 68954757,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/2/68954757.png\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/2/68954757.png\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/2/68954757.png\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/2/68954757.png\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/2/68954757.png\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/2/68954757.png\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/2/68954757.png\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/2/68954757.png\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/2/68954757.png\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/2/68954757.png\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/2/68954757.png\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/2/68954757.png\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/2/68954757.png\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/2/68954757.png\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.800\",\n \"price_quartile\": \"$$$$\",\n \"review_count\": 14734,\n \"category\": [\n \"Seafood\",\n \"American\",\n \"Sushi\"\n ],\n \"hours\": \"Lunch\\n
Daily 11:30 am–3:00 pm\\n
Dinner\\n
Mon–Thu, Sun 3:00 pm–9:00 pm\\n
Fri, Sat 3:00 pm–10:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:30\",\n \"shiftEnds\": \"15:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"15:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"mon\",\n \"sun\",\n \"tue\",\n \"wed\",\n \"thu\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"15:00\",\n \"shiftEnds\": \"22:00\",\n \"days\": [\n \"sat\",\n \"fri\"\n ]\n },\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:30\",\n \"shiftEnds\": \"15:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 101,\n \"name\": \"Alcala\",\n \"address\": \"246 East 44th Street\",\n \"address2\": \"\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"latitude\": \"40.7511146\",\n \"longitude\": \"-73.9717761\",\n \"postal_code\": \"10017\",\n \"phone_number\": \"2123701866\",\n \"metro_name\": \"New York City\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/101\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/101\",\n \"natural_reservation_url\": \"http://www.opentable.com/alcala\",\n \"natural_profile_url\": \"http://www.opentable.com/alcala\",\n \"profile_photo\": {\n \"id\": 47526468,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/small.png\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/2/47526468.png\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/2/47526468.png\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/2/47526468.png\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/large.png\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/2/47526468.png\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/2/47526468.png\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/medium.png\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/2/47526468.png\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/2/47526468.png\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod1/47526468/2/huge.png\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/2/47526468.png\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/2/47526468.png\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/2/47526468.png\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.400\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 617,\n \"category\": [\n \"Spanish\",\n \"Latin / Spanish\",\n \"Comfort Food\"\n ],\n \"hours\": \"Lunch\\n
Mon–Fri 12:00 pm–4:30 pm\\n
Dinner\\n
Mon–Fri 5:00 pm–11:00 pm\\n
Sat, Sun 5:30 pm–11:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"12:00\",\n \"shiftEnds\": \"16:30\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"23:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:30\",\n \"shiftEnds\": \"23:00\",\n \"days\": [\n \"sun\",\n \"sat\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": false\n }\n },\n {\n \"rid\": 112,\n \"name\": \"Marin\",\n \"address\": \"1101 4th Ave.\",\n \"address2\": \"\",\n \"city\": \"Seattle\",\n \"state\": \"WA\",\n \"country\": \"US\",\n \"latitude\": \"47.6069535\",\n \"longitude\": \"-122.3340941\",\n \"postal_code\": \"98101\",\n \"phone_number\": \"+12066247755\",\n \"metro_name\": \"Seattle / Eastern Washington\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/112\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/112\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/marin-seattle\",\n \"natural_profile_url\": \"http://www.opentable.com/r/marin-seattle\",\n \"profile_photo\": {\n \"id\": 79033572,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/4/79033572.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/4/79033572.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/4/79033572.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/4/79033572.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/4/79033572.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/4/79033572.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/4/79033572.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/4/79033572.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/4/79033572.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/4/79033572.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/4/79033572.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/4/79033572.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/4/79033572.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/4/79033572.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.300\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 30,\n \"category\": [\n \"Mediterranean\",\n \"American\",\n \"Contemporary American\"\n ],\n \"hours\": \"Breakfast\\n
Mon–Fri 7:00 am–10:00 am\\n
Bar\\n
Sat, Sun 7:00 am–10:00 pm\\n
Brunch\\n
Sat, Sun 8:00 am–2:00 pm\\n
Lunch\\n
Mon–Fri 11:00 am–2:00 pm\\n
Happy Hour\\n
Daily 3:00 pm–5:00 pm\\n
Dinner\\n
Daily 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"10:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"fri\",\n \"wed\",\n \"thu\"\n ]\n },\n {\n \"name\": \"brunch\",\n \"shiftStarts\": \"08:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n },\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"happyhour\",\n \"shiftStarts\": \"15:00\",\n \"shiftEnds\": \"17:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"sun\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"sat\",\n \"sun\",\n \"fri\"\n ]\n },\n {\n \"name\": \"bar\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"22:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 130,\n \"name\": \"Boulevard\",\n \"address\": \"1 Mission St.\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.7932194\",\n \"longitude\": \"-122.3929750\",\n \"postal_code\": \"94105\",\n \"phone_number\": \"+14155436084\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/130\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/130\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/boulevard-san-francisco\",\n \"natural_profile_url\": \"http://www.opentable.com/r/boulevard-san-francisco\",\n \"profile_photo\": {\n \"id\": 51634215,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/2/51634215.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/2/51634215.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/2/51634215.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/2/51634215.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/2/51634215.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/2/51634215.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/2/51634215.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod1/51634215/2/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/2/51634215.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/2/51634215.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/2/51634215.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.900\",\n \"price_quartile\": \"$$$$\",\n \"review_count\": 9311,\n \"category\": [\n \"Californian\",\n \"Contemporary French / American\",\n \"Contemporary American\"\n ],\n \"hours\": \"Bar\\n
Mon–Sat 5:00 pm–9:30 pm\\n
Dinner\\n
Mon–Sat 5:15 pm–9:30 pm\",\n \"hours_raw\": [\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:15\",\n \"shiftEnds\": \"21:30\",\n \"days\": [\n \"thu\",\n \"fri\",\n \"sat\",\n \"wed\",\n \"tue\",\n \"mon\"\n ]\n },\n {\n \"name\": \"bar\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:30\",\n \"days\": [\n \"wed\",\n \"tue\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"mon\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n },\n {\n \"rid\": 141,\n \"name\": \"ANZU\",\n \"address\": \"222 Mason St.\",\n \"address2\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.7860081\",\n \"longitude\": \"-122.4092959\",\n \"postal_code\": \"94102\",\n \"phone_number\": \"+14153941100\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/141\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/141\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/anzu-san-francisco\",\n \"natural_profile_url\": \"http://www.opentable.com/r/anzu-san-francisco\",\n \"profile_photo\": {\n \"id\": 92081614,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/1/92081614.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/1/92081614.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/1/92081614.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/1/92081614.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/1/92081614.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/1/92081614.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/1/92081614.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/1/92081614.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/1/92081614.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/1/92081614.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/1/92081614.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/1/92081614.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/1/92081614.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/1/92081614.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.100\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 2578,\n \"category\": [\n \"Breakfast\",\n \"Californian\",\n \"Japanese\"\n ],\n \"hours\": \"Breakfast\\n
Mon–Fri 6:30 am–10:30 am\\n
Sat, Sun 7:00 am–12:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"06:30\",\n \"shiftEnds\": \"10:30\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"12:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": false\n }\n },\n {\n \"rid\": 144,\n \"name\": \"Il Solito\",\n \"address\": \"627 SW Washington St.\",\n \"address2\": \"\",\n \"city\": \"Portland\",\n \"state\": \"OR\",\n \"country\": \"US\",\n \"latitude\": \"45.5206798\",\n \"longitude\": \"-122.6785073\",\n \"postal_code\": \"97205\",\n \"phone_number\": \"+15032281515\",\n \"metro_name\": \"Portland / Oregon\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/144\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/144\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/il-solito-portland\",\n \"natural_profile_url\": \"http://www.opentable.com/r/il-solito-portland\",\n \"profile_photo\": {\n \"id\": 82056458,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/small/3/82056458.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/3/82056458.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/3/82056458.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/3/82056458.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/large/3/82056458.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/3/82056458.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/3/82056458.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/medium/3/82056458.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/3/82056458.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/3/82056458.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/huge/3/82056458.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/3/82056458.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/3/82056458.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/3/82056458.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.300\",\n \"price_quartile\": \"$$\",\n \"review_count\": 1364,\n \"category\": [\n \"Breakfast\",\n \"Contemporary Italian\",\n \"Northwest\"\n ],\n \"hours\": \"Breakfast\\n
Mon–Fri 7:00 am–11:00 am\\n
Brunch\\n
Sat, Sun 8:00 am–2:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"breakfast\",\n \"shiftStarts\": \"07:00\",\n \"shiftEnds\": \"11:00\",\n \"days\": [\n \"mon\",\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\"\n ]\n },\n {\n \"name\": \"brunch\",\n \"shiftStarts\": \"08:00\",\n \"shiftEnds\": \"14:00\",\n \"days\": [\n \"sat\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": false\n }\n },\n {\n \"rid\": 147,\n \"name\": \"Birk's\",\n \"address\": \"3955 Freedom Circle\",\n \"address2\": \"\",\n \"city\": \"Santa Clara\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"latitude\": \"37.3854527\",\n \"longitude\": \"-121.9728830\",\n \"postal_code\": \"95054\",\n \"phone_number\": \"4089806400\",\n \"metro_name\": \"San Francisco Bay Area\",\n \"reservation_url\": \"http://www.opentable.com/restaurant/profile/147\",\n \"profile_url\": \"http://www.opentable.com/restaurant/profile/147\",\n \"natural_reservation_url\": \"http://www.opentable.com/r/birks-santa-clara\",\n \"natural_profile_url\": \"http://www.opentable.com/r/birks-santa-clara\",\n \"profile_photo\": {\n \"id\": 25175460,\n \"sizes\": {\n \"small\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/small.jpg\",\n \"width\": 160,\n \"height\": 160\n },\n \"xsmall\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xsmall/1/25175460.jpg\",\n \"width\": 105,\n \"height\": 105\n },\n \"legacy\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/legacy/1/25175460.jpg\",\n \"width\": 208,\n \"height\": 208\n },\n \"wide-xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-xlarge/1/25175460.jpg\",\n \"width\": 752,\n \"height\": 423\n },\n \"large\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/large.jpg\",\n \"width\": 640,\n \"height\": 640\n },\n \"xlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/xlarge/1/25175460.jpg\",\n \"width\": 752,\n \"height\": 752\n },\n \"wide-large\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-large/1/25175460.jpg\",\n \"width\": 640,\n \"height\": 360\n },\n \"medium\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/medium.jpg\",\n \"width\": 320,\n \"height\": 320\n },\n \"wide-mlarge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-mlarge/1/25175460.jpg\",\n \"width\": 480,\n \"height\": 270\n },\n \"wide-medium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-medium/1/25175460.jpg\",\n \"width\": 320,\n \"height\": 180\n },\n \"huge\": {\n \"url\": \"https://images.otstatic.com/prod/25175460/1/huge.jpg\",\n \"width\": 1280,\n \"height\": 1280\n },\n \"wide-huge\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-huge/1/25175460.jpg\",\n \"width\": 1280,\n \"height\": 720\n },\n \"wide-small\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-small/1/25175460.jpg\",\n \"width\": 160,\n \"height\": 90\n },\n \"wide-smedium\": {\n \"url\": \"https://resizer.otstatic.com/v2/photos/wide-smedium/1/25175460.jpg\",\n \"width\": 240,\n \"height\": 135\n }\n }\n },\n \"is_restaurant_in_group\": false,\n \"aggregate_score\": \"4.700\",\n \"price_quartile\": \"$$$\",\n \"review_count\": 3715,\n \"category\": [\n \"American\",\n \"Steakhouse\",\n \"Steak\"\n ],\n \"hours\": \"Lunch\\n
Mon–Fri 11:00 am–2:30 pm\\n
Happy Hour\\n
Mon–Fri 3:30 pm–6:00 pm\\n
Sat 5:00 pm–7:00 pm\\n
Dinner\\n
Daily 5:00 pm–9:00 pm\",\n \"hours_raw\": [\n {\n \"name\": \"lunch\",\n \"shiftStarts\": \"11:00\",\n \"shiftEnds\": \"14:30\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"mon\"\n ]\n },\n {\n \"name\": \"happyhour\",\n \"shiftStarts\": \"15:30\",\n \"shiftEnds\": \"18:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"mon\"\n ]\n },\n {\n \"name\": \"happyhour\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"19:00\",\n \"days\": [\n \"sat\"\n ]\n },\n {\n \"name\": \"dinner\",\n \"shiftStarts\": \"17:00\",\n \"shiftEnds\": \"21:00\",\n \"days\": [\n \"tue\",\n \"wed\",\n \"thu\",\n \"fri\",\n \"sat\",\n \"mon\",\n \"sun\"\n ]\n }\n ],\n \"private_dining\": {\n \"enabled_with_active_spaces\": true\n }\n }\n ]\n}"},{"id":"18121810-bd49-41ff-b24b-223305234a6a","name":"401","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/sync/directory?limit=10","host":["{{base-url}}"],"path":["sync","directory"],"query":[{"key":"limit","value":"10"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"1800b854-25d4-42a7-b046-92449c438ed5"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"C0133B2B-924E-44C9-9FB1-4A838792C041"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"10"},{"key":"Content-Length","value":"91"},{"key":"Date","value":"Wed, 22 Jan 2025 20:46:56 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"invalid_token\"\n }\n ],\n \"requestid\": \"1800b854-25d4-42a7-b046-92449c438ed5\"\n}"}],"_postman_id":"5e32bb61-d234-4264-afcb-9911e662ab8a"}],"id":"93d6655e-d66e-4197-b61f-eb3bf9f4edd4","description":"
The Directory API gives approved developers the ability to acquire and synchronize restaurants that are visible as search results on the OpenTable website. The Directory API is only available to our Consumer Partners and is not offered to our Restaurant Partners.
\n","_postman_id":"93d6655e-d66e-4197-b61f-eb3bf9f4edd4"}],"id":"95b88800-c1a1-4ab0-80ba-d79f17a1f54b","_postman_id":"95b88800-c1a1-4ab0-80ba-d79f17a1f54b","description":""},{"name":"Private Dining Lead API","item":[{"name":"POST Lead","id":"335d6553-c51a-4f1c-8088-d6d8e9f1a96c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"user@example.com\",\n \"phoneNumber\": \"1 123 123 1234\",\n \"eventDate\": \"2027-01-01\",\n \"eventTime\": \"18:30\",\n \"partySize\": 100, \n \"eventType\": \"Anniversary\",\n \"flexibleDate\": true\n}","options":{"raw":{"language":"json"}}},"url":"((base-url}}/v1/privatedining/restaurant/{{RID}}/leads","description":"API Path
\n/v1/privatedining/restaurant/{{RID}}/leads
\nMethod: POST
\nEligibility Rules
\n- \n
Access is restricted to restaurant IDs (RIDs) with an active Private Dining subscription
\n \nRequests for ineligible RIDs will be rejected
\n \n
\n
Request Parameters
\nPath Parameters
\n\n
Request Body (JSON)
\nRequired Fields
\n\n
eventType Enum Values
\n- \n
\nAnniversary\n
\nBabyShower\n
\nBarMitzvah\n
\nBirthday\n
\nBridalWeddingShower\n
\nCharityEvent\n
\nClass\n
\nCocktailParty\n
\nConference\n
\nCorporateEvent\n
\nDinnerParty\n
\nEngagement\n
\nFilmingLocation\n
\nFundraiser\n
\nGraduation\n
\nHolidayEvent\n
\nLaunchParty\n
\nMeeting\n
\nOther\n
\nPrivateDining\n
\nRehearsalDinner\n
\nSocialEvent\n
\nSpecialOccasion\n
\nWeddingReception\n
\n
Optional Fields
\n\n
Notes & Validation Rules
\n- \n
\neventDatemust be in the future \n
\neventTimemust use 24-hour format \n
\nemailis validated for proper format \n
\npartySizemust be ≥ 1 \nRequests for RIDs without an active Private Dining subscription will fail
\n \n
Overview
\nThe Private Dining Lead API allows partners to create and submit private dining inquiries on behalf of guests directly to an OpenTable restaurant. Each lead is routed using the OpenTable restaurant ID (RID), ensuring the request reaches the correct venue and its private dining team.
\nThis endpoint is designed to support high-value event inquiries such as celebrations, corporate events, and group dining, helping restaurants capture demand beyond standard reservations.
\nPosting leads is restricted to restaurants with an active Private Dining subscription.
\n","_postman_id":"74f25183-cc63-46dc-94d2-f589e92481cc"}],"id":"dbc7034b-5595-485c-92be-3d3f1786e676","description":"Private Dining Leads API
\nThe Private Dining Leads API allows partners to programmatically submit private dining (PD) inquiries to participating OpenTable restaurants. This integration is designed for partners who capture private dining demand in their own products and want to route qualified leads directly into OpenTable’s restaurant workflows.
\nBecause not all restaurants support private dining, partners must first use OpenTable’s Directory API to identify which restaurants have private dining enabled before attempting to post a lead.
\nOverview
\nAt a high level, the Private Dining Leads integration follows a two-step flow:
\n- \n
Discover PD-enabled restaurants via Directory
\n- \n
Call the Directory API to retrieve restaurant metadata for the markets and partners you support.
\n \nUse the private dining–related attribute in the response to determine whether a given restaurant has private dining enabled.
\n \nOnly restaurants flagged as PD-enabled are eligible to receive private dining leads.
\n \n
\nSubmit private dining leads for eligible restaurants
\n- \n
For restaurants identified as PD-enabled, submit inquiries using the Private Dining Lead submission endpoint.
\n \nThe lead payload should include the guest’s contact details and event requirements as defined by the endpoint’s schema.
\n \nOpenTable will route the lead to the selected restaurant so they can review and respond through their existing tools.
\n \n
\n
Important considerations
\n- \n
PD availability is not universal
\n
Many restaurants in the Directory do not have private dining enabled. Integrations must respect the PD-enabled attribute to avoid submitting leads to ineligible restaurants. \nLimited PD-specific metadata in Directory
\n
The Directory response does not currently expose private dining–specific details (such as room names, capacities, or minimums); it only indicates whether private dining is enabled. Partners should collect the necessary event details from guests in their own UI and pass them through the lead submission endpoint. \nDecoupled discovery and lead submission
\n
Discovery (Directory) and lead submission (Private Dining Leads) are separate APIs. A typical integration will:- \n
Periodically sync or query Directory to understand which restaurants accept private dining leads.
\n \nStore and use restaurant identifiers from Directory when posting leads to ensure they are routed correctly.
\n \n
\n
This design allows partners to build flexible experiences for guests while ensuring that private dining leads are only sent to restaurants that are ready to handle them through OpenTable.
\n","_postman_id":"dbc7034b-5595-485c-92be-3d3f1786e676"},{"name":"Reviews API","item":[{"name":"Get Review Data","id":"7f91da43-0df5-483a-b370-5e66010e1633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/v1/partnerreviews/allreviews?Rid=1038007&NumberOfReviews=5","description":"Overview
\nThis specific endpoint allows partners to obtain all the reviews by Restaurant and Date or count. You can query a single RID or multiple RIDs, if multiple, comma separated.
Endpoint:
\nURL: https://platform.opentable.com/v1/partnerreviews/allreviews
\nMethod: GET
\nQuery Parameters
\n\n
Parameters
\n\n
Attributes
\n\n
Categories
\n\n
Photos
\n\n
Category Key
\n","urlObject":{"path":["v1","partnerreviews","allreviews"],"host":["{{base-url}}"],"query":[{"key":"Rid","value":"1038007"},{"key":"NumberOfReviews","value":"5"}],"variable":[]}},"response":[{"id":"04127fa1-2906-4b41-95dc-ae40a003c13e","name":"Get Review Data","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/v1/partnerreviews/allreviews?Rid=1038007&NumberOfReviews=5","host":["{{base-url}}"],"path":["v1","partnerreviews","allreviews"],"query":[{"key":"Rid","value":"1038007"},{"key":"NumberOfReviews","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"b95819c7-0526-48f9-bbd1-72c9538da708"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"AA6570AF-C0A1-4E9B-8AF8-449B1AA5E400"},{"key":"OT-SessionID","value":"c61452f0-f111-43ea-b11b-a5bc19ec8770"},{"key":"Content-Type","value":"application/vnd.reviews.v4+json; charset=utf-8"},{"key":"ot-endpoint","value":"getpartnerallreviewsforrids-v1"},{"key":"ot-referringservice","value":"reviews-api"},{"key":"X-OT-Backend","value":"reviews"},{"key":"X-OT-UriTemplate","value":"/reviews/partner/v1/allreviews?{Rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 28 Feb 2025 18:40:05 GMT"},{"key":"Content-Length","value":"1344"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"TotalCount\": 16,\n \"Reviews\": [\n {\n \"CountryCode\": \"US\",\n \"CustomerName\": null,\n \"CustomerNickname\": \"OTSEC\",\n \"CustomerEmailAddress\": null,\n \"DomainId\": 1,\n \"Featured\": false,\n \"Locale\": \"en-US\",\n \"Language\": \"en\",\n \"MetroId\": 1,\n \"ModerationState\": 2,\n \"SimplifiedModerationState\": \"APPROVED\",\n \"Rating\": {\n \"Overall\": 5,\n \"Food\": 5,\n \"Service\": 5,\n \"Ambience\": 5,\n \"Value\": 5,\n \"Noise\": 2\n },\n \"Recommended\": true,\n \"RestaurantComment\": \"\",\n \"RestaurantId\": 1038007,\n \"DinedDateTime\": \"2024-11-15T19:30:00-08:00\",\n \"ReservationId\": 1730789203,\n \"ReviewId\": \"OT-1038007-2144-170223310557\",\n \"ReviewText\": \"This is the best restaurant I've ever been to. Best \\\"mici\\\" I've ever had in my life\",\n \"ReviewTitle\": null,\n \"ReviewType\": 0,\n \"SubmissionDateTimeUtc\": \"2024-11-27T12:20:33Z\",\n \"CustomQuestions\": null,\n \"NeighborhoodId\": 10331,\n \"GpId\": 170223310557,\n \"LastModifiedDateTimeUtc\": \"2024-11-27T12:20:33Z\",\n \"TagVotes\": null,\n \"Helpfulness\": {\n \"Up\": 0,\n \"Down\": 0,\n \"Score\": 0\n },\n \"UpdatedByDinerDateTimeUtc\": null,\n \"IsDraft\": false,\n \"Categories\": [\n {\n \"Id\": \"Fancy\",\n \"Label\": \"Fancy\"\n },\n {\n \"Id\": \"GreatBeer\",\n \"Label\": \"Great for craft beers\"\n },\n {\n \"Id\": \"ChildFriendly\",\n \"Label\": \"Kid-friendly\"\n }\n ],\n \"DinerInitials\": \"O\",\n \"DinerMetroId\": 1,\n \"DinerIsVip\": false,\n \"Photos\": [\n {\n \"Type\": \"Dff\",\n \"Key\": \"70726782\",\n \"Caption\": \"\",\n \"ShowCaption\": true\n },\n {\n \"Type\": \"Dff\",\n \"Key\": \"70726781\",\n \"Caption\": \"\",\n \"ShowCaption\": true\n }\n ],\n \"OriginalSubmissionDateTimeUtc\": \"2024-11-27T12:20:33.0000000Z\",\n \"ResponseLink\": \"https://guestcenter.opentable.com/admin/reviews/1038007/reviews\"\n },\n {\n \"CountryCode\": \"US\",\n \"CustomerName\": null,\n \"CustomerNickname\": \"OTSEC\",\n \"CustomerEmailAddress\": null,\n \"DomainId\": 1,\n \"Featured\": false,\n \"Locale\": \"en-US\",\n \"Language\": \"en\",\n \"MetroId\": 1,\n \"ModerationState\": 2,\n \"SimplifiedModerationState\": \"APPROVED\",\n \"Rating\": {\n \"Overall\": 5,\n \"Food\": 5,\n \"Service\": 5,\n \"Ambience\": 5,\n \"Value\": 5,\n \"Noise\": 1\n },\n \"Recommended\": true,\n \"RestaurantComment\": \"\",\n \"RestaurantId\": 1038007,\n \"DinedDateTime\": \"2024-11-14T00:30:00-08:00\",\n \"ReservationId\": 1728525632,\n \"ReviewId\": \"OT-1038007-2141-170223310557\",\n \"ReviewText\": \"Best Bistro I've been to! Highly encourage everyone to try it!\",\n \"ReviewTitle\": null,\n \"ReviewType\": 0,\n \"SubmissionDateTimeUtc\": \"2024-11-27T09:28:13Z\",\n \"CustomQuestions\": null,\n \"NeighborhoodId\": 10331,\n \"GpId\": 170223310557,\n \"LastModifiedDateTimeUtc\": \"2024-11-27T09:28:14Z\",\n \"TagVotes\": null,\n \"Helpfulness\": {\n \"Up\": 0,\n \"Down\": 0,\n \"Score\": 0\n },\n \"UpdatedByDinerDateTimeUtc\": \"2024-11-27T09:28:13.8250000Z\",\n \"IsDraft\": false,\n \"Categories\": [\n {\n \"Id\": \"NeighborhoodGem\",\n \"Label\": \"Neighborhood gem\"\n },\n {\n \"Id\": \"Brunch\",\n \"Label\": \"Great for brunch\"\n },\n {\n \"Id\": \"HappyHour\",\n \"Label\": \"Great for happy hour\"\n }\n ],\n \"DinerInitials\": \"O\",\n \"DinerMetroId\": 1,\n \"DinerIsVip\": false,\n \"Photos\": [\n {\n \"Type\": \"Dff\",\n \"Key\": \"70725511\",\n \"Caption\": \"Best mici I've ever had!\",\n \"ShowCaption\": true\n }\n ],\n \"OriginalSubmissionDateTimeUtc\": \"2024-11-27T09:25:58.0000000Z\",\n \"ResponseLink\": \"https://guestcenter.opentable.com/admin/reviews/1038007/reviews\"\n },\n {\n \"CountryCode\": \"US\",\n \"CustomerName\": null,\n \"CustomerNickname\": \"MVogel\",\n \"CustomerEmailAddress\": null,\n \"DomainId\": 1,\n \"Featured\": false,\n \"Locale\": \"en-US\",\n \"Language\": \"en\",\n \"MetroId\": 1,\n \"ModerationState\": 2,\n \"SimplifiedModerationState\": \"APPROVED\",\n \"Rating\": {\n \"Overall\": 5,\n \"Food\": 5,\n \"Service\": 3,\n \"Ambience\": 3,\n \"Value\": 3,\n \"Noise\": 2\n },\n \"Recommended\": null,\n \"RestaurantComment\": null,\n \"RestaurantId\": 1038007,\n \"DinedDateTime\": \"2023-10-31T15:30:00-07:00\",\n \"ReservationId\": 1516826622,\n \"ReviewId\": \"OT-1038007-1507-110098955131\",\n \"ReviewText\": \"I love this place!!!! It’s amazing. Great food and service!\",\n \"ReviewTitle\": null,\n \"ReviewType\": 0,\n \"SubmissionDateTimeUtc\": \"2024-01-25T20:50:05Z\",\n \"CustomQuestions\": null,\n \"NeighborhoodId\": 10331,\n \"GpId\": 110098955131,\n \"LastModifiedDateTimeUtc\": \"2024-03-06T11:43:54Z\",\n \"TagVotes\": null,\n \"Helpfulness\": {\n \"Up\": 0,\n \"Down\": 0,\n \"Score\": 0\n },\n \"UpdatedByDinerDateTimeUtc\": null,\n \"IsDraft\": false,\n \"Categories\": null,\n \"DinerInitials\": \"MV\",\n \"DinerMetroId\": 52,\n \"DinerIsVip\": true,\n \"Photos\": [],\n \"OriginalSubmissionDateTimeUtc\": \"2024-01-25T20:50:05.0000000Z\",\n \"ResponseLink\": \"https://guestcenter.opentable.com/admin/reviews/1038007/reviews\"\n },\n {\n \"CountryCode\": \"US\",\n \"CustomerName\": null,\n \"CustomerNickname\": \"MVogel\",\n \"CustomerEmailAddress\": null,\n \"DomainId\": 1,\n \"Featured\": false,\n \"Locale\": \"en-US\",\n \"Language\": \"en\",\n \"MetroId\": 1,\n \"ModerationState\": 2,\n \"SimplifiedModerationState\": \"APPROVED\",\n \"Rating\": {\n \"Overall\": 5,\n \"Food\": 5,\n \"Service\": 5,\n \"Ambience\": 4,\n \"Value\": 5,\n \"Noise\": 1\n },\n \"Recommended\": null,\n \"RestaurantComment\": null,\n \"RestaurantId\": 1038007,\n \"DinedDateTime\": \"2024-01-18T14:15:00-08:00\",\n \"ReservationId\": 1561464267,\n \"ReviewId\": \"OT-1038007-1607-110098955131\",\n \"ReviewText\": \"Loved it! Would go back for the truffle pizza everyday if I could\",\n \"ReviewTitle\": null,\n \"ReviewType\": 0,\n \"SubmissionDateTimeUtc\": \"2024-01-25T20:46:05Z\",\n \"CustomQuestions\": null,\n \"NeighborhoodId\": 10331,\n \"GpId\": 110098955131,\n \"LastModifiedDateTimeUtc\": \"2024-01-25T20:46:05Z\",\n \"TagVotes\": null,\n \"Helpfulness\": {\n \"Up\": 0,\n \"Down\": 0,\n \"Score\": 0\n },\n \"UpdatedByDinerDateTimeUtc\": null,\n \"IsDraft\": false,\n \"Categories\": null,\n \"DinerInitials\": \"MV\",\n \"DinerMetroId\": 52,\n \"DinerIsVip\": true,\n \"Photos\": [],\n \"OriginalSubmissionDateTimeUtc\": \"2024-01-25T20:46:05.0000000Z\",\n \"ResponseLink\": \"https://guestcenter.opentable.com/admin/reviews/1038007/reviews\"\n },\n {\n \"CountryCode\": \"US\",\n \"CustomerName\": null,\n \"CustomerNickname\": \"MVogel\",\n \"CustomerEmailAddress\": null,\n \"DomainId\": 1,\n \"Featured\": false,\n \"Locale\": \"en-US\",\n \"Language\": \"en\",\n \"MetroId\": 1,\n \"ModerationState\": 2,\n \"SimplifiedModerationState\": \"APPROVED\",\n \"Rating\": {\n \"Overall\": 5,\n \"Food\": 5,\n \"Service\": 3,\n \"Ambience\": 2,\n \"Value\": 1,\n \"Noise\": 4\n },\n \"Recommended\": true,\n \"RestaurantComment\": \"\",\n \"RestaurantId\": 1038007,\n \"DinedDateTime\": \"2023-02-15T19:00:00-08:00\",\n \"ReservationId\": 1375829965,\n \"ReviewId\": \"OT-1038007-1306-110098955131\",\n \"ReviewText\": \"Test review for reviews API. Trying to reach character limit\",\n \"ReviewTitle\": null,\n \"ReviewType\": 0,\n \"SubmissionDateTimeUtc\": \"2023-07-11T17:16:02Z\",\n \"CustomQuestions\": {\n \"intentToReturn\": false\n },\n \"NeighborhoodId\": 10331,\n \"GpId\": 110098955131,\n \"LastModifiedDateTimeUtc\": \"2024-11-13T15:20:11Z\",\n \"TagVotes\": null,\n \"Helpfulness\": {\n \"Up\": 1,\n \"Down\": 0,\n \"Score\": 1\n },\n \"UpdatedByDinerDateTimeUtc\": \"2023-07-11T17:16:02.9870000Z\",\n \"IsDraft\": false,\n \"Categories\": [\n {\n \"Id\": \"Romance\",\n \"Label\": \"Romantic\"\n }\n ],\n \"DinerInitials\": \"MV\",\n \"DinerMetroId\": 52,\n \"DinerIsVip\": true,\n \"Photos\": [],\n \"OriginalSubmissionDateTimeUtc\": \"2023-03-21T02:01:41.0000000Z\",\n \"ResponseLink\": \"https://guestcenter.opentable.com/admin/reviews/1038007/reviews\"\n }\n ]\n}"}],"_postman_id":"7f91da43-0df5-483a-b370-5e66010e1633"},{"name":"Get Review Summary","id":"a198087e-c9dc-40c5-9bfe-14667675e6cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/v1/partnerreviews/restaurantreviewsummary?Rids=1038007","description":"Overview:
\nThis API allows you to retrieve a summary for a given Restaurant Id filtered with the given parameters for the past 120 days.
\nEndpoint:
\nURL: {{base-url}}/v1/partnerreviews/restaurantreviewsummary
Method: GET
Parameters
\n\n
Here is the formatted version of your data into tables:
\nAttributes
\n\n
Restaurant Review Summaries
\n\n
Ratings
\n\n
RatingOnlyReviewRatings
\n\n
Category Distribution
\n\n
Awards
\n\n
Overall Ratings Distribution
\n\n
Diners Recommendations
\n\n
Overall Ratings
\n\n
Noise Ratings
\n","urlObject":{"path":["v1","partnerreviews","restaurantreviewsummary"],"host":["{{base-url}}"],"query":[{"key":"Rids","value":"1038007"}],"variable":[]}},"response":[{"id":"93925ce8-2584-4cff-be9e-7b1dc1bbbe24","name":"Get Review Summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base-url}}/v1/partnerreviews/restaurantreviewsummary?Rids=1038007","host":["{{base-url}}"],"path":["v1","partnerreviews","restaurantreviewsummary"],"query":[{"key":"Rids","value":"1038007"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"e9995b53-e4d6-4d33-82e4-887fcabb0934"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"AA6570AF-C0A1-4E9B-8AF8-449B1AA5E400"},{"key":"OT-SessionID","value":"0250bd11-07ad-496e-945a-c89899798e61"},{"key":"Content-Type","value":"application/vnd.reviews.v4+json; charset=utf-8"},{"key":"ot-endpoint","value":"getpartnersummariesbyridsv1-v1"},{"key":"ot-referringservice","value":"reviews-api"},{"key":"X-OT-Backend","value":"reviews"},{"key":"X-OT-UriTemplate","value":"/reviews/partner/v1/restaurantreviewsummary?{Rids}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 28 Feb 2025 19:14:55 GMT"},{"key":"Content-Length","value":"734"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"RestaurantReviewSummaries\": [\n {\n \"Rid\": 1038007,\n \"Ratings\": {\n \"OverallRatingsDistribution\": {\n \"1\": 0,\n \"2\": 0,\n \"3\": 0,\n \"4\": 0,\n \"5\": 15\n },\n \"DinersRecommendations\": {\n \"Count\": 5,\n \"Yes\": 5,\n \"No\": 0\n },\n \"Count\": 15,\n \"Overall\": {\n \"Rating\": 5,\n \"Count\": 15\n },\n \"Food\": {\n \"Rating\": 4.9,\n \"Count\": 15\n },\n \"Service\": {\n \"Rating\": 4.5,\n \"Count\": 15\n },\n \"Ambience\": {\n \"Rating\": 4.5,\n \"Count\": 15\n },\n \"Value\": {\n \"Rating\": 4.5,\n \"Count\": 15\n },\n \"Noise\": {\n \"Rating\": 2,\n \"Count\": 15\n }\n },\n \"RatingOnlyReviewRatings\": {\n \"OverallRatingsDistribution\": {\n \"1\": 0,\n \"2\": 0,\n \"3\": 0,\n \"4\": 0,\n \"5\": 4\n },\n \"DinersRecommendations\": {\n \"Count\": 0,\n \"Yes\": 0,\n \"No\": 0\n },\n \"Count\": 4,\n \"Overall\": {\n \"Rating\": 5,\n \"Count\": 4\n },\n \"Food\": {\n \"Rating\": 5,\n \"Count\": 4\n },\n \"Service\": {\n \"Rating\": 5,\n \"Count\": 4\n },\n \"Ambience\": {\n \"Rating\": 5,\n \"Count\": 4\n },\n \"Value\": {\n \"Rating\": 5,\n \"Count\": 4\n },\n \"Noise\": {\n \"Rating\": 3,\n \"Count\": 4\n }\n },\n \"CategoryDistribution\": [\n {\n \"Name\": \"Great for brunch\",\n \"Count\": 2,\n \"Key\": \"Brunch\"\n },\n {\n \"Name\": \"Romantic\",\n \"Count\": 2,\n \"Key\": \"Romance\"\n },\n {\n \"Name\": \"Kid-friendly\",\n \"Count\": 1,\n \"Key\": \"ChildFriendly\"\n },\n {\n \"Name\": \"Fancy\",\n \"Count\": 1,\n \"Key\": \"Fancy\"\n },\n {\n \"Name\": \"Great for craft beers\",\n \"Count\": 1,\n \"Key\": \"GreatBeer\"\n },\n {\n \"Name\": \"Great for happy hour\",\n \"Count\": 1,\n \"Key\": \"HappyHour\"\n },\n {\n \"Name\": \"Healthy\",\n \"Count\": 1,\n \"Key\": \"Healthy\"\n },\n {\n \"Name\": \"Neighborhood gem\",\n \"Count\": 1,\n \"Key\": \"NeighborhoodGem\"\n },\n {\n \"Name\": \"Great for outdoor dining\",\n \"Count\": 1,\n \"Key\": \"OutdoorDining\"\n },\n {\n \"Name\": \"Good for special occasions\",\n \"Count\": 1,\n \"Key\": \"SpecialOccasions\"\n }\n ],\n \"TotalNumberOfReviews\": 15,\n \"AllTimeTextReviewCount\": 11,\n \"ShowReviews\": true,\n \"StartDateUtc\": \"2024-10-31T00:00:00Z\",\n \"Awards\": [\n {\n \"Key\": \"MostBooked\",\n \"LocationType\": \"Metro\",\n \"Name\": \"Most Booked\",\n \"Type\": \"DinersChoice_MostBooked\",\n \"DisplayPriority\": 0,\n \"Location\": \"Demoland (US)\",\n \"LocationId\": 1\n },\n {\n \"Key\": \"MostBooked\",\n \"LocationType\": \"Macro\",\n \"Name\": \"Most Booked\",\n \"Type\": \"DinersChoice_MostBooked\",\n \"DisplayPriority\": 1,\n \"Location\": \"Demoland\",\n \"LocationId\": 40\n }\n ],\n \"RestaurantName\": \"Vogel's Bistro\",\n \"Locale\": \"en-us\",\n \"LookBackDays\": 120,\n \"RatingBasedOn\": \"AllTime\",\n \"VerifiedReviews\": true,\n \"ResponseLink\": \"https://guestcenter.opentable.com/admin/reviews/1038007/reviews\"\n }\n ]\n}"}],"_postman_id":"a198087e-c9dc-40c5-9bfe-14667675e6cc"},{"name":"Post Review Response","id":"5445480c-d291-449d-8f47-69d71750364b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Reviews Response API Documentation
\nOverview
\nThe Reviews API POST Endpoint allows partners to respond to OpenTable diner reviews for a specific Restaurant ID (RID). Note that OpenTable reviews can only be posted by confirmed seated diners.
\n\n
Endpoint
\nURL: {{base-url}} /v1/partnerreviews/reviewreplies/{reviewId}
Method: POST
\n
Request Parameters
\nPath Parameters
\nQuery Parameters
\nRequest Body (Case-Sensitive)
\n","urlObject":{"path":["v1","partnerreviews","reviewreplies","OT-1038007-2141-170223310557"],"host":["{{base-url}}"],"query":[{"key":"rid","value":"1038007"}],"variable":[]}},"response":[{"id":"da1c2bfc-098a-42df-a0f0-78ab9a7f2933","name":"Post Review Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Message\": \"Thank you for choosing Vogel'\\''s Bistro to celebrate your anniversary and for submitting your 5 star review. We looking forward to serving you again soon\",\n \"From\": \"Restaurant\",\n \"Name\": \"Matt V\",\n \"IsPublic\": true,\n \"ReplyingToReplyId\": \"\",\n \"ReplyToEmail\": \"matt@vogelsbistro.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base-url}}/v1/partnerreviews/reviewreplies/OT-1038007-2141-170223310557?rid=1038007","host":["{{base-url}}"],"path":["v1","partnerreviews","reviewreplies","OT-1038007-2141-170223310557"],"query":[{"key":"rid","value":"1038007"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"f23a4148-ad1f-480f-a9c4-b288d3648eaa"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"AA6570AF-C0A1-4E9B-8AF8-449B1AA5E400"},{"key":"OT-SessionID","value":"85a31d02-9ee7-43e7-b2dc-9a7e977166af"},{"key":"Content-Type","value":"application/vnd.reviews.v4+json; charset=utf-8"},{"key":"ot-endpoint","value":"post-v1"},{"key":"ot-referringservice","value":"reviews-api"},{"key":"X-OT-Backend","value":"reviews"},{"key":"X-OT-UriTemplate","value":"/reviews/partner/v1/reviewreplies/{reviewId}?{rid}"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 28 Feb 2025 19:54:23 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"ReplyId\": \"59751b7cd6c943e181300a4722d9134a\",\n \"ResponseDateTimeUtc\": \"2025-02-28T19:54:23Z\",\n \"Message\": \"Thank you for choosing Vogel'''s Bistro to celebrate your anniversary and for submitting your 5 star review. We looking forward to serving you again soon\",\n \"From\": \"Restaurant\",\n \"RestaurantId\": 1038007,\n \"ReviewId\": \"OT-1038007-2141-170223310557\",\n \"ReplyToEmail\": \"matt@vogelsbistro.com\",\n \"Name\": \"Matt V\",\n \"ModerationState\": \"PENDING\",\n \"Language\": null,\n \"IsPublic\": true,\n \"ReplyingToReplyId\": \"\"\n}"}],"_postman_id":"5445480c-d291-449d-8f47-69d71750364b"}],"id":"dc64efbb-b2db-4b5b-81c8-0b58eb0a73a7","description":"Overview
\nThe OpenTable Reviews API provides partners access to diner reviews for restaurants. Reviews are only posted by confirmed seated diners, ensuring authenticity. This API enables retrieval of all reviews for a specific restaurant and provides summary statistics.
\nThese reviews are also exposed on the OpenTable profile page for each restaurant.
\n","_postman_id":"dc64efbb-b2db-4b5b-81c8-0b58eb0a73a7"},{"name":"Sync APIs","item":[{"name":"Copper","item":[{"name":"Copper Reservations API v2","id":"2367d26e-8ef0-435e-b855-3cac768a3eca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid={{rid1}}","description":"Overview
\nThe Reservation API provides detailed data about restaurant reservations and allows applications to filter and retrieve records based on various parameters. This endpoint is designed to support restaurant management systems and third-party applications in obtaining accurate and timely reservation data.
\n\n
API Endpoint
\nURL: https://platform.opentable.com/sync/v2/reservations
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nResponse Payload
\nThe response includes metadata about the paginated results, followed by an array of reservation objects.
\n\n
Reservation Object Attributes
\n\n","urlObject":{"path":["sync","v2","reservations"],"host":["{{base-url}}"],"query":[{"disabled":true,"key":"state","value":"Done"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid1}}"}],"variable":[]}},"response":[{"id":"cba963b2-9df6-4fd7-844c-8a9f767cb141","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","reservations"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"81f3d2ce-e200-46bd-b37a-0a409dfe30f9"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"f87ee1d1-bb2c-448c-959b-215b2f1a4183"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Tue, 15 Oct 2024 06:10:14 GMT"},{"key":"Content-Length","value":"1991"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"188878-49bcffdf-0476-4464-9bd0-66e87dc289de\",\n \"href\": \"https://platform.opentable.com/sync/v2/reservations/188878-49bcffdf-0476-4464-9bd0-66e87dc289de\",\n \"rid\": 188878,\n \"sequence_id\": 86941,\n \"guest_id\": \"188878-05a8f2a2-3428-4000-9867-ca82795cb365\",\n \"guest\": \"https://platform.opentable.com/sync/v2/guests/188878-05a8f2a2-3428-4000-9867-ca82795cb365\",\n \"confirmation_id\": 15989,\n \"state\": \"Cancelled\",\n \"table_number\": [\n \"80\"\n ],\n \"created_date\": \"2025-01-09T06:31:39\",\n \"scheduled_time\": \"2025-02-14T19:30:00\",\n \"party_size\": 2,\n \"visit_tags\": [\n \"gc:service/date\"\n ],\n \"origin\": \"Web\",\n \"updated_at\": \"2025-02-06T14:00:36\",\n \"seated_time\": null,\n \"done_time\": null,\n \"pos_data\": {\n \"check_ids\": null,\n \"pos_sub_total\": null,\n \"pos_tax\": null,\n \"pos_tip\": null, \n \"pos_total_spend\": null\n },\n \"scheduled_time_utc\": \"2025-02-14T08:30:00Z\",\n \"guest_request\": \"\",\n \"venue_notes\": null,\n \"opentable_notes\": \"\",\n \"table_category\": null,\n \"seated_time_utc\": null,\n \"done_time_utc\": null,\n \"created_date_utc\": \"2025-01-08T19:31:39Z\",\n \"updated_at_utc\": \"2025-02-06T03:00:36Z\",\n \"server\": null,\n \"arrived_time\": null,\n \"arrived_time_utc\": null,\n \"currency_code\": null,\n \"currency_denominator\": 100,\n \"experience_details\": {\n \"experience_id\": 324887,\n \"experience_title\": \"Michelin Pizza Dinner\",\n \"experience_description\": \"Enjoy an amazing evening with the best pizza, that has won 3 Michelin stars.\",\n \"subtotalAmount\": 20000,\n \"add_ons\": [\n {\n \"ItemID\": \"946651ee-4252-4e3d-945f-eafb6f252b86\",\n \"Quantity\": 1,\n \"Price\": 5000,\n \"LineTotal\": 5000,\n \"LineSubtotalWithTaxes\": 5500,\n \"TaxAmount\": 500,\n \"Name\": \"Truffle add On\",\n \"Description\": \"Add truffles to one pizza\\n\",\n \"CurrencyDenominator\": 0,\n \"Taxes\": [\n {\n \"TaxID\": 1,\n \"Label\": \"Tax\",\n \"TaxPercent\": 10.0,\n \"TaxOnItemAmount\": 500\n }\n ]\n }\n ],\n \"addon_subtotal_amount\": 5500,\n \"diner_payment_status\": null,\n \"service_fee_amount\": 2000,\n \"taxes_amount\": 2200,\n \"tip_amount\": 2000,\n \"total_amount\": 26200\n },\n \"deposit\": {\n \"total_paid\": 5000,\n \"total_refunded\": null,\n \"currency\": null,\n \"currency_denominator\": 100,\n \"status\": \"paid\"\n }\n }\n ]\n}"},{"id":"11740bea-8426-41c6-b2aa-520f80bc9784","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid=1234","host":["{{base-url}}"],"path":["sync","v2","reservations"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"1234"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"9f66f48f-1e52-4191-ac4d-0fab0bbd54b8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"b59c8488-e57c-4cbf-84c3-939db7f0aaa2"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"134"},{"key":"Date","value":"Tue, 15 Oct 2024 06:10:54 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T06:10:54.939+0000\",\n \"path\": \"/sync/v2/reservations\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"11117c11\"\n}"}],"_postman_id":"2367d26e-8ef0-435e-b855-3cac768a3eca"},{"name":"Copper Guests API v2","id":"c52a5f41-7c54-4c32-bf1f-7486f0b58a8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":"{{base-url}}/sync/v2/guests?limit={{limit}}&offset={{offset}}&rid={{rid1}}","description":"
OpenTable Guest Sync API Documentation
\nOverview
\nThe OpenTable Guest Sync API allows users to retrieve detailed information about guest profiles associated with a restaurant.
\n\n
Endpoint
\nURL: {{base-url}}/sync/v2/guests
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters:
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nGuest Object Attributes
\n\n
Error Response for Guests
\nError Messaging
\nThe error response DTO returned by the Sync API collections are in the below format. When reporting issues, always provide the OT-RequestId (located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","v2","guests"],"host":["{{base-url}}"],"query":[{"disabled":true,"key":"email_optin","value":"{{trueorfalse}}"},{"disabled":true,"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid1}}"}],"variable":[]}},"response":[{"id":"aa256ab6-2301-4bea-abf1-debb54aa59d5","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"bearer [Access Token]","disabled":true},{"key":"Cache-Control","value":"no-cache","disabled":true}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"a05ce3ed-0058-403b-b7fc-cc3b2a3a4311"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"217"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 18:38:28 GMT"},{"key":"Content-Length","value":"395"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1038007-325478b0-a2e8-4632-a856-7c35cd135a3e\",\n \"href\": \"https://platform.otqa.com/sync/v2/guests/1038007-325478b0-a2e8-4632-a856-7c35cd135a3e\",\n \"rid\": 1038007,\n \"sequence_id\": 838,\n \"gpid\": \"170193493817\",\n \"tags\": [\n \"gc:diet/no_red_meat\",\n \"gc:profile/investor\",\n \"gc:diet/vegetarian\",\n \"gc:profile/regular\",\n \"gc:profile/blogger\",\n \"gc:service/alert_manager\"\n ],\n \"birth_date\": null,\n \"anniversary_date\": {\n \"name\": \"anniversary\",\n \"year\": 0,\n \"month\": 10,\n \"day\": 13\n },\n \"updated_at\": \"2023-08-10T09:25:39\",\n \"forgotten\": false,\n \"archived\": false,\n \"company_name\": \"\",\n \"created_date\": \"2023-06-05T13:12:44\",\n \"updated_at_utc\": \"2023-08-10T16:25:39Z\",\n \"notes\": null,\n \"notes_special_relationship\": null,\n \"notes_food_and_drink\": null,\n \"notes_seating\": null,\n \"created_date_utc\": \"2023-06-05T20:12:44Z\"\n }\n ]\n}"},{"id":"26a1d389-466f-412e-ad8f-4cc1026f2e0c","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"bbf348f6-37e0-45ed-9f83-b2cc6fd35877"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"97913951-9eea-4707-96a2-b96e17b6fe68"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"128"},{"key":"Date","value":"Tue, 15 Oct 2024 04:49:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T04:49:44.787+0000\",\n \"path\": \"/sync/v2/guests\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"3b6f9d3f\"\n}"}],"_postman_id":"c52a5f41-7c54-4c32-bf1f-7486f0b58a8b"},{"name":"Copper Reservation Webhook","id":"0a4321d8-7055-4669-a186-345a8fd695d0","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Overview
\nThe Reservation Webhook API provides real-time updates about changes in reservation status via webhooks. These updates enable restaurants to seamlessly integrate reservation management into their systems. The webhooks send a detailed JSON payload containing reservation attributes whenever a reservation status changes.
\nTo access Guest Data, please use the guest attribute to call the guest endpoint in Sync API. For more information about Sync API and other available data points via the GET query, please refer to the Sync API tier section of this Portal.
Change Log
\n**** The v3 version of the webhook, released in February 2025 ****
\nData Delivery Method
\nWebhook Implementation
\nWebhooks are triggered on any change in reservation status. A POST request is sent to the specified endpoint with the payload data.
\nConfiguring Your Endpoint
\n- \n
Endpoint URL: Provide an URL where webhook data will be delivered.
\n- \n
- Webhook URL must use https and port 443 \n
\nAuthentication: Basic or bearer token is required to verify authenticity of request
\n \nEvent Handling: Ensure your system handles retries in case of delivery failures.
\n \n
Webhook Security & Validation Requirements
\nTo ensure secure and reliable integrations, all webhook endpoints must comply with the following requirements:
\n1. Redirect Handling
\nWebhook endpoints must not rely on HTTP redirects.
\n- \n
Requests that result in a redirect (3xx responses) will be blocked
\n \nThe configured endpoint must be the final destination URL
\n \nEnsure your endpoint responds directly without forwarding
\n \n
\n
2. URL Schema Validation
\nOnly approved URL schemas are supported for webhook endpoints:
\n- \n
https://— Required for all external endpoints \n
Any other schema (e.g., http://, ftp://) will be rejected.
\n
3. Private Network Restrictions
\nExternal webhook endpoints must resolve to publicly accessible IP addresses.
\n- \n
Endpoints resolving to private or reserved IP ranges will be blocked
\n \nThis includes (but is not limited to):
\n- \n
\n10.x.x.x\n
\n172.16.x.x – 172.31.x.x\n
\n192.168.x.x\n
\n
This restriction helps prevent misconfiguration and protects against unintended access to internal infrastructure.
\n\n
Summary
\n\n
Implementation Guidance
\n- \n
Always provide a fully qualified, final destination HTTPS endpoint
\n \nVerify DNS resolution points to a public IP address
\n \nAvoid intermediary routing layers that introduce redirects
\n \n
Retry Logic
\nWebhook delivery uses an exponential backoff strategy. After three failed attempts, the webhook is marked as undeliverable.
\nAttributes
\nThe webhook payload will not include the same attributes as available in the GET query. To get the additional attributes not delivered in the webhook, Sync API reservataions endpoint will need to be called. Please see the Sync API Copper Reservations API v2 documention for full list of additional attributes.
\nOpenTable reserves the right to update the data sent via the webhook with additional attributes. POS partner should build their ingestion of the webhook to accept any new additional attributes in the future. Partner can choose to process or ignore the additional attributes.
\nThe webhook payload includes the following attributes:
\n","urlObject":{"protocol":"https","host":["partner","supplied","webhook","url"],"query":[],"variable":[]}},"response":[{"id":"f629a702-f9fb-45a1-bb84-0a6e697b434d","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [token]","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sequence_id\": 101112,\r\n \"guest_id\": \"guest-123\",\r\n \"confirmation_id\": 34567,\r\n \"state\": \"Confirmed\",\r\n \"table_number\": [\r\n \"10\"\r\n ],\r\n \"scheduled_time\": \"2024-12-19T19:00:00\",\r\n \"party_size\": 4,\r\n \"server\": \"John Doe\",\r\n \"updated_at_utc\": \"2024-12-19T16:00:00Z\",\r\n \"id\": \"12345\",\r\n \"href\": \"https://api.opentable.com/reservations/12345\",\r\n \"rid\": 6789,\r\n \"guest\": \"https://api.opentable.com/guests/guest-123\",\r\n \"created_date\": \"2024-12-19T10:15:30\",\r\n \"visit_tags\": [\r\n \"birthday\", \r\n \"window seating\"\r\n ],\r\n \"seated_time\": null,\r\n \"done_time\": null,\r\n \"scheduled_time_utc\": \"2024-12-19T23:00:00\",\r\n \"guest_request\": \"Vegetarian meal\",\r\n \"venue_notes\": \"VIP customer\",\r\n \"opentable_notes\": \"10% discount applied\",\r\n \"table_category\": \"hightop\",\r\n \"seated_time_utc\": null,\r\n \"done_time_utc\": null,\r\n \"created_date_utc\": \"2024-12-19T15:15:30Z\",\r\n \"updated_at\": \"2024-12-19T11:00:00\",\r\n \"origin\": \"Web\",\r\n \"arrived_time\": null,\r\n \"arrived_time_utc\": null,\r\n \"experience_details\": {\r\n \"experience_id\": 324887,\r\n \"experience_title\": \"Michelin Pizza Dinner\",\r\n \"experience_description\": \"Enjoy an amazing evening with the best pizza, that has won 3 Michelin stars.\",\r\n \"subtotalAmount\": 20000,\r\n \"add_ons\": [\r\n {\r\n \"ItemID\": \"946651ee-4252-4e3d-945f-eafb6f252b86\",\r\n \"Quantity\": 1,\r\n \"Price\": 5000,\r\n \"LineTotal\": 5000,\r\n \"LineSubtotalWithTaxes\": 5500,\r\n \"TaxAmount\": 500,\r\n \"Name\": \"Truffle add On\",\r\n \"Description\": \"Add truffles to one pizza\\n\",\r\n \"CurrencyDenominator\": 0,\r\n \"Taxes\": [\r\n {\r\n \"TaxID\": 1,\r\n \"Label\": \"Tax\",\r\n \"TaxPercent\": 10.0,\r\n \"TaxOnItemAmount\": 500\r\n }\r\n ]\r\n }\r\n ],\r\n \"addon_subtotal_amount\": 5500,\r\n \"diner_payment_status\": null,\r\n \"service_fee_amount\": 2000,\r\n \"taxes_amount\": 2200,\r\n \"tip_amount\": 2000,\r\n \"total_amount\": 26200\r\n },\r\n \"deposit_details\": {\r\n\t\"totalPaid\": null,\r\n\t\"totalRefunded\": null,\r\n\t\"currency\": null,\r\n\t\"currencyDenominator\": 100,\r\n\t\"status\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner.supplied.webhook.url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"8cc11712-7674-4a96-9bfc-f751060671f0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"5f9f6a89-304b-4154-8099-6af169716afb"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"posRestaurantService"},{"key":"X-OT-UriTemplate","value":"/posRestaurantService/api/v1/pos/restaurants/all"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:14:56 GMT"},{"key":"Content-Length","value":"217"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"ak_bmsc=3463BA8A2F5F898E431053FB11A4FC81~000000000000000000000000000000~YAAQrMgwFzVFvxSVAQAAeVpJJhqT4Q+RrwCMj6eV9YZ73di5fgE47UgzVvn5/Dj7JmO3MdDssZ1Es52ACr6QuguhqG9rakimmHM4CGWMuhrug8m41vdiT8Nq+EgNkb0MsSNgtEF57YplW/pGm3fvP5brV8anMVe8cU9+26gYbmv+IIxIU+ns2n4atOARAabg3Q6/39lJv0u68WbhTutL8R6hgbZRbfpkLCyonbQZL6+sA7bHj+2W61KirChF5M/IUM1uo+QcQsbiEWW1ybajDV3K+CBz9QK24YU8TpCruubKI2PPPtmUplAZsN23rw5WnSpMp5Y04qtml8MojOeOpNK2gcxxiN/FzVAbyvQ=; Domain=.opentable.com; Path=/; Expires=Fri, 21 Feb 2025 04:14:56 GMT; Max-Age=7200"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0a4321d8-7055-4669-a186-345a8fd695d0"}],"id":"4b72c023-6026-44ff-825a-8b1f1100786a","_postman_id":"4b72c023-6026-44ff-825a-8b1f1100786a","description":""},{"name":"Gold","item":[{"name":"Gold Guests API v2","id":"67b9bfbd-5af1-42a1-9673-6b34e588db80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":"{{base-url}}/sync/v2/guests?limit={{limit}}&offset={{offset}}&rid={{rid2}}","description":"OpenTable Guest Sync API Documentation
\nOverview
\nThe OpenTable Guest Sync API allows users to retrieve detailed information about guest profiles associated with a restaurant.
\n\n
Endpoint
\nURL: {{base-url}}/sync/v2/guests
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters:
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nGuest Object Attributes
\nError Response for Guests
\nError Messaging
\nThe error response DTO returned by the Sync API collections are in the below format. When reporting issues, always provide the OT-RequestId (located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","v2","guests"],"host":["{{base-url}}"],"query":[{"disabled":true,"key":"email_optin","value":"{{trueorfalse}}"},{"disabled":true,"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid2}}"}],"variable":[]}},"response":[{"id":"cd2f9d48-f332-4e4a-a9e0-bffac06d0980","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"bearer [Access Token]","disabled":true},{"key":"Cache-Control","value":"no-cache","disabled":true}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"a05ce3ed-0058-403b-b7fc-cc3b2a3a4311"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"217"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 18:38:28 GMT"},{"key":"Content-Length","value":"395"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"href\": \"https://platform.otqa.com/sync/v2/guests/1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"rid\": 1234567,\n \"sequence_id\": 1,\n \"gpid\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"email_optin\": true,\n \"phone\": \"2125555555\",\n \"phone_type\": \"Mobile\",\n \"tags\": null,\n \"birth_date\": null,\n \"anniversary_date\": null,\n \"updated_at\": \"2024-12-20T08:09:19\",\n \"forgotten\": false,\n \"archived\": false,\n \"primary_guest\": null,\n \"address\": null,\n \"mail_opted_in\": false,\n \"company_name\": null,\n \"phone_numbers\": [\n {\n \"label\": \"Mobile\",\n \"number\": \"2125555555\",\n \"country_code\": \"1\",\n \"primary\": true\n }\n ],\n \"created_date\": \"2024-12-20T08:09:19\",\n \"updated_at_utc\": \"2024-12-20T16:09:19Z\",\n \"marketing_opted_out\": false,\n \"notes\": null,\n \"notes_special_relationship\": null,\n \"notes_food_and_drink\": null,\n \"notes_seating\": null,\n \"created_date_utc\": \"2024-12-20T16:09:19Z\",\n \"date_last_visit\": \"2024-12-20T05:00:00\",\n \"date_first_visit\": \"2024-12-20T05:00:00\",\n \"date_last_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"date_first_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"is_hidden\": false\n }\n ]\n}"},{"id":"8916d831-ac1c-4cce-9c18-2d0e6c4b582e","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"bbf348f6-37e0-45ed-9f83-b2cc6fd35877"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"97913951-9eea-4707-96a2-b96e17b6fe68"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"128"},{"key":"Date","value":"Tue, 15 Oct 2024 04:49:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T04:49:44.787+0000\",\n \"path\": \"/sync/v2/guests\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"3b6f9d3f\"\n}"}],"_postman_id":"67b9bfbd-5af1-42a1-9673-6b34e588db80"},{"name":"Gold Reservations API v2","id":"daee43f4-1c0f-4686-a211-6aca2a13ac23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid={{rid2}}","description":"Overview
\nThe Reservation API provides detailed data about restaurant reservations and allows applications to filter and retrieve records based on various parameters. This endpoint is designed to support restaurant management systems and third-party applications in obtaining accurate and timely reservation data.
\n\n
API Endpoint
\nURL: https://platform.opentable.com/sync/v2/reservations
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nResponse Payload
\nThe response includes metadata about the paginated results, followed by an array of reservation objects.
\n\n","urlObject":{"path":["sync","v2","reservations"],"host":["{{base-url}}"],"query":[{"disabled":true,"key":"state","value":"Done"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid2}}"}],"variable":[]}},"response":[{"id":"e9898f45-5047-4dc7-832f-74ba8efdf2f9","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","reservations"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"81f3d2ce-e200-46bd-b37a-0a409dfe30f9"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"f87ee1d1-bb2c-448c-959b-215b2f1a4183"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Tue, 15 Oct 2024 06:10:14 GMT"},{"key":"Content-Length","value":"1991"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1234567-49bcffdf-0476-4464-9bd0-66e87dc289de\",\n \"href\": \"https://platform.opentable.com/sync/v2/reservations/1234567-49bcffdf-0476-4464-9bd0-66e87dc289de\",\n \"rid\": 1234567,\n \"sequence_id\": 86941,\n \"guest_id\": \"1234567-05a8f2a2-3428-4000-9867-ca82795cb365\",\n \"guest\": \"https://platform.opentable.com/sync/v2/guests/1234567-05a8f2a2-3428-4000-9867-ca82795cb365\",\n \"confirmation_id\": 15989,\n \"state\": \"Cancelled\",\n \"table_number\": [\n \"80\"\n ],\n \"created_date\": \"2025-01-09T06:31:39\",\n \"scheduled_time\": \"2025-02-14T19:30:00\",\n \"party_size\": 2,\n \"visit_tags\": [\n \"gc:service/date\"\n ],\n \"origin\": \"Web\",\n \"updated_at\": \"2025-02-06T14:00:36\",\n \"seated_time\": null,\n \"done_time\": null,\n \"pos_data\": {\n \"check_ids\": null,\n \"pos_sub_total\": null,\n \"pos_tax\": null,\n \"pos_tip\": null,\n \"pos_total_spend\": null\n },\n \"scheduled_time_utc\": \"2025-02-14T08:30:00Z\",\n \"marketing_opted_out\": false,\n \"guest_request\": \"\",\n \"venue_notes\": null,\n \"opentable_notes\": \"\",\n \"table_category\": null,\n \"seated_time_utc\": null,\n \"done_time_utc\": null,\n \"created_date_utc\": \"2025-01-08T19:31:39Z\",\n \"updated_at_utc\": \"2025-02-06T03:00:36Z\",\n \"server\": null,\n \"referrer\": null,\n \"added_to_waitlist\": null,\n \"added_to_waitlist_utc\": null,\n \"arrived_time\": null,\n \"arrived_time_utc\": null,\n \"currency_code\": null,\n \"currency_denominator\": 100\n }\n ]\n}"},{"id":"00a6a111-7ae7-42fc-a0fc-30e4524b1d4f","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid=1234","host":["{{base-url}}"],"path":["sync","v2","reservations"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"1234"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"9f66f48f-1e52-4191-ac4d-0fab0bbd54b8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"b59c8488-e57c-4cbf-84c3-939db7f0aaa2"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"134"},{"key":"Date","value":"Tue, 15 Oct 2024 06:10:54 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T06:10:54.939+0000\",\n \"path\": \"/sync/v2/reservations\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"11117c11\"\n}"}],"_postman_id":"daee43f4-1c0f-4686-a211-6aca2a13ac23"},{"name":"Gold Reservation Webhook","id":"7dda167c-2237-4550-a059-f02357f93ebb","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"
Overview
\nThe Reservation Webhook API provides real-time updates about changes in reservation status via webhooks. These updates enable restaurants to seamlessly integrate reservation management into their systems. The webhooks send a detailed JSON payload containing reservation attributes whenever a reservation status changes.
\nTo access Guest Data, please use the guest attribute to call the guest endpoint in Sync API. For more information about Sync API and other available data points via the GET query, please refer to the Sync API tier section of this Portal.
Change Log
\n**** The v3 version of the webhook, released in February 2025 ****
\nData Delivery Method
\nWebhook Implementation
\nWebhooks are triggered on any change in reservation status. A POST request is sent to the specified endpoint with the payload data.
\nConfiguring Your Endpoint
\n- \n
Endpoint URL: Provide an URL where webhook data will be delivered.
\n- \n
- Webhook URL must use https and port 443 \n
\nAuthentication: Basic or bearer token is required to verify authenticity of request
\n \nEvent Handling: Ensure your system handles retries in case of delivery failures.
\n \n
Webhook Security & Validation Requirements
\nTo ensure secure and reliable integrations, all webhook endpoints must comply with the following requirements:
\n1. Redirect Handling
\nWebhook endpoints must not rely on HTTP redirects.
\n- \n
Requests that result in a redirect (3xx responses) will be blocked
\n \nThe configured endpoint must be the final destination URL
\n \nEnsure your endpoint responds directly without forwarding
\n \n
\n
2. URL Schema Validation
\nOnly approved URL schemas are supported for webhook endpoints:
\n- \n
https://— Required for all external endpoints \n
Any other schema (e.g., http://, ftp://) will be rejected.
\n
3. Private Network Restrictions
\nExternal webhook endpoints must resolve to publicly accessible IP addresses.
\n- \n
Endpoints resolving to private or reserved IP ranges will be blocked
\n \nThis includes (but is not limited to):
\n- \n
\n10.x.x.x\n
\n172.16.x.x – 172.31.x.x\n
\n192.168.x.x\n
\n
This restriction helps prevent misconfiguration and protects against unintended access to internal infrastructure.
\n\n
Summary
\n\n
Implementation Guidance
\n- \n
Always provide a fully qualified, final destination HTTPS endpoint
\n \nVerify DNS resolution points to a public IP address
\n \nAvoid intermediary routing layers that introduce redirects
\n \n
Retry Logic
\nWebhook delivery uses an exponential backoff strategy. After three failed attempts, the webhook is marked as undeliverable.
\nAttributes
\nThe webhook payload will not include the same attributes as available in the GET query. To get the additional attributes not delivered in the webhook, Sync API reservations endpoint will need to be called. Please see the Sync API Reservations v2 documentation for full list of additional attributes.
\nOpenTable reserves the right to update the data sent via the webhook with additional attributes. POS partner should build their ingestion of the webhook to accept any new additional attributes in the future. Partner can choose to process or ignore the additional attributes.
\nThe webhook payload includes the following attributes:
\n","urlObject":{"protocol":"https","host":["partner","supplied","webhook","url"],"query":[],"variable":[]}},"response":[{"id":"14e6a5d7-fc02-4466-9ff7-c18d9dc89ee2","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [token]","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sequence_id\": 101112,\r\n \"guest_id\": \"guest-123\",\r\n \"confirmation_id\": 34567,\r\n \"state\": \"Confirmed\",\r\n \"table_number\": [\r\n \"10\"\r\n ],\r\n \"scheduled_time\": \"2024-12-19T19:00:00\",\r\n \"party_size\": 4,\r\n \"server\": \"John Doe\",\r\n \"updated_at_utc\": \"2024-12-19T16:00:00Z\",\r\n \"id\": \"12345\",\r\n \"href\": \"https://api.opentable.com/reservations/12345\",\r\n \"rid\": 6789,\r\n \"guest\": \"https://api.opentable.com/guests/guest-123\",\r\n \"created_date\": \"2024-12-19T10:15:30\",\r\n \"visit_tags\": [\r\n \"birthday\", \r\n \"window seating\"\r\n ],\r\n \"seated_time\": null,\r\n \"done_time\": null,\r\n \"scheduled_time_utc\": \"2024-12-19T23:00:00\",\r\n \"guest_request\": \"Vegetarian meal\",\r\n \"venue_notes\": \"VIP customer\",\r\n \"opentable_notes\": \"10% discount applied\",\r\n \"table_category\": \"hightop\",\r\n \"seated_time_utc\": null,\r\n \"done_time_utc\": null,\r\n \"created_date_utc\": \"2024-12-19T15:15:30Z\",\r\n \"updated_at\": \"2024-12-19T11:00:00\",\r\n \"origin\": \"Web\",\r\n \"arrived_time\": null,\r\n \"arrived_time_utc\": null,\r\n \"deposit_details\": {\r\n\t\"totalPaid\": null,\r\n\t\"totalRefunded\": null,\r\n\t\"currency\": null,\r\n\t\"currencyDenominator\": 100,\r\n\t\"status\": null\r\n },\r\n \"referrer\": {\r\n \"company\": \"Concierge Company ABC\",\r\n \"id\": \"19999999940618\",\r\n \"first_name\": \"Connie\",\r\n \"last_name\": \"Concierge\",\r\n \"email\": \"cconcierge@conciergeabc.com\",\r\n \"phone\": \"8335551212\"\r\n },\r\n \"added_to_waitlist\": null,\r\n \"added_to_waitlist_utc\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner.supplied.webhook.url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"8cc11712-7674-4a96-9bfc-f751060671f0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"5f9f6a89-304b-4154-8099-6af169716afb"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"posRestaurantService"},{"key":"X-OT-UriTemplate","value":"/posRestaurantService/api/v1/pos/restaurants/all"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:14:56 GMT"},{"key":"Content-Length","value":"217"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"ak_bmsc=3463BA8A2F5F898E431053FB11A4FC81~000000000000000000000000000000~YAAQrMgwFzVFvxSVAQAAeVpJJhqT4Q+RrwCMj6eV9YZ73di5fgE47UgzVvn5/Dj7JmO3MdDssZ1Es52ACr6QuguhqG9rakimmHM4CGWMuhrug8m41vdiT8Nq+EgNkb0MsSNgtEF57YplW/pGm3fvP5brV8anMVe8cU9+26gYbmv+IIxIU+ns2n4atOARAabg3Q6/39lJv0u68WbhTutL8R6hgbZRbfpkLCyonbQZL6+sA7bHj+2W61KirChF5M/IUM1uo+QcQsbiEWW1ybajDV3K+CBz9QK24YU8TpCruubKI2PPPtmUplAZsN23rw5WnSpMp5Y04qtml8MojOeOpNK2gcxxiN/FzVAbyvQ=; Domain=.opentable.com; Path=/; Expires=Fri, 21 Feb 2025 04:14:56 GMT; Max-Age=7200"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7dda167c-2237-4550-a059-f02357f93ebb"}],"id":"87c5f456-92f6-4dd4-b90b-2b9446da8ff8","_postman_id":"87c5f456-92f6-4dd4-b90b-2b9446da8ff8","description":""},{"name":"Platinum","item":[{"name":"Platinum Guests API v2","id":"9f359a15-d0a1-467d-a7ba-d70761372344","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":"{{base-url}}/sync/v2/guests?limit={{limit}}&offset={{offset}}&rid={{rid3}}","description":"OpenTable Guest Sync API Documentation
\nOverview
\nThese APIs give approved restaurant developers the ability to acquire and consume guest data. The Sync API is currently not included in the public developer program. Inquiries sent to our team will be considered on a case by case basis.
\n\n
Endpoint
\nURL: {{base-url}}/sync/v2/guests
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters:
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nGuest Object Attributes
\n\n
Error Response for Guests
\nError Messaging
\nThe error response DTO returned by the Sync API collections are in the below format. When reporting issues, always provide the OT-RequestId (located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","v2","guests"],"host":["{{base-url}}"],"query":[{"disabled":true,"key":"email_optin","value":"{{trueorfalse}}"},{"disabled":true,"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid3}}"}],"variable":[]}},"response":[{"id":"e00d5034-38a6-4f0e-9534-06391074a5d6","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"bearer [Access Token]","disabled":true},{"key":"Cache-Control","value":"no-cache","disabled":true}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"a05ce3ed-0058-403b-b7fc-cc3b2a3a4311"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"217"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 18:38:28 GMT"},{"key":"Content-Length","value":"395"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"href\": \"https://platform.otqa.com/sync/v2/guests/1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"rid\": 1234567,\n \"sequence_id\": 1,\n \"gpid\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"email_optin\": true,\n \"phone\": \"2125555555\",\n \"phone_type\": \"Mobile\",\n \"tags\": null,\n \"birth_date\": null,\n \"anniversary_date\": null,\n \"updated_at\": \"2024-12-20T08:09:19\",\n \"forgotten\": false,\n \"archived\": false,\n \"primary_guest\": null,\n \"address\": null,\n \"mail_opted_in\": false,\n \"company_name\": null,\n \"phone_numbers\": [\n {\n \"label\": \"Mobile\",\n \"number\": \"2125555555\",\n \"country_code\": \"1\",\n \"primary\": true\n }\n ],\n \"created_date\": \"2024-12-20T08:09:19\",\n \"updated_at_utc\": \"2024-12-20T16:09:19Z\",\n \"marketing_opted_out\": false,\n \"notes\": null,\n \"notes_special_relationship\": null,\n \"notes_food_and_drink\": null,\n \"notes_seating\": null,\n \"created_date_utc\": \"2024-12-20T16:09:19Z\",\n \"date_last_visit\": \"2025-01-12T15:00:00\",\n \"date_first_visit\": \"2024-12-20T05:00:00\",\n \"date_email_opt_in_opt_out\": \"2024-12-20T05:00:00\", \n \"date_last_visit_utc\": \"2025-01-12T23:00:00Z\",\n \"date_first_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"date_email_opt_in_opt_out_utc\": \"2024-12-20T13:00:00Z\",\n \"sms_opt_in\": null, \n \"is_hidden\": false\n }\n ]\n}"},{"id":"f308f2d7-8759-4ae3-98aa-60ce3b5be8c7","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"bbf348f6-37e0-45ed-9f83-b2cc6fd35877"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"97913951-9eea-4707-96a2-b96e17b6fe68"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"128"},{"key":"Date","value":"Tue, 15 Oct 2024 04:49:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T04:49:44.787+0000\",\n \"path\": \"/sync/v2/guests\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"3b6f9d3f\"\n}"}],"_postman_id":"9f359a15-d0a1-467d-a7ba-d70761372344"},{"name":"Platinum Reservations API v2","id":"5f393549-78b6-4a9b-a839-144b895b5ebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid={{rid3}}","description":"Overview
\nThe Reservation API provides detailed data about restaurant reservations and allows applications to filter and retrieve records based on various parameters. This endpoint is designed to support restaurant management systems and third-party applications in obtaining accurate and timely reservation data.
\n\n
API Endpoint
\nURL: https://platform.opentable.com/sync/v2/reservations
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse attributes
\n\n
Reservation (object) attributes
\n\n","urlObject":{"path":["sync","v2","reservations"],"host":["{{base-url}}"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid3}}"}],"variable":[]}},"response":[{"id":"c557d360-d95a-4917-911b-5ea9828c8484","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","reservations"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"81f3d2ce-e200-46bd-b37a-0a409dfe30f9"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"f87ee1d1-bb2c-448c-959b-215b2f1a4183"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Tue, 15 Oct 2024 06:10:14 GMT"},{"key":"Content-Length","value":"1991"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"188878-49bcffdf-0476-4464-9bd0-66e87dc289de\",\n \"href\": \"https://platform.opentable.com/sync/v2/reservations/188878-49bcffdf-0476-4464-9bd0-66e87dc289de\",\n \"rid\": 188878,\n \"sequence_id\": 86941,\n \"guest_id\": \"188878-05a8f2a2-3428-4000-9867-ca82795cb365\",\n \"guest\": \"https://platform.opentable.com/sync/v2/guests/188878-05a8f2a2-3428-4000-9867-ca82795cb365\",\n \"confirmation_id\": 15989,\n \"state\": \"Cancelled\",\n \"table_number\": [\n \"80\"\n ],\n \"created_date\": \"2025-01-09T06:31:39\",\n \"scheduled_time\": \"2025-02-14T19:30:00\",\n \"party_size\": 2,\n \"visit_tags\": [\n \"gc:service/date\"\n ],\n \"origin\": \"Web\",\n \"updated_at\": \"2025-02-06T14:00:36\",\n \"seated_time\": null,\n \"done_time\": null,\n \"pos_data\": {\n \"check_ids\": null,\n \"pos_sub_total\": null,\n \"pos_tax\": null,\n \"pos_tip\": null,\n \"pos_total_spend\": null\n },\n \"scheduled_time_utc\": \"2025-02-14T08:30:00Z\",\n \"marketing_opted_out\": false,\n \"guest_request\": \"\",\n \"venue_notes\": null,\n \"opentable_notes\": \"\",\n \"table_category\": null,\n \"seated_time_utc\": null,\n \"done_time_utc\": null,\n \"created_date_utc\": \"2025-01-08T19:31:39Z\",\n \"updated_at_utc\": \"2025-02-06T03:00:36Z\",\n \"server\": null,\n \"referrer\": null,\n \"added_to_waitlist\": null,\n \"added_to_waitlist_utc\": null,\n \"email\": \"\",\n \"sms_opt_in\": null,\n \"arrived_time\": null,\n \"arrived_time_utc\": null,\n \"quoted_wait_time\": 0,\n \"online_source\": \"Phone/In-house\",\n \"discovery_type\": null,\n \"partner\": null,\n \"campaign_details\": null,\n \"credit_card_status\": null,\n \"cancellation_date\": null,\n \"cancellation_date_utc\": null,\n \"rest_ref_campaign_name\": null,\n \"rest_ref_id\": null,\n \"rest_ref_source\": null,\n \"currency_code\": null,\n \"currency_denominator\": 100,\n \"experience_details\": {\n \"experience_id\": 324887,\n \"experience_title\": \"Michelin Pizza Dinner\",\n \"experience_description\": \"Enjoy an amazing evening with the best pizza, that has won 3 Michelin stars.\",\n \"subtotalAmount\": 20000,\n \"add_ons\": [\n {\n \"ItemID\": \"946651ee-4252-4e3d-945f-eafb6f252b86\",\n \"Quantity\": 1,\n \"Price\": 5000,\n \"LineTotal\": 5000,\n \"LineSubtotalWithTaxes\": 5500,\n \"TaxAmount\": 500,\n \"Name\": \"Truffle add On\",\n \"Description\": \"Add truffles to one pizza\\n\",\n \"CurrencyDenominator\": 0,\n \"Taxes\": [\n {\n \"TaxID\": 1,\n \"Label\": \"Tax\",\n \"TaxPercent\": 10.0,\n \"TaxOnItemAmount\": 500\n }\n ]\n }\n ],\n \"addon_subtotal_amount\": 5500,\n \"diner_payment_status\": null,\n \"service_fee_amount\": 2000,\n \"taxes_amount\": 2200,\n \"tip_amount\": 2000,\n \"total_amount\": 26200\n },\n \"deposit\": {\n \"total_paid\": null,\n \"total_refunded\": null,\n \"currency\": null,\n \"currency_denominator\": 100,\n \"status\": null\n },\n \"ot_boost_type\": null\n }, \n}"},{"id":"9ac0cfe4-58e7-4f9f-8ccc-518a8631623b","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/reservations?limit={{limit}}&offset={{offset}}&rid=1234","host":["{{base-url}}"],"path":["sync","v2","reservations"],"query":[{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"1234"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"9f66f48f-1e52-4191-ac4d-0fab0bbd54b8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"b59c8488-e57c-4cbf-84c3-939db7f0aaa2"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"134"},{"key":"Date","value":"Tue, 15 Oct 2024 06:10:54 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T06:10:54.939+0000\",\n \"path\": \"/sync/v2/reservations\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"11117c11\"\n}"}],"_postman_id":"5f393549-78b6-4a9b-a839-144b895b5ebb"},{"name":"Platinum Orders API v2","id":"80fb92b6-b53e-4f86-850a-adfd015c6a75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base-url}}/sync/v2/pos-data?rid={{rid}}&scheduled_time_from={{scheduled_time_from}}&scheduled_time_to={{scheduled_time_to}}","description":"
Overview
\nThe POS Data API enables seamless integration between OpenTable and point-of-sale (POS) systems. By leveraging this API, restaurants can access detailed POS data for reservations, including subtotal, tax, tip, total spend, and individual order items. The API supports advanced filtering and pagination for efficient data retrieval.
\n\n
Endpoint
\nURL: {{base-url}}/sync/v2/pos-data
Method: GET
\nRequest Details
\nHeaders
\n\n
Query Parameters
\n\n
Response Body
\n\n
Item Array
\n\n
POS Order Item Object
\n\n
Notes
\n- \n
Currency Handling: The
\ncurrency_denominatorrepresents the smallest currency unit (e.g., cents for USD). Divide monetary values bycurrency_denominatorto get the full amount. \nItem Uniqueness: Each
\nidis unique to an individual transaction. \nOptional Fields: Fields like
\nguest_id,nextPageUrl,comment, andticket_item_modifierscan be null, indicating missing data. \n
\n
Error Codes
\n\n","urlObject":{"path":["sync","v2","pos-data"],"host":["{{base-url}}"],"query":[{"key":"rid","value":"{{rid}}"},{"key":"scheduled_time_from","value":"{{scheduled_time_from}}"},{"key":"scheduled_time_to","value":"{{scheduled_time_to}}"}],"variable":[]}},"response":[{"id":"05d3a0ea-365e-4bf4-8216-fc5c86d30513","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base-url}}/sync/v2/pos-data?rid={{rid}}&scheduled_time_from={{scheduled_time_from}}&scheduled_time_to={{scheduled_time_to}}","host":["{{base-url}}"],"path":["sync","v2","pos-data"],"query":[{"key":"rid","value":"{{rid}}"},{"key":"scheduled_time_from","value":"{{scheduled_time_from}}"},{"key":"scheduled_time_to","value":"{{scheduled_time_to}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"fe4e479e-99e4-4144-95cc-fcb75bc3f77c"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"565"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 20 Dec 2024 18:37:32 GMT"},{"key":"Content-Length","value":"264"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1234567-40258624-C992-44A1-A396-2F9A6EF63070\",\n \"rid\": 1234567,\n \"guest_id\": \"1234567-0F61AC32-21FB-4BD1-B6CD-745FE14360F2\",\n \"confirmation_id\": 73734010,\n \"currency_code\": \"USD\",\n \"currency_denominator\": 100,\n \"check_ids\": [\n \"20240701-30025\"\n ],\n \"pos_sub_total\": 8100,\n \"pos_tax\": 891,\n \"pos_tip\": 1730,\n \"pos_total_spend\": 10721,\n \"pos_order_items\": [\n {\n \"name\": \"NY Strip\",\n \"quantity\": 1,\n \"comment\": null,\n \"price_per_unit\": 6250,\n \"ticket_item_modifiers\": null\n },\n {\n \"name\": \"Btl. Diet Cola\",\n \"quantity\": 1,\n \"comment\": null,\n \"price_per_unit\": 450,\n \"ticket_item_modifiers\": null\n },\n {\n \"name\": \"Glass Merlot\",\n \"quantity\": 1,\n \"comment\": null,\n \"price_per_unit\": 1400,\n \"ticket_item_modifiers\": null\n }\n ]\n }\n ]\n}"},{"id":"2058db46-0c5b-428e-8e67-de6122df6814","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base-url}}/sync/v2/pos-data?rid=1234&scheduled_time_from={{scheduled_time_from}}&scheduled_time_to={{scheduled_time_to}}","host":["{{base-url}}"],"path":["sync","v2","pos-data"],"query":[{"key":"rid","value":"1234"},{"key":"scheduled_time_from","value":"{{scheduled_time_from}}"},{"key":"scheduled_time_to","value":"{{scheduled_time_to}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"1acb7911-7ce2-41e5-962a-48983a0512f3"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"61"},{"key":"Content-Length","value":"130"},{"key":"Date","value":"Fri, 20 Dec 2024 18:36:00 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-12-20T18:36:00.073+0000\",\n \"path\": \"/sync/v2/pos-data\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"556d6d11\"\n}"}],"_postman_id":"80fb92b6-b53e-4f86-850a-adfd015c6a75"},{"name":"Platinum Reservation Webhook","id":"59162776-26ff-448a-839c-2c3b6e23a8d2","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"
Overview
\nThe Reservation Webhook API provides real-time updates about changes in reservation status via webhooks. These updates enable restaurants to seamlessly integrate reservation management into their systems. The webhooks send a detailed JSON payload containing reservation attributes whenever a reservation status changes.
\nTo access Guest Data, please use the guest attribute to call the guest endpoint in Sync API. For more information about Sync API and other available data points via the GET query, please refer to the Sync API tier section of this Portal.
Change Log
\n**** The v3 version of the webhook, released in February 2025 ****
\nData Delivery Method
\nWebhook Implementation
\nWebhooks are triggered on any change in reservation status. A POST request is sent to the specified endpoint with the payload data.
\nConfiguring Your Endpoint
\n- \n
Endpoint URL: Provide an URL where webhook data will be delivered.
\n- \n
- Webhook URL must use https and port 443 \n
\nAuthentication:
\n- \n
Basic or bearer token is required to verify authenticity of request
\n \nCode: Added as path parameter, no authentication mode needed if using this method
\n \n
\nEvent Handling: Ensure your system handles retries in case of delivery failures.
\n \n
Webhook Security & Validation Requirements
\nTo ensure secure and reliable integrations, all webhook endpoints must comply with the following requirements:
\n1. Redirect Handling
\nWebhook endpoints must not rely on HTTP redirects.
\n- \n
Requests that result in a redirect (3xx responses) will be blocked
\n \nThe configured endpoint must be the final destination URL
\n \nEnsure your endpoint responds directly without forwarding
\n \n
\n
2. URL Schema Validation
\nOnly approved URL schemas are supported for webhook endpoints:
\n- \n
https://— Required for all external endpoints \n
Any other schema (e.g., http://, ftp://) will be rejected.
\n
3. Private Network Restrictions
\nExternal webhook endpoints must resolve to publicly accessible IP addresses.
\n- \n
Endpoints resolving to private or reserved IP ranges will be blocked
\n \nThis includes (but is not limited to):
\n- \n
\n10.x.x.x\n
\n172.16.x.x – 172.31.x.x\n
\n192.168.x.x\n
\n
This restriction helps prevent misconfiguration and protects against unintended access to internal infrastructure.
\n\n
Summary
\n\n
Implementation Guidance
\n- \n
Always provide a fully qualified, final destination HTTPS endpoint
\n \nVerify DNS resolution points to a public IP address
\n \nAvoid intermediary routing layers that introduce redirects
\n \n
Retry Logic
\nWebhook delivery uses an exponential backoff strategy. After three failed attempts, the webhook is marked as undeliverable.
\nAttributes
\nThe webhook payload will not include the same attributes as available in the GET query. To get the additional attributes not delivered in the webhook, Sync API reservations endpoint will need to be called. Please see the Sync API Reservations v2 documentation for full list of additional attributes.
\nOpenTable reserves the right to update the data sent via the webhook with additional attributes. POS partner should build their ingestion of the webhook to accept any new additional attributes in the future. Partner can choose to process or ignore the additional attributes.
\nThe webhook payload includes the following attributes:
\n","urlObject":{"protocol":"https","host":["partner","supplied","webhook","url"],"query":[],"variable":[]}},"response":[{"id":"7b82cbdc-f18a-44df-9f6b-431a8cbda6b9","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [token]","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sequence_id\": 101112,\r\n \"guest_id\": \"guest-123\",\r\n \"confirmation_id\": 34567,\r\n \"state\": \"Confirmed\",\r\n \"table_number\": [\r\n \"10\"\r\n ],\r\n \"scheduled_time\": \"2024-12-19T19:00:00\",\r\n \"party_size\": 4,\r\n \"server\": \"John Doe\",\r\n \"updated_at_utc\": \"2024-12-19T16:00:00Z\",\r\n \"id\": \"12345\",\r\n \"href\": \"https://api.opentable.com/reservations/12345\",\r\n \"rid\": 6789,\r\n \"guest\": \"https://api.opentable.com/guests/guest-123\",\r\n \"created_date\": \"2024-12-19T10:15:30\",\r\n \"visit_tags\": [\r\n \"birthday\", \r\n \"window seating\"\r\n ],\r\n \"seated_time\": null,\r\n \"done_time\": null,\r\n \"scheduled_time_utc\": \"2024-12-19T23:00:00\",\r\n \"guest_request\": \"Vegetarian meal\",\r\n \"venue_notes\": \"VIP customer\",\r\n \"opentable_notes\": \"10% discount applied\",\r\n \"table_category\": \"hightop\",\r\n \"seated_time_utc\": null,\r\n \"done_time_utc\": null,\r\n \"created_date_utc\": \"2024-12-19T15:15:30Z\",\r\n \"updated_at\": \"2024-12-19T11:00:00\",\r\n \"origin\": \"Web\",\r\n \"arrived_time\": null,\r\n \"arrived_time_utc\": null,\r\n \"deposit_details\": {\r\n\t\"totalPaid\": null,\r\n\t\"totalRefunded\": null,\r\n\t\"currency\": null,\r\n\t\"currencyDenominator\": 100,\r\n\t\"status\": null\r\n },\r\n \"referrer\": {\r\n \"company\": \"Concierge Company ABC\",\r\n \"id\": \"19999999940618\",\r\n \"first_name\": \"Connie\",\r\n \"last_name\": \"Concierge\",\r\n \"email\": \"cconcierge@conciergeabc.com\",\r\n \"phone\": \"8335551212\"\r\n },\r\n \"added_to_waitlist\": null,\r\n \"added_to_waitlist_utc\": null,\r\n \"sms_opt_in\": null,\r\n \"quoted_wait_time\": 0,\r\n \"cancellation_date\": null,\r\n \"cancellation_date_utc\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner.supplied.webhook.url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"8cc11712-7674-4a96-9bfc-f751060671f0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"5f9f6a89-304b-4154-8099-6af169716afb"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"posRestaurantService"},{"key":"X-OT-UriTemplate","value":"/posRestaurantService/api/v1/pos/restaurants/all"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:14:56 GMT"},{"key":"Content-Length","value":"217"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"ak_bmsc=3463BA8A2F5F898E431053FB11A4FC81~000000000000000000000000000000~YAAQrMgwFzVFvxSVAQAAeVpJJhqT4Q+RrwCMj6eV9YZ73di5fgE47UgzVvn5/Dj7JmO3MdDssZ1Es52ACr6QuguhqG9rakimmHM4CGWMuhrug8m41vdiT8Nq+EgNkb0MsSNgtEF57YplW/pGm3fvP5brV8anMVe8cU9+26gYbmv+IIxIU+ns2n4atOARAabg3Q6/39lJv0u68WbhTutL8R6hgbZRbfpkLCyonbQZL6+sA7bHj+2W61KirChF5M/IUM1uo+QcQsbiEWW1ybajDV3K+CBz9QK24YU8TpCruubKI2PPPtmUplAZsN23rw5WnSpMp5Y04qtml8MojOeOpNK2gcxxiN/FzVAbyvQ=; Domain=.opentable.com; Path=/; Expires=Fri, 21 Feb 2025 04:14:56 GMT; Max-Age=7200"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"59162776-26ff-448a-839c-2c3b6e23a8d2"}],"id":"c015edbb-4e52-40e9-ae84-59189339e172","_postman_id":"c015edbb-4e52-40e9-ae84-59189339e172","description":""},{"name":"Use Cases","item":[{"name":"Sync API - I would like to consume opted in Emails for my Email Marketing Program","item":[{"name":"Gold Guests API v2","id":"710d89e5-ca7b-435e-a7b7-9741554fc6fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","description":"OpenTable Guest Sync API Documentation
\nOverview
\nThe OpenTable Guest Sync API allows users to retrieve detailed information about guest profiles associated with a restaurant.
\n\n
Endpoint
\nURL: {{base-url}}/sync/v2/guests
Method: GET
\nRequest Details
\nHeaders
\nQuery Parameters:
\nResponse Structure
\nThe response is a JSON object containing metadata about pagination and an array of guest objects.
\nResponse Attributes
\nGuest Object Attributes
\n\n
Error Response for Guests
\nError Messaging
\nThe error response DTO returned by the Sync API collections are in the below format. When reporting issues, always provide the OT-RequestId (located in the response header) to allow OpenTable to uniquely identify a specific request.
\n","urlObject":{"path":["sync","v2","guests"],"host":["{{base-url}}"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}],"variable":[]}},"response":[{"id":"bc7927fb-0d27-4847-8aa3-ce709892f655","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Authorization","value":"bearer [Access Token]","disabled":true},{"key":"Cache-Control","value":"no-cache","disabled":true}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"OT-RequestId","value":"a05ce3ed-0058-403b-b7fc-cc3b2a3a4311"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"ot-anonymousid","value":"1BCCF72D-18C9-4184-A456-517D3FE34A15"},{"key":"Content-Type","value":"application/json"},{"key":"x-envoy-upstream-service-time","value":"217"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Mon, 23 Dec 2024 18:38:28 GMT"},{"key":"Content-Length","value":"395"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"hasNextPage\": false,\n \"nextPageUrl\": null,\n \"offset\": 0,\n \"limit\": 1000,\n \"items\": [\n {\n \"id\": \"1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"href\": \"https://platform.otqa.com/sync/v2/guests/1234567-876a3e1f-5c76-4cf2-b238-b09e44816c92\",\n \"rid\": 1234567,\n \"sequence_id\": 1,\n \"gpid\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"email_optin\": true,\n \"phone\": \"2125555555\",\n \"phone_type\": \"Mobile\",\n \"tags\": null,\n \"birth_date\": null,\n \"anniversary_date\": null,\n \"updated_at\": \"2024-12-20T08:09:19\",\n \"forgotten\": false,\n \"archived\": false,\n \"primary_guest\": null,\n \"address\": null,\n \"mail_opted_in\": false,\n \"company_name\": null,\n \"phone_numbers\": [\n {\n \"label\": \"Mobile\",\n \"number\": \"2125555555\",\n \"country_code\": \"1\",\n \"primary\": true\n }\n ],\n \"created_date\": \"2024-12-20T08:09:19\",\n \"updated_at_utc\": \"2024-12-20T16:09:19Z\",\n \"marketing_opted_out\": false,\n \"notes\": null,\n \"notes_special_relationship\": null,\n \"notes_food_and_drink\": null,\n \"notes_seating\": null,\n \"created_date_utc\": \"2024-12-20T16:09:19Z\",\n \"date_last_visit\": \"2024-12-20T05:00:00\",\n \"date_first_visit\": \"2024-12-20T05:00:00\",\n \"date_last_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"date_first_visit_utc\": \"2024-12-20T13:00:00Z\",\n \"is_hidden\": false\n }\n ]\n}"},{"id":"76a1a587-3ca9-475b-877d-3ce10f81c87a","name":"401","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"bearer [Access Token]"},{"key":"Cache-Control","value":"no-cache"}],"url":{"raw":"{{base-url}}/sync/v2/guests?email_optin={{trueorfalse}}&updated_after={{updated-after}}&limit={{limit}}&offset={{offset}}&rid={{rid}}","host":["{{base-url}}"],"path":["sync","v2","guests"],"query":[{"key":"email_optin","value":"{{trueorfalse}}"},{"key":"updated_after","value":"{{updated-after}}"},{"key":"limit","value":"{{limit}}"},{"key":"offset","value":"{{offset}}"},{"key":"rid","value":"{{rid}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"bbf348f6-37e0-45ed-9f83-b2cc6fd35877"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"0D307298-8AEA-4099-A0B5-B92E3E50C86B"},{"key":"OT-SessionID","value":"97913951-9eea-4707-96a2-b96e17b6fe68"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"128"},{"key":"Date","value":"Tue, 15 Oct 2024 04:49:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2024-10-15T04:49:44.787+0000\",\n \"path\": \"/sync/v2/guests\",\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"requestId\": \"3b6f9d3f\"\n}"}],"_postman_id":"710d89e5-ca7b-435e-a7b7-9741554fc6fc"}],"id":"bfa1655f-bdfa-4056-b527-fd233d95d40e","description":"As a restauranteur I would like to consume all email addresses that I have stored, that have also been opted in to receive marketing emails.
\nAPIs to use:
\nSync API - Guests
\nStep 1:
\n- \n
Perform initial GET query with historical information.
\n \nAdd the
\nemail_optin=trueparameter. \n
Step 2:
\n- \n
Store the data in your systems. We recommend you store:
\n \n
\nfirst_name\n
\nlast_name\n
\nemail\n
\nemail_optin\n
\nupdated_at\n
Step 3:
\n- \n
- To keep your data up to date, we recommend using the
updated_afterparameter and simply storing any new or updated details. This includes new guests as well as updates to existing guests (i.e. possible opt-outs) \n
Overview
\nThe Reservation Webhook API provides real-time updates about changes in reservation status via webhooks. These updates enable restaurants to seamlessly integrate reservation management into their systems. The webhooks send a detailed JSON payload containing reservation attributes whenever a reservation status changes.
\nTo access Guest Data, please use the guest attribute to call the guest endpoint in Sync API. For more information about Sync API and other available data points via the GET query, please refer to the Sync API tier section of this Portal.
Change Log
\n**** The v3 version of the webhook, released in February 2025 ****
\nData Delivery Method
\nWebhook Implementation
\nWebhooks are triggered on any change in reservation status. A POST request is sent to the specified endpoint with the payload data.
\nConfiguring Your Endpoint
\n- \n
Endpoint URL: Provide an URL where webhook data will be delivered.
\n- \n
- Webhook URL must use https and port 443 \n
\nAuthentication: Basic or bearer token is required to verify authenticity of request
\n \nEvent Handling: Ensure your system handles retries in case of delivery failures.
\n \n
Retry Logic
\nWebhook delivery uses an exponential backoff strategy. After three failed attempts, the webhook is marked as undeliverable.
\nAttributes
\nThe webhook payload will not include the same attributes as available in the GET query. To get the additional attributes not delivered in the webhook, Sync API reservataions endpoint will need to be called. Please see the Sync API Copper Reservations API v2 documention for full list of additional attributes.
\nOpenTable reserves the right to update the data sent via the webhook with additional attributes. POS partner should build their ingestion of the webhook to accept any new additional attributes in the future. Partner can choose to process or ignore the additional attributes.
\nThe webhook payload includes the following attributes:
\n","urlObject":{"protocol":"https","host":["partner","supplied","webhook","url"],"query":[],"variable":[]}},"response":[{"id":"d937012e-5b57-4ab6-9a34-9a908167ecde","name":"200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [token]","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"sequence_id\": 101112,\r\n \"guest_id\": \"guest-123\",\r\n \"confirmation_id\": 34567,\r\n \"state\": \"Confirmed\",\r\n \"table_number\": [\r\n \"10\"\r\n ],\r\n \"scheduled_time\": \"2024-12-19T19:00:00\",\r\n \"party_size\": 4,\r\n \"server\": \"John Doe\",\r\n \"updated_at_utc\": \"2024-12-19T16:00:00Z\",\r\n \"id\": \"12345\",\r\n \"href\": \"https://api.opentable.com/reservations/12345\",\r\n \"rid\": 6789,\r\n \"guest\": \"https://api.opentable.com/guests/guest-123\",\r\n \"created_date\": \"2024-12-19T10:15:30\",\r\n \"visit_tags\": [\r\n \"birthday\", \r\n \"window seating\"\r\n ],\r\n \"seated_time\": null,\r\n \"done_time\": null,\r\n \"scheduled_time_utc\": \"2024-12-19T23:00:00\",\r\n \"guest_request\": \"Vegetarian meal\",\r\n \"venue_notes\": \"VIP customer\",\r\n \"opentable_notes\": \"10% discount applied\",\r\n \"table_category\": \"hightop\",\r\n \"seated_time_utc\": null,\r\n \"done_time_utc\": null,\r\n \"created_date_utc\": \"2024-12-19T15:15:30Z\",\r\n \"updated_at\": \"2024-12-19T11:00:00\",\r\n \"origin\": \"Web\",\r\n \"arrived_time\": null,\r\n \"arrived_time_utc\": null,\r\n \"deposit_details\": {\r\n\t\"totalPaid\": null,\r\n\t\"totalRefunded\": null,\r\n\t\"currency\": null,\r\n\t\"currencyDenominator\": 100,\r\n\t\"status\": null\r\n },\r\n \"referrer\": {\r\n \"company\": \"Concierge Company ABC\",\r\n \"id\": \"19999999940618\",\r\n \"first_name\": \"Connie\",\r\n \"last_name\": \"Concierge\",\r\n \"email\": \"cconcierge@conciergeabc.com\",\r\n \"phone\": \"8335551212\"\r\n },\r\n \"added_to_waitlist\": null,\r\n \"added_to_waitlist_utc\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner.supplied.webhook.url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"OT-RequestId","value":"8cc11712-7674-4a96-9bfc-f751060671f0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"OT-AnonymousId","value":"169A957C-FA57-49D7-A584-29457632A314"},{"key":"OT-SessionID","value":"5f9f6a89-304b-4154-8099-6af169716afb"},{"key":"Content-Type","value":"application/json"},{"key":"X-OT-Backend","value":"posRestaurantService"},{"key":"X-OT-UriTemplate","value":"/posRestaurantService/api/v1/pos/restaurants/all"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Fri, 21 Feb 2025 02:14:56 GMT"},{"key":"Content-Length","value":"217"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"ak_bmsc=3463BA8A2F5F898E431053FB11A4FC81~000000000000000000000000000000~YAAQrMgwFzVFvxSVAQAAeVpJJhqT4Q+RrwCMj6eV9YZ73di5fgE47UgzVvn5/Dj7JmO3MdDssZ1Es52ACr6QuguhqG9rakimmHM4CGWMuhrug8m41vdiT8Nq+EgNkb0MsSNgtEF57YplW/pGm3fvP5brV8anMVe8cU9+26gYbmv+IIxIU+ns2n4atOARAabg3Q6/39lJv0u68WbhTutL8R6hgbZRbfpkLCyonbQZL6+sA7bHj+2W61KirChF5M/IUM1uo+QcQsbiEWW1ybajDV3K+CBz9QK24YU8TpCruubKI2PPPtmUplAZsN23rw5WnSpMp5Y04qtml8MojOeOpNK2gcxxiN/FzVAbyvQ=; Domain=.opentable.com; Path=/; Expires=Fri, 21 Feb 2025 04:14:56 GMT; Max-Age=7200"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"de29d311-c00e-4da2-abba-fc3ca8621e9e"}],"id":"8eeaead5-573e-4e26-b02c-ffc15a451598","description":"Webhook Flow
\nAs a restauranteur I would like to receive new reservations into my systems as they are made in real time.
\nAPIs to use:
\nSync API - Reservation Webhook
\nStep 1:
\n- \n
Provide OpenTable your https webhook URL that is accessible on port 443 for delivery
\n \nProvide OpenTable basic or bearer token for authentication
\n \n
Step 2:
\n- \n
Store the data in your systems. We recommend you store:
\n \n
\nscheduled_time\n
\nparty_size\n
\nguest_id\n
\nguest\n
\nupdated_at\n
OpenTable's reservation webhooks are event-driven, meaning they are triggered automatically whenever a reservation is created or updated. Upon these events, OpenTable will send a webhook containing the latest reservation details.
\nPlease note that the attributes included in the webhook payload may differ from those available via the GET reservation endpoint. If additional details are needed, you can make a follow-up GET request using the provided reservation ID.
\nTo align with your system requirements, you can choose to selectively process or ignore specific webhook event types.
\n","_postman_id":"8eeaead5-573e-4e26-b02c-ffc15a451598"}],"id":"3077d592-f491-468d-a62b-f858e4d54677","description":"Here are some ways our partners use Sync API. These are applicable to both Gold and Platinum tiers.
\n","_postman_id":"3077d592-f491-468d-a62b-f858e4d54677"}],"id":"5d2e3a06-fca9-4d01-a17b-e0aa57e4bdf5","description":"Overview
\nSync API empowers OpenTable restaurants and groups with direct access to raw, real-time guest and reservation data, enabling seamless integration with custom systems and tools. Designed as the API equivalent of exporting data from the OpenTable restaurant system, the Sync API provides the flexibility and precision needed for bespoke data-driven solutions. By delivering unprocessed data at the restaurant (RID) level, Sync API ensures a clear and unaltered view of operational insights without the complexities of group-level associations or pre-configured reporting frameworks.
\nWhether your goal is to enhance internal reporting, power personalized email marketing, or integrate data into loyalty, CRM, PMS, or forecasting systems, Sync API is the foundation for building tailored applications. While it doesn’t offer the calculated metrics of OpenTable’s native reporting features, it delivers the raw data necessary to create fully customized reporting and operational workflows. With its focus on real-time data availability, Sync API is an essential tool for restaurants aiming to leverage their data for actionable insights and optimized performance.
\n","_postman_id":"5d2e3a06-fca9-4d01-a17b-e0aa57e4bdf5"},{"name":"Profile Content API","item":[{"name":"APIs","item":[{"name":"Post Content","id":"7e72024b-d17a-4767-9e8c-2c025bd94532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"ABC123\",\n \"name\": \"Casa de Mara\",\n \"primaryCuisine\": \"Spanish\",\n \"phone\": \"+13211231234\",\n \"currency\": \"USD\",\n \"locale\": \"en-US\",\n \"website\": \"http://www.casademara.com\",\n \"timeZone\": \"Eastern\",\n \"priceBandId\": 2,\n \"description\": \"Casa de Mara is a charming Spanish restaurant that brings the flavors of the Mediterranean to your table. With fresh seafood, authentic tapas, and rich, traditional paellas, every dish is crafted with passion and the finest ingredients. Enjoy a warm, inviting atmosphere where the spirit of Spain comes alive in every bite.\",\n \"diningStyle\": \"Fine Dining\",\n \"dressCode\": \"Smart Casual\",\n \"privateEventDetails\": \"300 seat event space available\",\n \"cateringDetails\": \"Offsite catering available\",\n \"executiveChef\": \"Chef Luis Torres\",\n \"crossStreet\": \"Puerto Rico Ave\",\n \"location\": {\n \"address\": {\n \"city\": \"San Francisco\",\n \"street\": \"120 Kearny St Apt 1518042369\",\n \"country\": \"USA\",\n \"province\": \"CA\"\n },\n \"coordinates\": {\n \"latitude\": \"37.6915030\",\n \"longitude\": \"-122.4582610\"\n },\n \"neighborhoodName\": \"Kearny St\"\n },\n \"profileImage\": {\n \"url\": \"https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.instagram.com%2Fdarrenandphillip%2Fp%2FCz9gGWVMr2R%2F&psig=AOvVaw0ShB3y1_zXGdBKJtvVJ-rY&ust=1742057047733000&source=images&cd=vfe&opi=89978449&ved=0CBQQjRxqFwoTCODtwLKCiowDFQAAAAAdAAAAABAE\"\n },\n \"images\": [],\n \"tags\": [\n \"Cocktails\",\n \"Fireplace\"\n ],\n \"openingTimes\": {\n \"standardOpeningTimes\": {\n \"FRIDAY\": [\n {\n \"end\": \"19:00\",\n \"start\": \"07:00\"\n }\n ],\n \"MONDAY\": [\n {\n \"end\": \"19:00\",\n \"start\": \"07:00\"\n }\n ],\n \"TUESDAY\": [\n {\n \"end\": \"19:00\",\n \"start\": \"07:00\"\n }\n ],\n \"SATURDAY\": [\n {\n \"end\": \"13:00\",\n \"start\": \"07:00\"\n }\n ],\n \"THURSDAY\": [\n {\n \"end\": \"19:00\",\n \"start\": \"07:00\"\n }\n ],\n \"WEDNESDAY\": [\n {\n \"end\": \"19:00\",\n \"start\": \"07:00\"\n }\n ]\n }\n },\n \"paymentOptions\": [\n \"AMEX\",\n \"Visa\",\n \"MasterCard\"\n ],\n \"beverages\": [\n \"Cocktails\",\n \"Wine\",\n \"Full Bar\"\n ],\n \"dietaryOptions\": [\n \"Gluten-free Options\"\n ],\n \"smokingOptions\": [\n \"Non-Smoking\"\n ], \n \"safetyPrecautions\": [\n \"StaffIsVaccinated\",\n \"ProhibitSickStaff\"\n ],\n \"diversitySpotlightTags\": [\n \"LGBTQ\",\n \"Persons with Disabilities\"\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v2/partnerrestaurants/rid/{{rid}}","description":"Updating Profile Content
\nOverview
\nThis documentation outlines the process for using the POST API to update Profile content
\nEndpoint
\nURL: {{base-endpoint}}/v2/partnerrestaurants/rid/{{RID}}
\nMethod: POST
\nPath Parameters:
\n- \n
rid (restaurant id):
\n- \n
- This is a static value per restaurant, and will be made available to you by OpenTable. Each restaurant will have its own unique, static value. Required \n
\n
Notes:
\n- \n
Should you not have any data on one of the optional fields, please do not include it
\n \nIf you would like to remove any existing data and leave the field empty, it will append the attribute and delete whatever detail is inside.
\n \nTo modify an existing restaurant, the same endpoint for is used. Partners must supply all required information to successfully modify a restaurant in the OpenTable environment.
\n \n
Request Body
\nCuisines:
\nThis is a list of all the available cuisines you can use for Restaurants.
\n- \n
Afghan
\n \nAfternoon Tea
\n \nAlgerian
\n \nAmerican
\n \nAndean
\n \nArgentinean
\n \nAsian
\n \nAustralian
\n \nAustrian
\n \nBar / Lounge / Bottle Service
\n \nBarbecue
\n \nBasque
\n \nBalkan Style
\n \nBeer Garden
\n \nBistro
\n \nBottle Service
\n \nBrazilian
\n \nBrazilian Steakhouse
\n \nBritish
\n \nBrewery
\n \nBritish / American
\n \nBulgarian
\n \nCajun
\n \nCambodian
\n \nCatalan
\n \nCentral Asian
\n \nChinese
\n \nChinese (Beijing)
\n \nChinese (Canton)
\n \nChinese (Shanghai)
\n \nChinese (Sichuan)
\n \nChinese (Taiwan)
\n \nContemporary American
\n \nContemporary Asian
\n \nContemporary British
\n \nContemporary Canadian
\n \nContemporary European
\n \nContemporary French
\n \nContemporary French / American
\n \nContemporary German
\n \nContemporary Italian
\n \nContemporary Japanese
\n \nContemporary Korean
\n \nContemporary Latin
\n \nContemporary Mexican
\n \nContemporary Southern
\n \nContemporary Spanish
\n \nContemporary Swedish
\n \nContemporary Vegan
\n \nContinental
\n \nCreole
\n \nCreole / Cajun / Southern
\n \nCreative Japanese
\n \nCreative Western
\n \nCuban
\n \nCzech
\n \nDanish
\n \nDeli
\n \nDessert
\n \nDim Sum
\n \nDistillery
\n \nDutch
\n \nEast Asian
\n \nEastern European
\n \nEcuadorian
\n \nEritrean
\n \nEthiopian
\n \nEuropean
\n \nFarm-to-table
\n \nFilipino
\n \nFine cuts
\n \nFrench
\n \nFrench / American
\n \nFrench / Canadian
\n \nFrench / Indian
\n \nFrench / Japanese
\n \nFusion / Eclectic
\n \nGeorgian
\n \nGerman
\n \nGlobal, International
\n \nGreek
\n \nGrill
\n \nHawaiian
\n \nHalal
\n \nHibachi
\n \nHome Cooking
\n \nHungarian
\n \nIcelandic
\n \nIndian
\n \nIndonesian / Malaysian
\n \nInternational
\n \nIrish
\n \nIsraeli
\n \nItalian
\n \nIzakaya
\n \nJapanese
\n \nJapanese Speciality
\n \nJugoslavian
\n \nKappou
\n \nKaiseki
\n \nKosher
\n \nKorean
\n \nLaotian
\n \nLatin / Spanish
\n \nLebanese
\n \nLow Country
\n \nLounge
\n \nMediterranean
\n \nMexican
\n \nMexican / Southwestern
\n \nMexican (Baja Med)
\n \nMiddle Eastern
\n \nModern Australian
\n \nModern European
\n \nModern Tuscan
\n \nMoroccan
\n \nNative American
\n \nNepali
\n \nNew Zealand
\n \nNorthwest
\n \nNorthwest British
\n \nNorthwest Germany
\n \nOkonomiyaki
\n \nOkinawan
\n \nOrganic
\n \nOttoman
\n \nPacific Rim
\n \nPakistani
\n \nPan-Asian
\n \nPanamanian
\n \nPalestinian
\n \nPeruvian
\n \nPersian
\n \nPizzeria
\n \nPolish
\n \nPrime Rib
\n \nPuerto Rican
\n \nPub
\n \nQuality Dining
\n \nQuebec
\n \nRegional French
\n \nRegional Italian (Sardinia)
\n \nRegional Japanese
\n \nRegional Mexican
\n \nRegional Mexican (Baja Med)
\n \nRegional Spanish
\n \nRegional German (Berlin)
\n \nRussian
\n \nRamen
\n \nSalads
\n \nScandinavian
\n \nSeafood
\n \nSerbian
\n \nSicilian
\n \nSoul Food
\n \nSouthern
\n \nSouthern British
\n \nSouthern German
\n \nSouthern Spain
\n \nSpanish
\n \nSpeakeasy
\n \nSteak
\n \nSteakhouse
\n \nSushi
\n \nSwiss
\n \nTapas / Small Plates
\n \nTempura
\n \nTeppanyaki
\n \nTex-Mex
\n \nTraditional French
\n \nTraditional Mexican
\n \nTurkish
\n \nUnspecified
\n \nUruguayan
\n \nVegan
\n \nVegetarian
\n \nVietnamese
\n \nWine Bar
\n \nWinery
\n \nYakitori
\n \nYakiniku
\n \nYoshoku
\n \nYum Cha
\n \n
Overview
\nThe Profile Content API allows certified partners to post profile content for specific restaurants on OpenTable. The Profile Content API is a tool provided by OpenTable that enables certified partners to manage and update profile content for specific restaurants listed on the platform. This API allows partners to directly post and maintain accurate and up-to-date information, ensuring that diners have access to the most relevant details when searching for and selecting restaurants on OpenTable.
\nBy utilizing the Profile Content API, certified partners can enhance the overall user experience for OpenTable diners, while also helping restaurants maintain a strong and engaging online presence.
\nHow will this impact restaurants?
\nThis API allows partners to update OpenTable restaurant profile details from outside the OpenTable for Restaurants product.
\nNote, restaurants will not be able to see when the last content update was pushed via the API.
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdl-XwufLDGdI9pcOyCtVfLw1pNXeeyPlTnF9cOjTb0m7U_Tcsh7wfirYEeJnzlNPVziugi4rjNDULBukM2au_XiSadldVzGu8-h3BEr5F6xncRJI61LF0DT0Do7WUJHw2GsPyDG-CimGw1otogtm8LPQ?key=-rVBup94TDIdvnuS5qlBaQ\")
![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXdw_4powKwVIPPBlvYCET_iVppEEAbO164oGUpvVLaE6azVo-_tGtCyaz85dBZ2btC7rT-MXgdNR-tPZ16Mksof0k3l8K2gfSe2fWVFuouLzn5XJmZQ5OsqalCmh2JF8GbBnMFwXmv-s_SD4_y2CJXDTi8?key=-rVBup94TDIdvnuS5qlBaQ\")
\n\nChange Log
\nThis API was developed and launched in August 2024
\n","_postman_id":"e14c1573-a9f6-4b60-878a-21649cc31b1a"},{"name":"API Reference","item":[{"name":"Change Log","item":[{"name":"Online Booking API - Changes to Credit Card processing","item":[],"id":"ac23da24-ec4f-45dd-9df5-27f652cd521b","_postman_id":"ac23da24-ec4f-45dd-9df5-27f652cd521b","description":""},{"name":"Online Booking API v2 now supports Spreedly as a payment processor","item":[],"id":"cbe244b4-98d8-43f3-9d1c-67c812abe135","description":"Online Booking API v2 now supports Spreedly as a payment processor
\nIf you are integrating with a restaurant that does not use Stripe as its credit card provider, you must use Spreedly. Continuing to send Stripe payment details for a non-Stripe restaurant will result in a Make Reservation request failure.
\nDetails of the change are below:
\nSpreedly payment support is available exclusively in Booking API Version 2. This enhancement introduces secure tokenization through Spreedly’s payment gateway, affecting the Slot Lock, Make/Change, and Payment Profile endpoints.
\nAffected Endpoints
\nSlot Lock API
\nOverview
\nThe Slot Lock response has been extended to include a payment_method object whenever a booking requires Spreedly tokenization.
\nResponse Schema
\nObject: payment_method
\nObject: tokenizerAuthData
\nSample Response:
\n{\n \"expires_at\": \"2025-10-30T19:45:42\",\n \"reservation_token\": \"eyJhbGciOiJIUzUxMiJ9...\",\n \"privileged_access\": [],\n \"access_rule\": null,\n \"payment_method\": {\n \"paymentProviderType\": \"SPREEDLY\",\n \"tokenizerAuthData\": {\n \"nonce\": \"77b5d02b-a584-4fd6-ae12-e4af17622799\",\n \"timestamp\": 1761853243,\n \"certificateToken\": \"41NRFK9S8B900VZW8KWFZPKFC5\",\n \"signature\": \"C5/RgDHBWv0CTvhwV+LBSW0j+XEM9I+6nidfqRw60td5vP5...\"\n }\n }\n}\n\nNotes
\nThe payment_method object holds the necessary details for loading the Spreedly iframe, which allows for the tokenization of credit card information. For more information on Spreedly integration, please refer to https://developer.spreedly.com/docs/iframe-payment-form .
\nCard tokenization can be achieved by directly calling the Spreedly payment_methods.json API, eliminating the need for a Spreedly iframe. Further details are available at https://core.spreedly.com/v1/payment_methods.json .
\nPartners will require their own Spreedly account to access these pages.
\nMake & Change Booking API
\nOverview
\nThe credit_card substructure has been updated with new Spreedly-specific fields for 3-D Secure (3DS) and tokenized payments.
\nUpdated Request Schema within the credit_card object
\nObject: mpiData
\nSample Request:
\n{\n \"paymentProviderType\": \"SPREEDLY\",\n \"redirectUrl\": \"https://example.com/redirect\",\n \"mpiData\": {\n \"threeDSVersion\": \"2.1.0\",\n \"eci\": \"05\",\n \"cavv\": \"JSJbzXT6TRQlvZDX+ZdOG4QriE=\",\n \"dsTransId\": \"aaa65c7b-b0fc-4e71-bd6c-29c87acad489\"\n },\n \"token\": \"tok_1234567890\",\n \"last4\": \"4242\",\n \"paymentMethod\": \"card\",\n \"setupIntent\": \"seti_abcdef\",\n \"paymentIntent\": \"pi_abcdef\"\n}\n\nNotes:
\n- \n
The redirectUrl and mpiData objects appear only in 3DS-authenticated transactions.
\n \nNon-3DS transactions can omit these fields.
\n \nPartners are responsible for handling redirect flows post-3DS challenge.
\n \n
Payment Profile API
\nOverview
\nNew Endpoint. Introduced to allow partners to retrieve Spreedly tokenizer credentials during reservation changes. These credentials are typically only issued during the slot lock flow.
\nEndpoint Details
\nResponse Schema
\nObject: tokenizerConfig.Spreedly
\nNotes:
\n- \n
Use this endpoint during change flows to fetch fresh Spreedly credentials.
\n \nThe values should be used to re-initialize the tokenization iframe or direct API call.
\n \nAll values (nonce, timestamp, certificateToken, signature) are required to authenticate with Spreedly.
\n \n
Sample Response:
\n{\n \"tokenizerConfig\": {\n \"Spreedly\": {\n \"timestamp\": 1761865972,\n \"nonce\": \"a20b195b-c9fc-48df-a945-4aaac69e95f3\",\n \"certificateToken\": \"41NRFK9S8B900VZW8KWFZPKFC5\",\n \"signature\": \"G4PPQnQhJcVmbjocimDMNAeSg3TzkHwp7v2Ne0g6hr6+x/gp...\"\n }\n }\n}\n\nError Handling
\nVersioning & Compatibility
\n- \n
Applies to: Booking API V2 only
\n \nLegacy (V1) does not support Spreedly integration
\n \nBackward compatibility maintained for non-Spreedly bookings
\n \n
References
\nhttps://developer.spreedly.com/docs/iframe-payment-form
\nhttps://core.spreedly.com/v1/payment_methods.json
\n","_postman_id":"cbe244b4-98d8-43f3-9d1c-67c812abe135"}],"id":"4b3fe755-f25e-4b57-88b2-53dba93e72d2","description":"