Esta página documenta os valores enumerados (ENUMs) utilizados na API do Belasis
Status do Agendamento
A API utiliza os seguintes status para identificar a situação de um agendamento:
| Valor | Descrição |
|---|---|
confirmed | Confirmado |
unconfirmed | Não confirmado |
disconfirm | Cancelado |
waiting | Aguardando |
Descrição dos Status
confirmed - Confirmado
confirmed - ConfirmadoIndica que o agendamento foi confirmado pelo cliente ou pelo estabelecimento. Este é o status ideal para agendamentos que estão confirmados e o cliente comparecerá.
Quando usar:
- Cliente confirmou presença por telefone, WhatsApp ou outro canal
- Estabelecimento confirmou o agendamento manualmente
- Cliente confirmou através do aplicativo móvel
unconfirmed - Não confirmado
unconfirmed - Não confirmadoIndica que o agendamento foi criado mas ainda não foi confirmado pelo cliente. Este é o status padrão quando um agendamento é criado e aguarda confirmação.
Quando usar:
- Agendamento recém-criado aguardando confirmação
- Cliente ainda não respondeu à solicitação de confirmação
- Aguardando retorno do cliente
disconfirm - Cancelado
disconfirm - CanceladoIndica que o agendamento foi cancelado pelo cliente ou pelo estabelecimento. Agendamentos cancelados não devem ser considerados na agenda.
Quando usar:
- Cliente cancelou o agendamento
- Estabelecimento cancelou por algum motivo
- Cliente não compareceu (no-show)
- Remarcação de horário (cancela o antigo e cria novo)
waiting - Aguardando
waiting - AguardandoIndica que o agendamento está em situação de espera. Assim que um agendamento é alterado para o status de "Aguardando", todos os profissionais daquele agendamento é notificado.
Quando usar:
- Cliente chegou no espaço e está aguardando para ser atendido
- Quando precisa notificar os profissionais que o cliente chegou e está aguardando
Importante
- O campo
statusaceita apenas os valores listados acima- Valores em maiúsculas ou com espaços serão rejeitados
- O status deve ser enviado exatamente como especificado (letras minúsculas)
