API: atualizar o status de um pedido
POST /api/v1/orders/{order_id}/status permite que seu PDV avise a Menuthere quando a cozinha aceitou um pedido e quando ele saiu. Precisa de uma chave com acesso Orders. Enviar um status que o pedido já tem não muda nada, então repetir a chamada é seguro.
- Onde
- Ask Menuthere support for a key
- Plano
- O painel não restringe isso por plano.
- Atualizado
A requisição
curl -X POST 'https://menuthere.com/api/v1/orders/ORDER_ID/status' -H 'Authorization: Bearer ck_live_YOUR_KEY' -H 'Content-Type: application/json' -d '{"status":"accepted"}'
| Parte | Valor |
|---|---|
| Método e caminho | POST /api/v1/orders/{order_id}/status |
| Cabeçalho | Authorization: Bearer ck_live_…, de uma chave com acesso Orders |
| Corpo | JSON: { "status": "accepted" } |
| order_id | O ID do pedido. Ele chega como data.order_id no webhook de pedidos. |
| status permitido | accepted, food_ready, dispatched, in_transit, completed |
A resposta
| Campo | Significado |
|---|---|
| ok | true em caso de sucesso. |
| order_id | O pedido que você atualizou. |
| previous_status | O que o pedido era antes. |
| status | O status que ele tem agora. |
| changed | true se o status mudou. false se o pedido já o tinha, caso em que nada foi gravado. |
Uma mudança bem-sucedida também envia um evento order.status_updated ao seu webhook, para que um segundo sistema, como um tablet, também a veja. Sua própria mudança nunca falha porque o endpoint do seu webhook está fora do ar.
Erros
| Status | `error` | Significado |
|---|---|---|
| 400 | missing_status, unsupported_status, invalid_json, missing_order_id | O corpo não é válido, ou o status não está na lista permitida. |
| 401 | missing_api_key, invalid_api_key | Sem chave, ou chave errada ou revogada. |
| 403 | scope_denied | A chave não tem acesso Orders. |
| 404 | order_not_found | Nenhum pedido com esse ID na sua conta. |
| 429 | rate_limited | Requisições demais neste minuto. |
| 503 | lookup_failed, update_failed | A Menuthere não conseguiu ler ou gravar o pedido. Tente de novo. |
Perguntas
O que acontece se meu PDV repetir a chamada depois de um timeout?
O cliente recebe uma mensagem quando eu mudo o status?
Relacionados
Não encontrou? Escreva para [email protected] ou fale com a gente no chat, das 9h às 21h.Central de ajudaPreçosmenuthere.com