Cette API fournit l'état actuel de la commande, le calendrier d'expédition de la commande ainsi que la liste des articles de la commande en fonction des paramètres transmis dans la demande.
Les informations renvoyées sont basées sur le compte enregistré.
Disponibilité par pays - Liste des pays pour lesquels nous avons déjà testé les performances, la disponibilité et le temps de réponse de l'API :
- Argentine, Australie, Belgique, Brésil, Bulgarie, Canada, Chili, Colombie, Croatie, Danemark, Finlande, France, Allemagne, Inde, Mexique, Pays-Bas, Nouvelle-Zélande, Norvège, Pérou, Portugal, Roumanie, Slovénie, Espagne, Suède, Suisse, Turquie, Royaume-Uni et États-Unis.
Si votre pays ne figure pas dans la liste, vous pouvez nous contacter directement ou contacter votre Point de Contact Schneider (POC) pour vérifier si votre pays a accès à cet API.
L'accès à l'API nécessitera une authentification oAuth, veuillez vous référer aux détails sur le portail.
- Cette API supporte la pagination, veuillez vous référer aux détails ci-dessous pour comprendre comment la pagination fonctionne :
- Lorsque l'API est demandée avec des paramètres pour renvoyer une très longue liste d'éléments, la réponse est paginée afin d'éviter une charge utile lourde et une congestion du réseau.
- Un paramètre de demande peut être défini pour indiquer le nombre d'éléments à renvoyer dans une réponse API unique. (taille de page<=100)
Remarque : la taille de page par défaut est de 10 - Chaque réponse API renvoie également des paramètres tels que totalNumberOfRecords, totalNumberOfPages et pageNumber.
- totalNumberOfRecords : Combien d'enregistrements peuvent être retournés dans la réponse selon les paramètres passés dans la demande.
- totalNumberOfPages : Combien de pages sont attendues en fonction de la taille de page actuelle et du nombre total d'enregistrements. Par exemple, 100 enregistrements avec une taille de page de 10 nécessiteront 10 pages.
- pageNumber : pour lequel la réponse au numéro de page est requise.
L'accès à l'API nécessitera une authentification oAuth, veuillez vous référer aux détails sur le portail.
Paramètres pris en charge par l'API :
|
Paramètres |
Type de donnée |
Description |
Exemple |
|
country |
chaîne |
Code du pays pour lequel les détails de la commande sont requis. |
US |
|
order-number |
chaîne |
Numéro de commande dans l'ERP, il peut s'agir de la valeur totale de la commande ou de la valeur "startingFrom". |
AB12345 |
|
order-status |
chaîne |
Statut actuel de la commande dans l'ERP. |
Livré |
|
page |
chaîne |
Numéro de page actuel selon le nombre d'enregistrements et la taille de la page. |
1 |
|
page-size |
chaîne |
Nombre d'enregistrements attendus dans la réponse. |
10 |
|
item-number |
chaîne |
Numéro d'article d'un article particulier de la commande. |
79895 |
|
purchaser-id |
chaîne |
ID à 10 ou 5 chiffres de l'acheteur utilisé dans mySE |
1000006792 |
Cette API prend en charge les 3 opérations suivantes :
| ResourcePath | Paramètres obligatoires | Paramètres facultatifs | Réponse attendue |
| /orders/{country} | pays |
Order-number, order-status, page, page-size, purchaser-id |
Toutes les commandes liées au compte dans le pays demandé. |
| /orders/{country}/{order-number}/{item-number}/shipment-schedules | Country, order-number, item-number |
purchaser-id |
Le calendrier d'expédition de l'article demandé dans la commande sera retourné. |
| /orders/{country}/{order-number} | Country, order-number |
Item-number, purchaser-id | Les informations générales ainsi que le calendrier d'expédition des articles/articles en commande sont retournés. |
