/orders
  • Cet endpoint est à utiliser pour interroger vos commandes dans l'API Lengow. Choisissez les paramètres/variables dans votre requête pour affiner votre demande.
/orders/actions
  • Cet endpoint vous permet d'effectuer des actions sur vos commandes

Interrogez vos commandes

GET /orders/

C'est l'entrée principale de notre API! 
Cet endpoint contient la liste de toutes vos commandes. Complétez votre requête GET avec des paramètres/filtres pour obtenir exactement ce que vous recherchez. 

Bien configurer ses requêtes 

Retrouvez ci-dessous quelques points à connaître pour bien configurer vos requêtes avant de faire vos appels à l'API Lengow. 

  • 1. Pagination
L'API peut afficher un maximum de 100 résultats par page avec le paramètre page_size. 
Exemple: 
/orders/?account_id=1 → par défaut
/orders/?account_id=1&page=5&page_size=50 → Page 5 (5 pages de résultats avec max 50 résultats par pages)

  • 2. Ordre des résultats
Vous pouvez contrôler l'ordre des résultats avec le paramètre de tri. Pour inverser l'ordre, vous pouvez préfixer votre champ par "-". Liste des champs de commande pris en charge ici

L'ordre par défaut est : marketplace-marketplace_order_date-imported_at
Exemple:  /orders/?account_id=1&ordering=marketplace,-updated_at

  • 3. Paramètres de requêtes (filtres)
Vous pouvez ajouter des paramètres de filtres (des variables) à vos requêtes directement dans l'URL de votre appel ou en utilisant l'onglet Paramètres (postman)
 
"account_id" est un paramètre obligatoire. Utilisez-le pour toute demande/action que vous envoyez à l'API 
Ces paramètres de requête vous aideront à affiner vos résultats, par exemple, en ajoutant le "&marketplace_order_id". ou à obtenir toutes les commandes d'un marché spécifique.
Exemples: 
/orders/?Account_id=1&marketplace=menlook
/orders/?Account_id=1 &marketplace_order_id=123456789   

  • 4.  Changer la monnaie

Par défaut, tous les champs de montant sont renvoyés dans la devise de votre compte Lengow. 

Si vous souhaitez modifier la devise, vous pouvez utiliser le paramètre set_currency

