Introduction to waitlists

Partners participating in the waitlist program must complete the account Setup before they begin. However, some steps in the general guide aren't necessary for use of the waitlist feature. The guidelines on this page explain what steps apply to partners interested in using the waitlist feature on Reserve with Google. We suggest that you read through this overview before going through the integration steps.

Launch process

Figure 1 outlines the process to launch your waitlist-enabled merchants on Reserve with Google.

Figure 1: High-level integration steps

Overall, the major data flows between you (the Partner) and Google are captured in Figure 2:

Figure 2: Integration data flow diagram

Guidelines for all waitlist partners

Keep the following in mind as you implement the waitlist feature:

  • The service for every waitlist merchant must have waitlist_rules populated.

  • Waitlist-only merchants do not need to provide availability feeds to Reserve with Google.

  • Your booking server must implement all the waitlist-specific steps listed in Implement the booking server. Partners that support both reservations and waitlists can add on the new methods to their existing booking server.

  • Reserve with Google runs a set of test cases for the waitlist methods in the booking server.

  • Reserve with Google is actively developing the API testing tools and sandbox frontend for waitlist merchants. The API testing tools, sandbox, and skeleton servers mentioned in the guide do not yet cover merchants that are using the waitlist feature.

Guidelines for waitlist-only partners

Keep the following in mind if the booking server is used only for waitlists:

  • Waitlist-only partners don't provide availability feeds to Reserve with Google.

  • Waitlist-only partners do not implement the reservation methods in their booking server. Instead, you Implement the booking server with the instructions for the Waitlist implementation.

  • Waitlist-only partners do not make API calls to Google. This means that waitlist-only partners do not need to set up a cloud project or provide a developer email address. You do not need to complete Real-time API updates. However, merchant and service feeds still need to be provided to Reserve with Google.

Waitlist test cases

Google tests the following use cases to ensure the functionality of the waitlist methods in your booking server implementation. Google also tests and monitors latency. All of these tests must pass prior to launch.

WaitEstimate retrieval

  • Wait estimates are returned for each party size requested in a BatchGetWaitEstimatesRequest.

Waitlist entry creation

  • A waitlist entry can be created from a CreateWaitlistEntry request.
  • If waitlist entry creation fails, a business logic error shows up in the response.
  • If a CreateWaitlistEntry attempt succeeds, the same response is returned when the same CreateWaitlistEntry is received again.
  • If a CreateWaitlistEntry attempt fails, the server retries when the same CreateWaitlistEntry is received again.
  • Waitlist entries show up in the merchant's interface.
  • Calls to GetWaitlistEntry successfully return the created waitlist entry.

Waitlist entry deletion

  • Existing waitlist entries can be deleted.

Sample waitlist service feed (JSON)

Waitlist service feed