Découvrez les paires clé-valeur utilisées pour créer un checkout.
Ce point de terminaison API sert à envoyer les informations du panier et les articles du panier du client à l'API Zonos.
Vous recevrez une réponse JSON contenant un tempCartUUID, un identifiant de panier unique dans le système Zonos. Celui-ci servira à rediriger le client vers Zonos Checkout pour finaliser la commande.
Paires clé-valeur JSON dans le corps de la requête
POST https://api.iglobalstores.com/v1/createTempCart
champ↕
remarques↕
boxCount
Exemple de valeur : 22x15x15(1),8x8x4(2),32x22x14(1) Format : liste, séparée par des virgules, des dimensions des boîtes et de leur nombre. Dans l'exemple ci-dessus, il y a 4 boîtes au total. La première boîte de la liste mesure 22 pouces de long sur 15 pouces de large et 15 pouces de haut. Une seule boîte de cette taille sera utilisée. Il y aura deux boîtes de 8x8x4 pouces. Vous pouvez transmettre plusieurs fois les mêmes dimensions de boîte si cela vous est plus simple, comme ceci : « 22x15x15(1),22x15x15(1) », ce qui correspond à 2 boîtes de 22x15x15 pouces. Ce champ décrit les boîtes qui serviront à expédier la commande. On ne s'attend pas à ce que le marchand connaisse cette information au moment de la commande; toutefois, si elle est connue, elle peut être transmise au format string.
contShoppingURL
Ce champ sert à transmettre une URL qui remplace le HREF du bouton « Continuer le magasinage » dans Zonos Checkout. string
domesticShippingCharge
Ce champ sert à transmettre des frais d'expédition intérieurs à Zonos Checkout; le montant sera ajouté à l'expédition. Il peut être configuré pour s'ajouter au total de l'expédition ou pour figurer comme poste distinct. positive floating point, two decimal places
externalConfirmationPageURL
Ce champ sert à transmettre l'URL de votre page de confirmation de commande ou de remerciement. Une fois le paiement effectué dans Zonos Checkout, le client sera redirigé vers cette URL pour la confirmation de la commande. Cette URL sert souvent à déclencher un appel au point de terminaison API Zonos « orderDetail » afin de récupérer le détail de la commande et d'importer la commande dans le système. string
footerHTML
Ce champ sert à transmettre une chaîne HTML encodée en URL. Cette chaîne HTML sera décodée et placée avant la balise body de fermeture sur la page de paiement. Il sert couramment à transmettre du code de reciblage, d'analytique, etc. URL encoded string
items
REQUIRED
Ce champ est une liste de maps d'articles. JSON string
items[index].countryOfOrigin
Ce champ sert à transmettre le pays d'origine de l'article. Le paramètre doit être le code ISO à deux lettres du pays. string
items[index].description
REQUIRED
Ce champ sert à transmettre la description complète de l'article de la ligne du panier, y compris ses options, couleurs, etc. string
items[index].height
Ce champ sert à transmettre la hauteur de l'article et est fortement recommandé pour obtenir des soumissions d'expédition précises. La hauteur est
REQUIRED
en pouces. string - positive floating point, two decimal places / integer (inches)
items[index].imageURL
REQUIRED
Ce champ sert à transmettre l'URL de l'image du produit. L'URL doit être en HTTPS pour s'afficher dans Zonos Checkout. string / HTTPS URL
items[index]itemBrand
Ce champ sert à transmettre la marque de l'articlestring
items[index]itemCategory
Ce champ sert à transmettre la catégorie de l'article; les catégories peuvent être séparées par une barre verticale si l'article en a plusieurs. Exemples de valeurs : « shoes » ou « shoes|sport-shoes|discount-shoes »string
items[index]itemCustomization
Ce champ sert à transmettre des détails supplémentaires sur l'article qui ne s'affichent pas dans Zonos Checkout; ils peuvent toutefois être récupérés au moyen du point de terminaison API « orderDetail ».
items[index]itemHSCode
Ce champ sert à transmettre le code SH de l'article, avec ou sans points. Exemples de valeurs : « 3926901000 » ou « 3926.90.1000 »string
items[index].itemURL
Ce champ sert à transmettre l'URL de la page du produit. string / URL
items[index].length
Ce champ sert à transmettre la longueur de l'article et est fortement recommandé pour obtenir des soumissions d'expédition précises. La longueur est
REQUIRED
en pouces. string - positive floating point, two decimal places / integer (inches)
items[index].nonShippable
Ce champ sert à indiquer si l'article doit être inclus dans le calcul de l'expédition, des droits et des taxes. Les téléchargements numériques, codes de réduction, frais de manutention, etc. doivent être transmis avec la valeur « true ». boolean: true or false
items[index].productId
Ce champ sert à transmettre la quantité de la ligne. string
items[index].quantity
REQUIRED
Ce champ sert à transmettre la quantité de la ligne. string
items[index].sku
Ce champ sert à transmettre le SKU, l'UPC, etc. de l'article. string
items[index].unitPrice
REQUIRED
Ce champ sert à transmettre le prix unitaire de la ligne. positive floating point, two decimal places / integer
items[index].weight
Ce champ sert à transmettre le poids de l'article et est fortement recommandé pour obtenir des soumissions d'expédition précises. L'unité de poids par défaut est « LBS », à moins qu'une autre unité ne soit transmise dans items[index].itemWeightUnits``string - positive floating point, two decimal places / integer
items[index].weightUnits
Ce champ sert à remplacer l'unité de poids par défaut de l'article. L'unité de poids par défaut est « LBS », à moins qu'une autre unité ne soit transmise dans ce champ. string - "LB", "OZ", "KG", or "G”
items[index].width
Ce champ sert à transmettre la largeur de l'article et est fortement recommandé pour obtenir des soumissions d'expédition précises. La largeur est
REQUIRED
en pouces. string - positive floating point, two decimal places / integer (inches)
misc1 - misc6
Ce champ sert à transmettre, au moyen de l'API Zonos, diverses données associées à la commande, qui peuvent être récupérées avec les données de commande renvoyées par le point de terminaison API Zonos « orderDetail ». string
referenceId
Ce champ sert à transmettre une valeur d'identification de référence unique pour le panier, la session, etc. dans votre système. Elle permet de retrouver l'ID de commande Zonos au moyen du point de terminaison API Zonos « orderDetail ». string
Pour envoyer des rabais, coupons et codes promotionnels à Zonos au moyen du POST serveur, vous devez les transmettre comme un article distinct avec une valeur négative pour les paramètres “unitPrice” et “nonShippable”:true.
Ce paramètre contiendra un GUID attribué au panier international de votre client et créé dans le système Zonos. Ce champ sera transmis comme paramètre string de chaîne de requête d'URL lors de la redirection du navigateur de l'utilisateur vers Zonos Checkout.
Réponses HTTP d'erreur
Code d'erreur↕
signification↕
400
Caractère inattendu dans le corps de la requête.
406
Non acceptable. L'en-tête HTTP « Accept » n'est pas valide.
415
Type de média non pris en charge. L'en-tête HTTP « Content-Type » n'est pas valide.
422
Entité impossible à traiter.
500
Le « storeId » était incorrect ou le corps JSON n'a pas pu être analysé.
Après avoir reçu une réponse de réussite contenant le tempCartUUID, votre serveur redirigera le navigateur du client vers Zonos Checkout avec les paramètres de chaîne de requête d'URL appropriés, décrits ci-dessous.
Exemple d'URL de redirection : https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Remarque : [yourassignedsubdomain] - Communiquez avec le membre de votre équipe d'implantation Zonos pour obtenir votre sous-domaine Zonos.com.
Paramètres de requête d'URL
champ↕
remarques↕
tempCartUUID
REQUIRED
Cette valeur est obtenue en appelant le point de terminaison API Zonos createTempCart. string / GUID
country
Code ISO à deux lettres du pays de destination. Nous recommandons fortement de transmettre ce paramètre pour l'expérience utilisateur. Le paramètre country présélectionnera le pays de destination dans Zonos Checkout. Si vous utilisez Zonos Hello JS (JavaScript) sur le site, vous pouvez obtenir cette valeur en appelant la méthode JavaScript zonos.country(). string (longueur : 2)
Créer un checkout
Créer un checkout
Découvrez les paires clé-valeur utilisées pour créer un checkout.
Ce point de terminaison API sert à envoyer les informations du panier et les articles du panier du client à l'API Zonos.
Vous recevrez une réponse JSON contenant un
tempCartUUID, un identifiant de panier unique dans le système Zonos. Celui-ci servira à rediriger le client vers Zonos Checkout pour finaliser la commande.Attributs
Paires clé-valeur JSON dans le corps de la requête
POST
https://api.iglobalstores.com/v1/createTempCartboxCountFormat : liste, séparée par des virgules, des dimensions des boîtes et de leur nombre. Dans l'exemple ci-dessus, il y a 4 boîtes au total. La première boîte de la liste mesure 22 pouces de long sur 15 pouces de large et 15 pouces de haut. Une seule boîte de cette taille sera utilisée. Il y aura deux boîtes de 8x8x4 pouces. Vous pouvez transmettre plusieurs fois les mêmes dimensions de boîte si cela vous est plus simple, comme ceci : « 22x15x15(1),22x15x15(1) », ce qui correspond à 2 boîtes de 22x15x15 pouces. Ce champ décrit les boîtes qui serviront à expédier la commande. On ne s'attend pas à ce que le marchand connaisse cette information au moment de la commande; toutefois, si elle est connue, elle peut être transmise au format
string.contShoppingURLstringdomesticShippingChargepositive floating point, two decimal placesexternalConfirmationPageURLstringfooterHTMLURL encoded stringitemsREQUIRED
JSON stringitems[index].countryOfOriginstringitems[index].descriptionREQUIRED
stringitems[index].heightREQUIRED
string - positive floating point, two decimal places / integer (inches)items[index].imageURLREQUIRED
string / HTTPS URLitems[index]itemBrandstringitems[index]itemCategoryExemples de valeurs : « shoes » ou « shoes|sport-shoes|discount-shoes »
stringitems[index]itemCustomizationitems[index]itemHSCodeExemples de valeurs : « 3926901000 » ou « 3926.90.1000 »
stringitems[index].itemURLstring / URLitems[index].lengthREQUIRED
string - positive floating point, two decimal places / integer (inches)items[index].nonShippableboolean: true or falseitems[index].productIdstringitems[index].quantityREQUIRED
stringitems[index].skustringitems[index].unitPriceREQUIRED
positive floating point, two decimal places / integeritems[index].weightitems[index].itemWeightUnits``string - positive floating point, two decimal places / integeritems[index].weightUnitsstring - "LB", "OZ", "KG", or "G”items[index].widthREQUIRED
string - positive floating point, two decimal places / integer (inches)misc1 - misc6stringreferenceIdstringstoreIdREQUIRED
integerTypes de données string supplémentaires
items[index].itemDescriptionLongitems[index].itemDescriptionDetaileditems[index].itemFabricContentitems[index].itemColoritems[index].itemLtlClassitems[index].statusitems[index].itemMaterialRabais, coupons et codes promotionnels
Pour envoyer des rabais, coupons et codes promotionnels à Zonos au moyen du POST serveur, vous devez les transmettre comme un article distinct avec une valeur négative pour les paramètres
“unitPrice”et“nonShippable”:true.{"description": "Discount (10OFF) - 10% OFF","unitPrice": -15.5,"quantity": 1,"nonShippable": true}Réponse HTTPS
Réponse HTTP de réussite
Format du message : JSON
{"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"}Définitions JSON de la réponse
tempCartUUIDstringde chaîne de requête d'URL lors de la redirection du navigateur de l'utilisateur vers Zonos Checkout.Réponses HTTP d'erreur
HTTP ERROR 422
Problem accessing /v2/createTempCart. Reason:The request entity had the following errors:
Redirection vers Zonos Checkout
Après avoir reçu une réponse de réussite contenant le
tempCartUUID, votre serveur redirigera le navigateur du client vers Zonos Checkout avec les paramètres de chaîne de requête d'URL appropriés, décrits ci-dessous.Paramètres de requête d'URL
tempCartUUIDREQUIRED
createTempCart.string / GUIDcountrycountryprésélectionnera le pays de destination dans Zonos Checkout. Si vous utilisez Zonos Hello JS (JavaScript) sur le site, vous pouvez obtenir cette valeur en appelant la méthode JavaScriptzonos.country().string(longueur : 2)Types de données string supplémentaires
customerNamecustomerCompanycustomerEmailcustomerPhonecustomerAltPhonecustomerAddress1customerAddress2customerCitycustomerStatecustomerZipCette page vous a-t-elle été utile?