Polling de pedidos
Retorna os pedidos do estabelecimento modificados nas últimas 8 horas.
Para esse endpoint, é recomendado realizar um polling a cada 30 segundos. No entanto, sugerimos preferencialmente a integração por meio de Webhooks em vez de Polling.
Para otimizar o fluxo de integração, recomenda-se registrar o horário da última requisição e, ao realizar a requisição subsequente, enviar essa informação no parâmetro “updated_since”. Dessa forma, somente as alterações ocorridas desde a última consulta serão retornadas. Além disso, também pode ser aplicado um filtro por status do pedido.
Levando em consideração possíveis pequenas discrepâncias de tempo entre o nosso servidor e o seu, pode ser útil adicionar um pequeno atraso ao parâmetro “updated_since”.
Existem outros motivos de modificação dos pedidos além da mudança de status. No entanto, atualmente, não temos um controle mais completo de todos os possíveis motivos. Para acompanhar além da simples mudança de status, seria necessário comparar os JSON do pedido antes e depois, a fim de mapear o que foi alterado no pedido.
Pedidos de mesas e comandas só ficam disponíveis nesse endpoint após serem cancelados ou finalizados.
Pedido recebidos através de integrações como o iFood também são retornados nesse endpoint.
Autorizações
Token específico do estabelecimento integrado. Disponível na seção de integrações do Portal do estabelecimento.
Parâmetros de consulta
Retorna apenas os pedidos que foram atualizados desde a data especificada. Deve ser uma data posterior a 24h atrás.
"2023-06-23T18:18:17-03:00"
Retorna apenas os pedidos com os status específicados. Para filtrar mais de um status na mesma requisição faça: status[]=confirmed&status[]=waiting_confirmation.
waiting_confirmation, confirmed, scheduled_confirmed, waiting_to_catch, released, closed, canceled Resposta
Retorna um array com os pedidos encontrados.
Para obter mais detalhes sobre a estrutura de um pedido, consulte nossa seção exclusiva sobre o assunto.
Identificador exclusivo do pedido.
Status do pedido.
waiting_confirmation: pedido pendente.pending_payment: pedido de balcão com pagamento pendente. Disponível apenas sesales_channelforstore_front_catalog.pending_online_payment: pedido aguardando confirmação de um pagamento online. Usado no caso de pedidos com pagamento por pix automático.scheduled_confirmed: pedido agendado confirmado. Disponível apenas seorder_timingforscheduled.confirmed: pedido confirmado e em preparação.ready: pedido pronto, mas ainda não está disponível para retirada e nem saiu para entrega.released: pedido saiu para entrega. Disponível apenas seorder_typefordelivery.waiting_to_catch: pedido pronto e esperando retirada. Disponível apenas seorder_typefortakeoutouonsite.delivered: pedido entregue. Disponível apenas seorder_typefordelivery.canceling: pedido em processo de cancelamento. Uma vez nesse status o pedido irá para o statuscanceledou então voltará para o status anterior. Usado no caso de pedidos com pagamento por cartão de crédito online.canceled: pedido cancelado.closed: pedido finalizado.
waiting_confirmation, pending_payment, pending_online_payment, scheduled_confirmed, confirmed, ready, released, waiting_to_catch, delivered, canceling, canceled, closed Tipo de pedido.
delivery: pedido de delivery.takeout: pedido de retirada.onsite: pedido de consumo no local.closed_table: pedido de mesa ou comanda.
delivery, takeout, onsite, closed_table Momento de entrega do pedido.
immediate: pedido deve ser preparado o mais breve possível.scheduled: pedido deve ficar pronto apenas na data agendada, que é enviada no camposchedule.
immediate, scheduled Indica por qual canal o pedido foi feito.
catalog: cardápio digital padrão (delivery e retirada).store_front_catalog: cardápio digital de balcão (apenas retirada).portal: portal de gestão.whatsapp_extension: extensão do Google Chrome para WhatsApp.ifood: pedidos recebidos através da integração com o iFood.
catalog, store_front_catalog, portal, whatsapp_extension, ifood Data e hora em que o pedido foi criado.
Data e hora da última vez que o pedido foi modificado.