La valeur doit être spécifiée sous forme de trois caractères  (ISO 4217
Exemple:  /orders/?account_id=1&set_currency=USD 

Utilisez autant de paramètres que vous le souhaitez avec le symbole "&".

Exemple:  /orders/?account_id=1&lengow_status=waiting_shipment&marketplace_order_id=1123456789  

Exemple de réponse API

Dans cet exemple de réponse, vous trouverez plusieurs éléments envoyés depuis la marketplace, tous classés dans différents objets avec plusieurs paramètres/variables. 

Tous les détails de la commande envoyée par la marketplace tels que marketplace_order_id, marketplace_status (statut de la commande), total_order, marketplace_order_date vous aideront à agir sur votre commande. 

Dans cet exemple vous voyez tous les produits de la commande et ceux qui font partie de la commande. Il peut n'y avoir qu'un seul produit (dans le cas où le client commande un seul produit), ou plusieurs dans le cas où le client commande plus d'un produit. 

Astuce: Pour trouver l'information "expédié par la marketplace" recherchez le paramètre "is_delivered_by_marketplace" dans l'objet "tracking" de la réponse.

Liste des paramètres acceptés

Retrouvez ci-dessous la liste des paramètres/filtres possibles que vous pouvez ajouter à vos requêtes pour le endpoint /orders de notre API :

  • account_id:  identifiant de votre compte Lengow. obligatoire. Utilisez-le pour toute demande ou action
  • marketplace_order_date_from:  Obligatoire. Par défaut, défini sur le jour actuel - 7 jours.
  • marketplace: nom de la marketplace, peut être multiple mais séparez-les par une virgule Exemple: "amazon_uk", ou "amazon_uk,darty"  
  • marketplace_order_id: ID de la commande
  • merchant_order_id
  • lengow_status: Le statut lengow. Séparer par une virgule si multiples. Exemple: "shipped", "shipped, waiting_shipment"
  • marketplace_status
  • marketplace_order_date_to:  Par défaut défini sur le jour actuel 
  • order_type: Exemple: "is_business", "is_business, is_express"
  • imported_from
  • imported_to
  • updated_from
  • updated_to
  • set_currency
  • no_currency_conversion
  •  catalog_ids: Exemple: " id1,id2" 

Notez que si vous utilisez un paramètre non pris en charge par notre API, votre demande peut se terminer par une erreur ou le paramètre sera simplement ignoré.

Exemple: "is_delivered_by_marketplacen'est pas un filtre valide, mais il existe dans la réponse de l'API en tant que champ. Il sera donc ignoré s'il est utilisé dans une requête ou une action.

Chaque marketplace a son propre statut. Dans Lengow, tous ces statuts sont convertis en statuts Lengow

Interrogez les actions sur vos commandes

GET /orders/actions/ 
Vous pouvez suivre/vérifier le statut de chaque action effectuée sur vos commandes avec les paramètres "queued" (file d'attente) et "processed" (traité)
 
  • queued: true 
Signifie que l'action attend le traitement (ou une nouvelle tentative en cas d'échec) 
  • queued: false
Signifie que l'action a été traitée 
  • processed: true  
Signifie que l'action est valide et a été envoyée avec succès
  •  “processed: false  
Signifie que l'action n'est pas valide, vérifiez le paramètre "error".
Exemple: (voir image)
Cette action "GET" vous permet également de vérifier si la commande est en erreur en regardant le paramètre "errors".
Consultez nos cas d'usages pour plus d'informations sur ces paramètres.

Créer une action sur une commande

POST /orders/actions/
Avec cet endpoint de l'API, vous pouvez effectuer des actions sur vos commandes. 

  • C'est ici que vous pouvez "expédier", "annuler" ou "rembourser" une commande si ces actions sont autorisées par la marketplace.

API / Les commandes

/orders
  • Cet endpoint est à utiliser pour interroger vos commandes dans l'API Lengow. Choisissez les paramètres/variables dans votre requête pour affiner votre demande.
/orders/actions
  • Cet endpoint vous permet d'effectuer des actions sur vos commandes

Interrogez vos commandes

GET /orders/

C'est l'entrée principale de notre API! 
Cet endpoint contient la liste de toutes vos commandes. Complétez votre requête GET avec des paramètres/filtres pour obtenir exactement ce que vous recherchez. 

Bien configurer ses requêtes 

Retrouvez ci-dessous quelques points à connaître pour bien configurer vos requêtes avant de faire vos appels à l'API Lengow. 

  • 1. Pagination
L'API peut afficher un maximum de 100 résultats par page avec le paramètre page_size. 
Exemple: 
/orders/?account_id=1 → par défaut
/orders/?account_id=1&page=5&page_size=50 → Page 5 (5 pages de résultats avec max 50 résultats par pages)

  • 2. Ordre des résultats
Vous pouvez contrôler l'ordre des résultats avec le paramètre de tri. Pour inverser l'ordre, vous pouvez préfixer votre champ par "-". Liste des champs de commande pris en charge ici

L'ordre par défaut est : marketplace-marketplace_order_date-imported_at
Exemple:  /orders/?account_id=1&ordering=marketplace,-updated_at

  • 3. Paramètres de requêtes (filtres)
Vous pouvez ajouter des paramètres de filtres (des variables) à vos requêtes directement dans l'URL de votre appel ou en utilisant l'onglet Paramètres (postman)
 
"account_id" est un paramètre obligatoire. Utilisez-le pour toute demande/action que vous envoyez à l'API 
Ces paramètres de requête vous aideront à affiner vos résultats, par exemple, en ajoutant le "&marketplace_order_id". ou à obtenir toutes les commandes d'un marché spécifique.
Exemples: 
/orders/?Account_id=1&marketplace=menlook
/orders/?Account_id=1 &marketplace_order_id=123456789   

  • 4.  Changer la monnaie

Par défaut, tous les champs de montant sont renvoyés dans la devise de votre compte Lengow. 

Si vous souhaitez modifier la devise, vous pouvez utiliser le paramètre set_currency

La valeur doit être spécifiée sous forme de trois caractères  (ISO 4217
Exemple:  /orders/?account_id=1&set_currency=USD 

Utilisez autant de paramètres que vous le souhaitez avec le symbole "&".

Exemple:  /orders/?account_id=1&lengow_status=waiting_shipment&marketplace_order_id=1123456789  

Exemple de réponse API

Dans cet exemple de réponse, vous trouverez plusieurs éléments envoyés depuis la marketplace, tous classés dans différents objets avec plusieurs paramètres/variables. 

Tous les détails de la commande envoyée par la marketplace tels que marketplace_order_id, marketplace_status (statut de la commande), total_order, marketplace_order_date vous aideront à agir sur votre commande. 

Dans cet exemple vous voyez tous les produits de la commande et ceux qui font partie de la commande. Il peut n'y avoir qu'un seul produit (dans le cas où le client commande un seul produit), ou plusieurs dans le cas où le client commande plus d'un produit. 

Astuce: Pour trouver l'information "expédié par la marketplace" recherchez le paramètre "is_delivered_by_marketplace" dans l'objet "tracking" de la réponse.

Liste des paramètres acceptés

Retrouvez ci-dessous la liste des paramètres/filtres possibles que vous pouvez ajouter à vos requêtes pour le endpoint /orders de notre API :

  • account_id:  identifiant de votre compte Lengow. obligatoire. Utilisez-le pour toute demande ou action
  • marketplace_order_date_from:  Obligatoire. Par défaut, défini sur le jour actuel - 7 jours.
  • marketplace: nom de la marketplace, peut être multiple mais séparez-les par une virgule Exemple: "amazon_uk", ou "amazon_uk,darty"  
  • marketplace_order_id: ID de la commande
  • merchant_order_id
  • lengow_status: Le statut lengow. Séparer par une virgule si multiples. Exemple: "shipped", "shipped, waiting_shipment"
  • marketplace_status
  • marketplace_order_date_to:  Par défaut défini sur le jour actuel 
  • order_type: Exemple: "is_business", "is_business, is_express"
  • imported_from
  • imported_to
  • updated_from
  • updated_to
  • set_currency
  • no_currency_conversion
  •  catalog_ids: Exemple: " id1,id2" 

Notez que si vous utilisez un paramètre non pris en charge par notre API, votre demande peut se terminer par une erreur ou le paramètre sera simplement ignoré.

Exemple: "is_delivered_by_marketplacen'est pas un filtre valide, mais il existe dans la réponse de l'API en tant que champ. Il sera donc ignoré s'il est utilisé dans une requête ou une action.

Chaque marketplace a son propre statut. Dans Lengow, tous ces statuts sont convertis en statuts Lengow

Interrogez les actions sur vos commandes

GET /orders/actions/ 
Vous pouvez suivre/vérifier le statut de chaque action effectuée sur vos commandes avec les paramètres "queued" (file d'attente) et "processed" (traité)
 
  • queued: true 
Signifie que l'action attend le traitement (ou une nouvelle tentative en cas d'échec) 
  • queued: false
Signifie que l'action a été traitée 
  • processed: true  
Signifie que l'action est valide et a été envoyée avec succès
  •  “processed: false  
Signifie que l'action n'est pas valide, vérifiez le paramètre "error".
Exemple: (voir image)
Cette action "GET" vous permet également de vérifier si la commande est en erreur en regardant le paramètre "errors".
Consultez nos cas d'usages pour plus d'informations sur ces paramètres.

Créer une action sur une commande

POST /orders/actions/
Avec cet endpoint de l'API, vous pouvez effectuer des actions sur vos commandes. 

  • C'est ici que vous pouvez "expédier", "annuler" ou "rembourser" une commande si ces actions sont autorisées par la marketplace.
Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0
Vous avez d’autres questions ? Envoyer une demande