DOCS

Retrieve an order

/

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 de l'API "Récupérer une commande" est utilisé pour récupérer les données d'une commande terminée dans le système Zonos. La réponse contiendra un objet JSON représentant toutes les informations disponibles pour la commande, y compris les adresses de facturation et de livraison, le mode de livraison, les totaux de la commande et son statut.

Points de terminaison 

Numéros de commande

Récupère une liste de numéros de commande.

Détails de la commande

Récupère des informations détaillées sur une commande.

Utilisation du point de terminaison de l'API de récupération de commande

Il existe deux façons courantes d'utiliser ces points de terminaison.

  1. (Partie 1 + Partie 2) - Utilisez une page de confirmation de commande personnalisée/succès sur votre domaine pour déclencher l'appel de votre système au point de terminaison orderDetail et importer une commande terminée. De plus, appelez régulièrement le point de terminaison orderNumbers pour concilier les commandes dans le système Zonos non importées dans votre système.
  2. (Partie 2 uniquement) - Utilisez la page de confirmation de commande/succès de base de Zonos ou une page statique sur votre domaine pour indiquer la finalisation de la commande au client. Programmez votre système pour appeler régulièrement le point de terminaison orderNumbers pour 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 les données de ces commandes.

Partie 1: Page de succès sur votre domaine

Chaque fois qu'un acheteur finalise une commande dans le Zonos Checkout, il est immédiatement redirigé vers une URL de page de succès de commande. L'identifiant de commande terminée sera 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.

Exemple: http://www.examplestore.com/internationalThankYou?orderId=999-99999

Lorsqu'un client est redirigé vers cette page, votre système devra analyser la valeur de orderId dans l'URL. Vous utiliserez ensuite orderId pour appeler le point de terminaison orderDetail afin de récupérer les données de la commande.

Partie 2: Utilisation d'une tâche planifiée

En plus d'appeler les détails de la commande lorsque la page de succès est déclenchée, nous vous recommandons de mettre en place un appel planifié pour toutes les commandes et leurs détails en tant que solution de secours. De cette manière, vous pouvez récupérer toutes les commandes terminées dans le système Zonos qui n'ont pas encore été importées dans votre système.

Ce processus devrait être une tâche planifiée/script, comme une tâche Cron, exécutée une fois par heure/shift/jour, etc. (planifiez aussi souvent que vos processus commerciaux l'exigent). Le script devrait appeler toutes les commandes et leurs détails qui se sont produites depuis le dernier appel aux commandes. Le point de terminaison orderNumbers vous permet de récupérer les commandes sinceOrderId ou sinceDate comme démontré sur l'interface graphique de test API située ici. Toutes les commandes récupérées via cet appel planifié devraient ensuite être conciliées avec les commandes insérées dans votre système à chaque fois que la page de succès était déclenchée. Toutes les commandes non encore dans votre système devraient être insérées dans votre système et traitées comme des commandes légitimes.

Statut initial de la commande

IGLOBAL_ORDER_IN_PROCESS ou IGLOBAL_FRAUD_REVIEW

Lors de l'appel du point de terminaison orderDetail, nous vous recommandons que votre système vérifie d'abord la propriété orderStatus des données de la 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 examinée et vérifiée pour fraude présumée. Nous vous recommandons de placer cette commande en statut de révision ou en attente dans votre système et de continuer à appeler le point de terminaison orderDetail jusqu'à ce que la commande dépasse le processus de vérification de fraude de Zonos.

Une fois le processus de vérification de fraude de 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 devrait être annulée dans votre système.

Interface graphique de test API

Veuillez contacter le support pour obtenir vos identifiants de compte.

Cette page était-elle utile?


Des questions ?

Contactez-nous.