API : mettre à jour le statut d'une commande
POST /api/v1/orders/{order_id}/status permet à votre caisse d'indiquer à Menuthere quand la cuisine a accepté une commande et quand elle est partie. Il faut une clé avec l'accès Orders. Envoyer un statut que la commande a déjà ne change rien : un nouvel essai est donc sans risque.
- Où
- Ask Menuthere support for a key
- Formule
- Le tableau de bord ne verrouille pas cela selon la formule.
- Mis à jour
La requête
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"}'
| Élément | Valeur |
|---|---|
| Méthode et chemin | POST /api/v1/orders/{order_id}/status |
| En-tête | Authorization: Bearer ck_live_…, avec une clé ayant l'accès Orders |
| Corps | JSON : { "status": "accepted" } |
| order_id | L'identifiant de la commande. Il arrive sous la forme data.order_id dans le webhook de commande. |
| status autorisés | accepted, food_ready, dispatched, in_transit, completed |
La réponse
| Champ | Signification |
|---|---|
| ok | true en cas de succès. |
| order_id | La commande que vous avez mise à jour. |
| previous_status | L'état précédent de la commande. |
| status | Le statut qu'elle a maintenant. |
| changed | true si le statut a changé. false si la commande l'avait déjà : dans ce cas, rien n'a été écrit. |
Un changement réussi envoie aussi un événement order.status_updated à votre webhook, de sorte qu'un second système, comme une tablette, le voit aussi. Votre propre modification n'échoue jamais parce que le point d'accès de votre webhook est en panne.
Erreurs
| Statut | `error` | Signification |
|---|---|---|
| 400 | missing_status, unsupported_status, invalid_json, missing_order_id | Le corps n'est pas valide, ou le statut ne figure pas dans la liste autorisée. |
| 401 | missing_api_key, invalid_api_key | Aucune clé, ou une clé erronée ou révoquée. |
| 403 | scope_denied | La clé n'a pas l'accès Orders. |
| 404 | order_not_found | Aucune commande avec cet identifiant sur votre compte. |
| 429 | rate_limited | Trop de requêtes cette minute. |
| 503 | lookup_failed, update_failed | Menuthere n'a pas pu lire ou écrire la commande. Réessayez. |
Questions
Que se passe-t-il si ma caisse réessaie après un délai dépassé ?
Le client reçoit-il un message quand je change le statut ?
Voir aussi
Vous ne trouvez pas ? Écrivez à [email protected] ou discutez avec nous, de 9 h à 21 h.Centre d'aideTarifsmenuthere.com
