Récupérez une liste de numéros de commande ou des informations détaillées sur une commande.
Ce point de terminaison API « Retrieve an Order » permet de récupérer les données d'une commande finalisée dans le système Zonos. La réponse contient un objet JSON représentant toutes les informations disponibles pour la commande, y compris les adresses de facturation et d'expédition, le mode d'expédition, les totaux de commande et le statut.
Récupère des informations détaillées pour une commande.
Utilisation du point de terminaison API Retrieve an Order
Il existe deux façons courantes d'utiliser ces points de terminaison.
(Partie 1 + Partie 2) – Utilisez une page de confirmation / succès de commande personnalisée sur votre domaine pour déclencher l'appel de votre système au point de terminaison orderDetail et l'importation d'une commande finalisée. De plus, appelez régulièrement le point de terminaison orderNumbers pour rapprocher les commandes du système Zonos qui n'ont pas encore été importées dans votre système.
(Partie 2 uniquement) – Utilisez la page de confirmation / succès de commande Zonos de base ou une page statique sur votre domaine pour indiquer au client la finalisation de la commande. Planifiez votre système pour appeler régulièrement le point de terminaison orderNumbers afin de déterminer quand une nouvelle commande est prête à être importée dans votre système. Lorsqu'une commande en attente est trouvée, appelez le point de terminaison orderDetail pour obtenir les données de ces commandes.
Partie 1 : Page de succès sur votre domaine
Chaque fois qu'un acheteur finalise une commande dans Zonos Checkout, il est immédiatement redirigé vers l'URL d'une page de succès de commande. L'ID de la commande finalisée est ajouté à l'URL de redirection en tant que chaîne de requête. L'URL de la page de succès de commande doit être fournie à Zonos. L'URL peut également être transmise en tant que paramètre dans le point de terminaison createTempCart lors de la création du panier temporaire dans le système Zonos.
Lorsqu'un client est redirigé vers cette page, votre système devra extraire la valeur de orderId depuis l'URL. Vous utiliserez ensuite orderId pour appeler le point de terminaison orderDetail et récupérer les données de la commande.
Partie 2 : Utiliser une tâche planifiée
En plus d'appeler les détails de commande lorsque la page de succès est déclenchée, nous vous recommandons de configurer un appel planifié pour toutes les commandes et leurs détails, à titre de filet de sécurité. Ainsi, vous pourrez récupérer toute commande finalisée dans le système Zonos qui n'a pas encore été importée dans votre système.
Ce processus doit être une tâche / un script planifié, par exemple une tâche Cron, exécuté une fois par heure / quart / jour / etc. (planifiez aussi souvent que vos processus métier le jugent nécessaire). Le script doit récupérer toutes les commandes et leurs détails survenus depuis le dernier appel pour les commandes. Le point de terminaison orderNumbers vous permet de récupérer les commandes sinceOrderId ou sinceDate, comme illustré dans l'interface de test API disponible ici. Toutes les commandes récupérées via cet appel planifié doivent ensuite être rapprochées des commandes insérées dans votre système à chaque fois que la page de succès a été déclenchée. Toute commande qui n'est pas déjà dans votre système doit y être insérée et traitée comme une commande légitime.
Statut initial de la commande
IGLOBAL_ORDER_IN_PROCESS ou IGLOBAL_FRAUD_REVIEW
Lors de l'appel au point de terminaison orderDetail, nous recommandons que votre système vérifie d'abord la propriété orderStatus des données de commande.
Les commandes qui ne nécessitent pas de vérification de fraude s'initialiseront avec orderStatus : IGLOBAL_ORDER_IN_PROCESS. Une commande dans ce statut est prête à être traitée et expédiée.
Les commandes qui nécessitent une vérification de fraude s'initialiseront avec orderStatus : IGLOBAL_FRAUD_REVIEW. Une commande dans ce statut est actuellement contrôlée et examinée pour une fraude suspectée. Nous vous recommandons de placer cette commande en statut de révision ou de mise en attente dans votre système et de continuer à appeler le point de terminaison orderDetail jusqu'à ce que la commande progresse au-delà du processus de vérification de fraude de Zonos.
Une fois le processus de détection de fraude Zonos terminé, la commande passera à l'un des états suivants :
La commande passe la vérification de fraude
La commande passera à orderStatus : IGLOBAL_ORDER_IN_PROCESS et pourra continuer vers l'expédition.
La commande échoue à la vérification de fraude
La commande passera à orderStatus : IGLOBAL_ORDER_CANCELLED et doit être annulée dans votre système.
Récupérer une commande
Récupérer une commande
Récupérez une liste de numéros de commande ou des informations détaillées sur une commande.
Ce point de terminaison API « Retrieve an Order » permet de récupérer les données d'une commande finalisée dans le système Zonos. La réponse contient un objet JSON représentant toutes les informations disponibles pour la commande, y compris les adresses de facturation et d'expédition, le mode d'expédition, les totaux de commande et le statut.
Points de terminaison
Numéros de commande
Récupère une liste de numéros de commande.
Détails de commande
Récupère des informations détaillées pour une commande.
Utilisation du point de terminaison API Retrieve an Order
Il existe deux façons courantes d'utiliser ces points de terminaison.
orderDetailet l'importation d'une commande finalisée. De plus, appelez régulièrement le point de terminaisonorderNumberspour rapprocher les commandes du système Zonos qui n'ont pas encore été importées dans votre système.orderNumbersafin de déterminer quand une nouvelle commande est prête à être importée dans votre système. Lorsqu'une commande en attente est trouvée, appelez le point de terminaisonorderDetailpour obtenir les données de ces commandes.Partie 1 : Page de succès sur votre domaine
Chaque fois qu'un acheteur finalise une commande dans Zonos Checkout, il est immédiatement redirigé vers l'URL d'une page de succès de commande. L'ID de la commande finalisée est ajouté à l'URL de redirection en tant que chaîne de requête. L'URL de la page de succès de commande doit être fournie à Zonos. L'URL peut également être transmise en tant que paramètre dans le point de terminaison
createTempCartlors de la création du panier temporaire dans le système Zonos.Example: http://www.examplestore.com/internationalThankYou?orderId=999-99999Lorsqu'un client est redirigé vers cette page, votre système devra extraire la valeur de
orderIddepuis l'URL. Vous utiliserez ensuiteorderIdpour appeler le point de terminaisonorderDetailet récupérer les données de la commande.Partie 2 : Utiliser une tâche planifiée
En plus d'appeler les détails de commande lorsque la page de succès est déclenchée, nous vous recommandons de configurer un appel planifié pour toutes les commandes et leurs détails, à titre de filet de sécurité. Ainsi, vous pourrez récupérer toute commande finalisée dans le système Zonos qui n'a pas encore été importée dans votre système.
Ce processus doit être une tâche / un script planifié, par exemple une tâche Cron, exécuté une fois par heure / quart / jour / etc. (planifiez aussi souvent que vos processus métier le jugent nécessaire). Le script doit récupérer toutes les commandes et leurs détails survenus depuis le dernier appel pour les commandes. Le point de terminaison
orderNumbersvous permet de récupérer les commandessinceOrderIdousinceDate, comme illustré dans l'interface de test API disponible ici. Toutes les commandes récupérées via cet appel planifié doivent ensuite être rapprochées des commandes insérées dans votre système à chaque fois que la page de succès a été déclenchée. Toute commande qui n'est pas déjà dans votre système doit y être insérée et traitée comme une commande légitime.Statut initial de la commande
IGLOBAL_ORDER_IN_PROCESSouIGLOBAL_FRAUD_REVIEWLors de l'appel au point de terminaison
orderDetail, nous recommandons que votre système vérifie d'abord la propriétéorderStatusdes données de commande.Les commandes qui ne nécessitent pas de vérification de fraude s'initialiseront avec
orderStatus:IGLOBAL_ORDER_IN_PROCESS. Une commande dans ce statut est prête à être traitée et expédiée.Les commandes qui nécessitent une vérification de fraude s'initialiseront avec
orderStatus:IGLOBAL_FRAUD_REVIEW. Une commande dans ce statut est actuellement contrôlée et examinée pour une fraude suspectée. Nous vous recommandons de placer cette commande en statut de révision ou de mise en attente dans votre système et de continuer à appeler le point de terminaisonorderDetailjusqu'à ce que la commande progresse au-delà du processus de vérification de fraude de Zonos.Une fois le processus de détection de fraude Zonos terminé, la commande passera à l'un des états suivants :
La commande passe la vérification de fraude
orderStatus:IGLOBAL_ORDER_IN_PROCESSet pourra continuer vers l'expédition.La commande échoue à la vérification de fraude
orderStatus:IGLOBAL_ORDER_CANCELLEDet doit être annulée dans votre système.Interface de test API
Veuillez contacter le support pour obtenir les identifiants de votre compte.
Cette page a-t-elle été utile?