Retrouvez ici quelques astuces et cas d'utilisation de l'API Lengow pour vous aider à construire vos requêtes et actions avec notre API.
Afin d'illustrer ces cas d'utilisation nous avons choisi de faire appel à un marchand test.
  • Appelons notre marchand de test "Julia" et disons que son numéro de compte est "1". 
  • Veuillez noter qu'elle utilise Postman pour passer tous ses appels API. 
  • Les résultats ou exemple de requête seront affichés au format JSON si cela est possible,
  • Ce sont de purs exemples ils doivent être adaptés à votre compte utilisateur.
Plus d'informations sur Postman et comment créer une collection (groupe de requêtes enregistrées) ici.

Se connecter à l'API Lengow : Get Access Token

La première étape avant d'effectuer un appel ou toute action au sein de l'API Lengow consiste à entrer dans l'API.

Pour ce faire, Julia (notre marchand test) va récupérer ses informations d'identification Lengow depuis son profil sur la plateforme qui sont :
Lengow account ID
- secret token
- token 
Puis elle va ouvrir Postman.
Ensuite, une fois qu'elle a défini un nouvel environnement dans Postman avec ses informations d'identification, elle peut continuer et envoyer le premier appel (POST) pour récupérer un token d'accès à l'API.
  • Cet appel se construit comme ici :
POST /access/get_token
 
  • L'API renvoie le jeton d'accès (token) tel que celui-ci :
{
   "token": "69946b78-edae-49b8-8874-6fb025e09a58",
   "account_id": 1
}

Elle ajoute ce token à son environnement dans Postman sous la variable LENGOW_AUTH. (voir image)

Conseil Lengow : avec l'aide de vos développeurs, vous pouvez configurer un script qui effectue cet appel automatiquement toutes les heures.    

 Remarque : le "token" envoyé par l'API Lengow est valide 3600 secondes et peut être utilisé comme Lengow_AUTH dans Postman. 

Vérifier ses actions effectuées sur une commande

Julia a corrigé une de ses actions d'expédition "ship" sur une commande. Elle souhaite vérifier que sa correction est correcte et que l'action qu'elle a envoyée a été correctement traitée par l'API Lengow.

  • GET /orders/actions/
Depuis l'API Lengow, elle interroge cette commande à l'aide du paramètre "& marketplace_order_id" et utilise l'ID de sa commande. (voir l'image par l'exemple de requête)
  • Réponse de l'API

La réponse de l'API indique que 2 actions ont été effectuées sur cette commande:

   "count": 2

Dans les résultats, on peut voir que l'ID de commande apparaît deux fois. Cela signifie que le serveur affiche la même commandes deux fois car deux actions ont été effectuées.
La dernière action est affichée en haut de la réponse.

En bas de la réponse API (la première action de Julia), examinez les paramètres suivants: 

  • "action_type"
  • "processed"
  • "queued"
  • "error"

