Ações de Pedidos
Esta seção contém informações sobre os endpoints de ações de pedidos da API OpenDelivery. Através destas rotas, é possível atualizar o status de pedidos conforme eles avançam em seu ciclo de vida.
Visão Geral
O módulo de ações de pedidos permite que aplicações externas atualizem o status de um pedido, seguindo o fluxo definido pelo padrão OpenDelivery, garantindo a consistência das informações entre diferentes sistemas.
Endpoints Principais
| Método | Endpoint | Descrição |
|---|---|---|
| POST | /opendelivery/v1/orders/{orderId}/confirm | Confirma um pedido |
| POST | /opendelivery/v1/orders/{orderId}/preparing | Atualiza o status do pedido para em preparação |
| POST | /opendelivery/v1/orders/{orderId}/readyForPickup | Atualiza o status do pedido para pronto para retirada |
| POST | /opendelivery/v1/orders/{orderId}/pickedUp | Atualiza o status do pedido para retirado |
| POST | /opendelivery/v1/orders/{orderId}/dispatch | Despacha um pedido para entrega |
| POST | /opendelivery/v1/orders/{orderId}/delivered | Marca um pedido como entregue |
Limites de Uso (Rate Limiting)
Estes endpoints possuem as seguintes restrições de uso:
| Limite | Janela de Tempo |
|---|---|
| 100 requisições | 1 minuto |
Quando o limite é excedido, a API retorna o código de status HTTP 429 (Too Many Requests).
Status de Pedidos
De acordo com o padrão OpenDelivery, os pedidos podem passar pelos seguintes status:
| Status | Descrição |
|---|---|
PENDING | Pedido recebido, aguardando confirmação |
CONFIRMED | Pedido confirmado pelo estabelecimento |
PREPARING | Pedido em preparação |
READY_FOR_PICKUP | Pedido pronto para retirada/entrega |
PICKED_UP | Pedido retirado pelo entregador |
DELIVERED | Pedido entregue ao cliente |
CANCELED | Pedido cancelado |
Fluxo de Status
O fluxo padrão de um pedido segue a seguinte sequência:
PENDING→CONFIRMED→PREPARING→READY_FOR_PICKUP→PICKED_UP→DELIVERED
Alternativamente, um pedido pode ser cancelado a partir de qualquer status anterior a DELIVERED.
Códigos de Status
| Código | Descrição |
|---|---|
| 202 | Status atualizado com sucesso (Accepted) |
| 400 | Requisição inválida ou transição de status não permitida |
| 401 | Não autorizado |
| 404 | Pedido não encontrado |
| 429 | Limite de requisições excedido |
Documentação Completa
Para informações detalhadas sobre parâmetros, payload e exemplos adicionais, consulte a documentação técnica completa.