logo kimayo
ConnexionEssai gratuit
Hey, what answers do you need?
< Tous les articles
Imrimer

Tutoriel – Récupérations des commandes

Créé
mis à jour
ParEng-Hong Sron

Pour récupérer les commandes Kimayo via l’API REST, suivez les étapes suivantes :

1. Comprendre l’API des commandes

L’API REST de Kimayo propose plusieurs endpoints pour gérer les commandes :

  • GET /orders : Récupère toutes les commandes.
  • GET /orders/{ref} : Récupère une commande spécifique en utilisant sa référence.
  • PATCH /orders/{ref} : Met à jour partiellement une commande existante en utilisant sa référence.

Pour obtenir la liste complète des endpoints et leurs descriptions détaillées, consultez la documentation officielle de l’API REST de Kimayo.

2. Authentification

Avant d’accéder aux endpoints de l’API, assurez-vous de disposer d’un token API. Les détails sur le mécanisme d’obtention du token sont disponibles ici.

3. Récupérer toutes les commandes

Pour obtenir la liste des nouvelles commandes, effectuez une requête GET vers l’endpoint /orders :

curl -X 'GET' \
  'https://app.kimayo.com/api/v1/orders?status=new&externalid=null \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>'

Notes :

  • Le paramètre externalid=null permet de filtrer les commandes qui n’ont pas encore déjà été intégrées à un système tiers (voir point suivant pour plus de détails).
  • Le paramètre status permet de récupérer les commandes dans l’état voulu. Ce paramètres est à new par défaut, il renvoie donc les commandes affichés dans l’onglet “Nouvelles” du back-office Kimayo. Pour récupérer les commandes affichées dans l’onglet “Expéditions”, il faut utiliser le paramère status=accepted.
  • La liste complète des paramètres ainsi que leurs valeurs est disponible ici.

4. Marquer les commandes comme “exportées“

Une fois les commandes récupérées, il est possible de les marquer comme “exportées” en effectuant une requête PATCH sur l’endpoint /orders/{publicId}. Pour ce faire, il faut définir un externalId :

curl -X 'PATCH' \
  'https://app.kimayo.com/api/v1/orders/KIM-ABC-2400001' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "ID_EXTERNE_UNIQUE"
  }'

Le externalId permet d’identifier que la commande a bien été exportée vers un système tiers. Cette mise à jour est utile pour assurer la synchronisation entre les différents systèmes de gestion.

Sommaire
Menu