1 / La première action "ship" (expédition), envoyée plus tôt par Julia (celle tout en bas de l'image), n'est pas valide car on voit dans la réponse de l'API:

"processed": false
"error": "Tracking needs number AND carrier for ship order action" 
  

Ici, l'API eBay indique à  l'API de Lengow, que cette action "ship" de Julia est incomplète car un ou plusieurs paramètres manquent.
  • Vous pouvez voir que le paramètre "tracking_number" est vide ("null") dans la première action "ship".
 2/ La deuxième action "ship" que Julia a renvoyé est valide et a bien été envoyée à l'API eBay car on peut voir : 
  • "processed": true
  • "queued": false
  • "error": null
Plus d'informations sur les paramètres "processed" et "queued" ici.

Trouver les informations de livraison sur une commande

Julia, notre marchand test, a reçu une nouvelle commande pour le diffuseur La Redoute. Elle souhaite trouver les informations de livraison pour pouvoir l'expédier. 


C'est à dire, qu'elle cherche à savoir quelles sont les informations qu'elle doit compléter pour correctement envoyer sa commande. 

Voici les étapes qu'elle suit dans l'API Lengow : 

ETAPE 1
Une fois connectée à l'API, elle interroge sa commande (voir image) en utilisant le endpoint orders comme ceci : 

GET /orders/?account_id=1&marketplace_order_id=2020.111.123456789
  • La commande est bien au statut "waiting_shipment".
Depuis le paramètre "delivery" > "trackings" de la réponse API, Julia prend connaissance de la méthode de livraison choisie par le client (ici envoi à domicile) :
  • "method": "Home / Regular"
Depuis ce paramètre "tracking" on trouve d'autres informations qui peuvent être complétées en fonction de la méthode de livraison choisie par le client : 
"is_delivered_by_marketplace": null,
"pickup_store": { "id": null },
"relay": { "id": null, "name": null
Note : Si la méthode  "Relais / Regular" avait été choisie, la balise "relay" de la commande aurait été complétée avec un Identifiant et un nom de point relais.
ETAPE 2
Julia interroge ensuite les informations globales de la marketplace afin de savoir quels sont les éléments obligatoires à renseigner pour correctement expédier sa commande.
 
Depuis l'API, elle utilise cette fois le endpoint /marketplace et le paramètre ?marketplace=laredoute

GET /marketplaces/?marketplace=laredoute  

Dans la réponse que lui retourne l'API Lengow, elle trouve les informations de 
  • statuts des commandes
  • action autorisées sur les commandes et les paramètres obligatoires à renseigner pour effectuer l'action
  • transporteurs autorisés par la marketplace dans la balise "carriers"
Ici, pour La Redoute, on trouve l'information : 
 "actions": {
                "ship": {
                   "args": [
                       "carrier",
                       "tracking_number"
                   ],
Puis elle consulte l'élément "carrier" pour savoir comment renseigner cette valeur et savoir si une liste est donnée par la marketplace : 
"carrier": {
                           "type": "string",
                           "valid_values": {},
                           "default_value": "",
                           "accept_free_values": true 
Cela signifie que pour valider l'expédition de sa commande La Redoute (envoi à domicile), Julia doit fournir 
  • les informations de "carrier" (transporteur)
  • un "tracking_number" (numéro de tracking colis). 
Comme il n'y a pas de liste de transporteurs imposés, elle peut utiliser le transporteur de son choix.
Retrouvez toutes les définitions ici

API / Cas d'usages

Retrouvez ici quelques astuces et cas d'utilisation de l'API Lengow pour vous aider à construire vos requêtes et actions avec notre API.
Afin d'illustrer ces cas d'utilisation nous avons choisi de faire appel à un marchand test.
  • Appelons notre marchand de test "Julia" et disons que son numéro de compte est "1". 
  • Veuillez noter qu'elle utilise Postman pour passer tous ses appels API. 
  • Les résultats ou exemple de requête seront affichés au format JSON si cela est possible,
  • Ce sont de purs exemples ils doivent être adaptés à votre compte utilisateur.
Plus d'informations sur Postman et comment créer une collection (groupe de requêtes enregistrées) ici.

Se connecter à l'API Lengow : Get Access Token

La première étape avant d'effectuer un appel ou toute action au sein de l'API Lengow consiste à entrer dans l'API.

Pour ce faire, Julia (notre marchand test) va récupérer ses informations d'identification Lengow depuis son profil sur la plateforme qui sont :
Lengow account ID
- secret token
- token 
Puis elle va ouvrir Postman.
Ensuite, une fois qu'elle a défini un nouvel environnement dans Postman avec ses informations d'identification, elle peut continuer et envoyer le premier appel (POST) pour récupérer un token d'accès à l'API.
  • Cet appel se construit comme ici :
POST /access/get_token
 
  • L'API renvoie le jeton d'accès (token) tel que celui-ci :
{
   "token": "69946b78-edae-49b8-8874-6fb025e09a58",
   "account_id": 1
}

Elle ajoute ce token à son environnement dans Postman sous la variable LENGOW_AUTH. (voir image)

Conseil Lengow : avec l'aide de vos développeurs, vous pouvez configurer un script qui effectue cet appel automatiquement toutes les heures.    

 Remarque : le "token" envoyé par l'API Lengow est valide 3600 secondes et peut être utilisé comme Lengow_AUTH dans Postman. 

Vérifier ses actions effectuées sur une commande

Julia a corrigé une de ses actions d'expédition "ship" sur une commande. Elle souhaite vérifier que sa correction est correcte et que l'action qu'elle a envoyée a été correctement traitée par l'API Lengow.

  • GET /orders/actions/
Depuis l'API Lengow, elle interroge cette commande à l'aide du paramètre "& marketplace_order_id" et utilise l'ID de sa commande. (voir l'image par l'exemple de requête)
  • Réponse de l'API

La réponse de l'API indique que 2 actions ont été effectuées sur cette commande:

   "count": 2

Dans les résultats, on peut voir que l'ID de commande apparaît deux fois. Cela signifie que le serveur affiche la même commandes deux fois car deux actions ont été effectuées.
La dernière action est affichée en haut de la réponse.

En bas de la réponse API (la première action de Julia), examinez les paramètres suivants: 

  • "action_type"
  • "processed"
  • "queued"
  • "error"

1 / La première action "ship" (expédition), envoyée plus tôt par Julia (celle tout en bas de l'image), n'est pas valide car on voit dans la réponse de l'API:

"processed": false
"error": "Tracking needs number AND carrier for ship order action" 
  

Ici, l'API eBay indique à  l'API de Lengow, que cette action "ship" de Julia est incomplète car un ou plusieurs paramètres manquent.
  • Vous pouvez voir que le paramètre "tracking_number" est vide ("null") dans la première action "ship".
 2/ La deuxième action "ship" que Julia a renvoyé est valide et a bien été envoyée à l'API eBay car on peut voir : 
  • "processed": true
  • "queued": false
  • "error": null
Plus d'informations sur les paramètres "processed" et "queued" ici.

Trouver les informations de livraison sur une commande

Julia, notre marchand test, a reçu une nouvelle commande pour le diffuseur La Redoute. Elle souhaite trouver les informations de livraison pour pouvoir l'expédier. 


C'est à dire, qu'elle cherche à savoir quelles sont les informations qu'elle doit compléter pour correctement envoyer sa commande. 

Voici les étapes qu'elle suit dans l'API Lengow : 

ETAPE 1
Une fois connectée à l'API, elle interroge sa commande (voir image) en utilisant le endpoint orders comme ceci : 

GET /orders/?account_id=1&marketplace_order_id=2020.111.123456789
  • La commande est bien au statut "waiting_shipment".
Depuis le paramètre "delivery" > "trackings" de la réponse API, Julia prend connaissance de la méthode de livraison choisie par le client (ici envoi à domicile) :
  • "method": "Home / Regular"
Depuis ce paramètre "tracking" on trouve d'autres informations qui peuvent être complétées en fonction de la méthode de livraison choisie par le client : 
"is_delivered_by_marketplace": null,
"pickup_store": { "id": null },
"relay": { "id": null, "name": null
Note : Si la méthode  "Relais / Regular" avait été choisie, la balise "relay" de la commande aurait été complétée avec un Identifiant et un nom de point relais.
ETAPE 2
Julia interroge ensuite les informations globales de la marketplace afin de savoir quels sont les éléments obligatoires à renseigner pour correctement expédier sa commande.
 
Depuis l'API, elle utilise cette fois le endpoint /marketplace et le paramètre ?marketplace=laredoute

GET /marketplaces/?marketplace=laredoute  

Dans la réponse que lui retourne l'API Lengow, elle trouve les informations de 
  • statuts des commandes
  • action autorisées sur les commandes et les paramètres obligatoires à renseigner pour effectuer l'action
  • transporteurs autorisés par la marketplace dans la balise "carriers"
Ici, pour La Redoute, on trouve l'information : 
 "actions": {
                "ship": {
                   "args": [
                       "carrier",
                       "tracking_number"
                   ],
Puis elle consulte l'élément "carrier" pour savoir comment renseigner cette valeur et savoir si une liste est donnée par la marketplace : 
"carrier": {
                           "type": "string",
                           "valid_values": {},
                           "default_value": "",
                           "accept_free_values": true 
Cela signifie que pour valider l'expédition de sa commande La Redoute (envoi à domicile), Julia doit fournir 
  • les informations de "carrier" (transporteur)
  • un "tracking_number" (numéro de tracking colis). 
Comme il n'y a pas de liste de transporteurs imposés, elle peut utiliser le transporteur de son choix.
Retrouvez toutes les définitions ici
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