Método CreateWaitlistEntry

O cliente pede para criar uma entrada da lista de espera. O back-end do parceiro faz uma entrada na lista de espera para o comerciante, serviço, tamanho do grupo e usuário solicitados. Em caso de sucesso, o parceiro precisa retornar o ID da entrada da lista de espera ou um erro de lógica de negócios (por exemplo, se o tamanho do grupo estiver acima do máximo permitido ou se a lista de espera estiver cheia etc.) em caso de falha. Um erro inesperado deve ser retornado com códigos de status HTTP padrão.

Solicitação

CreateWaitlistEntryRequest

Valor de retorno

CreateWaitlistEntryResponse

// Request for a user to join the waitlist.
//
// Reserve with Google may retry REST HTTP requests if no response is
// received. If the exact same CreateWaitlistEntry is received a second time,
// then the same CreateWaitlistResponse must be returned. A second waitlist
// entry must not be created.
message CreateWaitlistEntryRequest {
  // Required. Partner-provided ID for the merchant.
  string merchant_id = 1;

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

  // Required. The party size requested for the waitlist entry.
  int32 party_size = 3;

  // Required. Personal information of the user joining the waitlist.
  UserInformation user_information = 4;

  // A string from the user which contains any special requests or additional
  // information that they would like to notify the merchant about.
  // This will be populated when the user submits an additional request to
  // Reserve with Google. The partner can disable this functionality at the
  // service level by setting supports_additional_request to false in the
  // service feed.
  string additional_request = 5;

  // Required. Used to differentiate retries from separate requests. If the
  // exact same CreateWaitlistEntry is received a second time, (including
  // idempotency_token) then the same CreateWaitlistResponse must be returned.
  string idempotency_token = 6;
}

// Response for the CreateWaitlistEntry RPC with the waitlist entry ID or any
// failing business logic information.
message CreateWaitlistEntryResponse {
  // Unique partner-provided ID for the newly created entry in the waitlist.
  // Required if the waitlist entry was created successfully. Unique for all
  // time.
  string waitlist_entry_id = 1;

  WaitlistBusinessLogicFailure waitlist_business_logic_failure = 2;
}

Exemplos de CreateWatchlistEntry

Criar pedido

{
  "idempotency_token": "14620365692592881354",
  "merchant_id": "dining-1",
  "party_size": 3,
  "service_id": "reservation",
  "user_information": {
    "family_name": "John",
    "given_name": "Smith",
    "telephone": "[phone]",
    "user_id": "123456789"
  }
}

Criar resposta

{ "waitlist_entry_id": "MYS-1668739060" }