Suivi de commande

Netwo expose une vue unifiée du suivi de commande, quel que soit le protocole de l'OI. L'OC peut suivre l'avancement par polling ou webhook.

États possibles : Une commande traverse les états suivants : SUBMITTED → VALIDATED → SCHEDULED → IN_PROGRESS → DELIVERED. L'état REJECTED peut intervenir à tout moment.

Statut courant

Récupérez le statut actuel d'une commande en une seule requête.

GET/v1/orders/{orderId}/status

Retourne le statut courant de la commande identifiée par son orderId.

bash

curl https://api.netwo.io/v1/orders/ORD-2024-00142/status \
  -H "Authorization: Bearer YOUR_API_KEY"

json

{
  "orderId": "ORD-2024-00142",
  "currentStatus": "SCHEDULED",
  "updatedAt": "2024-03-18T14:22:00Z",
  "detail": "Intervention planifiée le 2024-03-25",
  "operator": { "code": "AXIONE", "name": "Axione" }
}

Historique des étapes

Consultez l'ensemble des transitions de statut d'une commande avec pagination.

GET/v1/orders/{orderId}/history

Retourne l'historique complet des changements de statut de la commande.

Paramètres

Nom	Type	Requis	Description
`page`	number	optionnel	Numéro de page (défaut : 1)
`perPage`	number	optionnel	Résultats par page (défaut : 50)

bash

curl "https://api.netwo.io/v1/orders/ORD-2024-00142/history?page=1&perPage=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

json

{
  "orderId": "ORD-2024-00142",
  "history": [
    { "status": "SUBMITTED", "timestamp": "2024-03-15T10:30:00Z", "detail": "Commande soumise" },
    { "status": "VALIDATED", "timestamp": "2024-03-16T09:15:00Z", "detail": "Commande validée par l'OI" },
    { "status": "SCHEDULED", "timestamp": "2024-03-18T14:22:00Z", "detail": "Intervention planifiée le 2024-03-25" }
  ]
}

Configurer un webhook de suivi

Recevez des notifications en temps réel lors des changements de statut de vos commandes.

POST/v1/webhooks

Enregistre un webhook pour recevoir les événements de suivi de commande.

Paramètres

Nom	Type	Requis	Description
`url`	string	requis	URL de votre endpoint webhook
`events`	string[]	requis	Événements à écouter : ORDER_STATUS_CHANGED, ORDER_DELIVERED, ORDER_REJECTED
`secret`	string	optionnel	Clé de signature HMAC pour vérifier l'authenticité des appels

bash

curl -X POST https://api.netwo.io/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-system.com/webhooks/orders",
    "events": ["ORDER_STATUS_CHANGED", "ORDER_DELIVERED", "ORDER_REJECTED"],
    "secret": "whsec_your_signing_key"
  }'

Exemple de payload reçu

Voici le format JSON envoyé à votre URL lors d'un changement de statut.

json

{
  "event": "ORDER_STATUS_CHANGED",
  "orderId": "ORD-2024-00142",
  "previousStatus": "VALIDATED",
  "newStatus": "SCHEDULED",
  "detail": "Intervention planifiée le 2024-03-25",
  "timestamp": "2024-03-18T14:22:00Z"
}

Machine à états de la commande

Le cycle de vie d'une commande suit le parcours ci-dessous. L'état REJECTED peut survenir depuis n'importe quel état.

SUBMITTED→VALIDATED→SCHEDULED→IN_PROGRESS→DELIVERED

REJECTED (à tout moment)

Guide précédent : Prise de commande Guide suivant : Prise de rendez-vous