Points de terminaison
Demander les détails de la commande complétée
POST | https://api.iglobalstores.com/2.0/order-completed
- Crée une nouvelle demande d'informations liées à une commande complétée.
Requête HTTPS
Champ | Remarques |
---|---|
Méthode HTTP | POST |
URL du point de terminaison | https://api.iglobalstores.com/2.0/order-completed |
Protocole | HTTPS |
Format du message | JSON |
En-tête HTTP Accept | Accepter : application/json |
En-tête HTTP du jeton de sécurité | serviceToken : valeur-de-votre-jeton-de-testAjoutez un en-tête à votre requête HTTPS nommé serviceToken avec une valeur de votre jeton API de sécurité de test. (Contactez votre gestionnaire de compte pour ce jeton.) |
En-tête HTTP Content-Type | Content-Type : application/jsonParce que vous allez poster des données JSON au service, ajoutez un en-tête à votre requête HTTPS nommé Content-Type avec une valeur de application/json |
Paires clé/valeur JSON dans le corps de la requête
Format du message : JSON
Exemple de requête
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Définitions JSON de la demande
Champ | Remarques |
---|---|
billingAddress REQUIS | Il s'agit de l'adresse de facturation de la commande. Il s'agit d'une carte contenant les champs d'adresse suivants : address1 , address2 , address3 , city , state , stateCode , postalCode et countryCode . Ces champs contenus sont soit requis, soit non requis en fonction du pays. Le point de terminaison de localisation indique quels champs d'adresse spécifiques sont requis ou non pour chaque pays. Remarque : stateCode n'est jamais requis et n'est pas déclaré dans le point de terminaison de localisation. Vous pouvez transmettre stateCode , s'il est disponible. |
billingCompany OPTIONNEL | Il s'agit du nom de l'entreprise de facturation de la commande. |
billingEmail REQUIS | Il s'agit de l'adresse e-mail de facturation de la commande. |
billingName REQUIS | Il s'agit du nom complet de facturation de la commande. |
billingPhone REQUIS | Il s'agit du numéro de téléphone de facturation de la commande. |
items[index].orderGrandTotal REQUIS | Il s'agit du total payé par l'acheteur pour sa commande en USD (dollars américains). Veuillez fournir sans virgules, sans le signe dollar "$" et avec deux décimales. Exemple de valeur : 2102.99 |
items[index].orderNumber REQUIS | Il s'agit de votre numéro de commande pour la commande nouvellement terminée. Exemple de valeur : 854725421 |
paymentTypeCode REQUIS | La méthode de paiement utilisée par l'acheteur pour payer sa commande. Exemples de valeurs : PayPal ou Visa ou MC ou AMEX ou DISC |
prepaidDutyTax REQUIS | L'acheteur a-t-il choisi de prepay ses droits de douane et taxes à l'importation ou a-t-il été contraint de les prepay ? Si oui, définissez sur vrai ; sinon, définissez sur faux. Exemples de valeurs : vrai ou faux |
shippingQuoteId REQUIS | Il s'agit de l'identifiant du devis d'expédition choisi par l'acheteur. Les détails du panier doivent être les mêmes qu'ils l'étaient lorsque les devis d'expédition ont été récupérés. Si les détails du panier ont changé, vous auriez dû demander de nouveaux devis d'expédition avant de finaliser la commande de l'acheteur. |
shipToCompany OPTIONNEL | Il s'agit du nom de l'entreprise de la personne qui recevra la commande expédiée. |
shipToEmail REQUIS | Il s'agit de l'adresse e-mail de la personne qui recevra la commande expédiée. |
shipToName REQUIS | Il s'agit du nom complet de la personne qui recevra la commande expédiée. |
shipToPhone REQUIS | Il s'agit du numéro de téléphone de la personne qui recevra la commande expédiée. |
Réponse HTTPS
Format du message : JSON
Exemple de réponse pour le Canada et l'Australie uniquement
Remarque : Les réponses réelles contiendront tous les pays pris en charge.
Exemple de réponse
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Définitions JSON de réponse
Champ | Notes |
---|---|
deniedParty | Il s'agit d'une carte des résultats de vérification des parties refusées. Si défini sur null, alors la vérification des parties refusées n'a pas été effectuée. Contactez votre représentant Zonos si vous rencontrez cela. |
deniedParty.flagged | Indique si cette commande a correspondu à un enregistrement dans les listes consolidées des parties refusées de Zonos. Si vrai, veuillez revoir cette commande avant de la traiter. En cas de doute, ne traitez pas une commande qui est marquée comme vraie. Exemples de valeurs : vrai ou faux |
deniedParty.source | Si le champ flagged a été défini sur vrai, ce champ contiendra des références sources utiles pour examiner pourquoi la commande a été marquée comme correspondant à une partie refusée. |
igOrderId | Identifiant Zonos pour la commande nouvellement complétée. Exemple de valeur : e55a4efc-e615-49af-b3a4-afcda87e9e5e |
API Legacy Order Completed
Découvrez le fonctionnement de l'ancienne API Order Complete.
Le point de terminaison Order Completed accepte les détails finaux de la commande du client, vérifie les détails de la commande pour les parties refusées, et renvoie les résultats ainsi qu'un ID de commande spécifique à Zonos.