BatchGetWaitEstimates method

  • BatchGetWaitEstimates retrieves wait estimates for a specified merchant, service, and party sizes, informing users about the waitlist status and estimated wait times.

  • The request requires merchant_id, service_id, and a list of party_size values to obtain wait estimates for different group sizes.

  • BatchGetWaitEstimatesResponse includes the current waitlist_status (OPEN, CLOSED_NO_WAIT, or CLOSED_OTHER) and a list of wait_estimate objects.

  • Each wait_estimate object contains the party_size and wait_length, which can indicate either no wait or the number of parties ahead in line.

  • The response may only include wait estimates for available party sizes, omitting unavailable options to offer users alternative choices.

Get the WaitEstimates for a requested merchant, service and party size. The partner backend verifies that the requested wait estimates are available and provides the waitlist status along with the waits in the response.

Request

BatchGetWaitEstimatesRequest

Return value

BatchGetWaitEstimatesResponse

// Batch request for the wait estimates for the specified merchant, service and
// party sizes.
message BatchGetWaitEstimatesRequest {
  // Required. Partner-provided ID for the merchant.
  string merchant_id = 1;

  // Required. Partner-provided ID for the service.
  string service_id = 2;

  // Required. The different party sizes WaitEstimates are requested for.
  // WaitEstimates may differ with the number of people in the party. A single
  // request will not include duplicate party sizes.
  repeated int32 party_size = 3;
}

// Response for the BatchGetWaitEstimates RPC with the wait estimates of the
// specified merchant, service and party sizes.
message BatchGetWaitEstimatesResponse {
  // Required. A status for the waitlist that indicates whether new users can
  // join and what the reason is if they can’t join. If the waitlist is not
  // open, all other fields in the BatchGetWaitEstimatesResponse are expected to
  // be unset.
  WaitlistStatus waitlist_status = 1;

  // The wait estimates for each party size requested. The response should
  // contain exactly one wait estimate for each party size sent in the request.
  // If a party size is not available for some reason, prefer ommitting it
  // instead of returning an error so that the user will have some options to
  // choose from.
  repeated WaitEstimate wait_estimate = 2;
}

// A status for the waitlist that determines if new users can join and what
// the reason is if they can’t join.
enum WaitlistStatus {
  WAITLIST_STATUS_UNSPECIFIED = 0;

  // The waitlist is open and is accepting new users.
  OPEN = 1;

  // There is currently no wait and users should arrive at the merchant
  // without joining the waitlist.
  CLOSED_NO_WAIT = 2;

  // The waitlist is not currently accepting new users because it is full
  // or closed for other reasons.
  CLOSED_OTHER = 3;
}

BatchGetWaitEstimates samples

This example illustrates a case where a restaurant usually allows party_size values from 2 to 10 but at the time of the request, party_size values higher than 7 can no longer be accomodated (close to closing time, for example) and party_size of 2 has actually no wait.

Get wait request

{
  "merchant_id": "dining-1",
  "party_size": [2, 3, 4, 5, 6, 7, 8, 9, 10],
  "service_id": "reservation"
}

Get wait response

{
  "waitlist_status": "OPEN",
  "wait_estimate": [
    { "party_size": 2, "wait_length": {} },
    { "party_size": 3, "wait_length": { "parties_ahead_count": 3 } },
    { "party_size": 4, "wait_length": { "parties_ahead_count": 3 } },
    { "party_size": 5, "wait_length": { "parties_ahead_count": 3 } },
    { "party_size": 6, "wait_length": { "parties_ahead_count": 3 } },
    { "party_size": 7, "wait_length": { "parties_ahead_count": 3 } }
  ]
}