Vue d'ensemble des paires clé-valeur lors de la création d'un Checkout.
Cet endpoint API envoie les informations du panier et les articles du panier client à l'API Zonos.
Vous recevez une réponse JSON contenant tempCartUUID, un identifiant de panier unique dans le système Zonos. Utilisez-le pour rediriger le client vers Zonos Checkout afin de 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 de dimensions de cartons et de quantités. Dans l'exemple ci-dessus, il y a 4 cartons au total. Le premier carton de la liste mesure 22 pouces de long, 15 pouces de large et 15 pouces de haut. Un seul carton de cette taille est utilisé. Il y a deux cartons de taille 8x8x4 pouces. Il est autorisé de transmettre plusieurs fois la même dimension de carton, par exemple « 22x15x15(1),22x15x15(1) » — cela signifie 2 cartons de taille 22x15x15 pouces. Ce champ décrit les cartons utilisés pour l'expédition de la commande. On ne s'attend pas à ce qu'un marchand le connaisse au moment de la commande ; s'il est connu, il peut être transmis au format string.
contShoppingURL
Ce champ transmet une URL pour remplacer le HREF du bouton « Continue Shopping » dans Zonos Checkout. string
domesticShippingCharge
Ce champ transmet des frais d'expédition nationaux à Zonos Checkout ; le montant est ajouté aux frais d'expédition. Configurable en frais d'expédition totaux ou en ligne distincte. positive floating point, two decimal places
externalConfirmationPageURL
Ce champ transmet l'URL de votre page de confirmation de commande ou de remerciement. Après le paiement dans Zonos Checkout, le client y est redirigé. Cette URL est souvent utilisée pour appeler l'endpoint API Zonos « orderDetail », récupérer les détails de la commande et l'importer. string
footerHTML
Ce champ transmet une chaîne HTML encodée en URL. Elle est décodée et insérée avant la balise body de fermeture de la page Checkout. Souvent utilisée pour le remarketing, l'analytique, etc. URL encoded string
Description complète de l'article du panier, y compris les options, couleurs, etc. string
items[index].height
Hauteur de l'article ; fortement recommandée pour des offres d'expédition précises. Unité de hauteur
REQUIRED
en pouces. string - positive floating point, two decimal places / integer (inches)
items[index].imageURL
REQUIRED
URL de l'image du produit. L'URL doit être en HTTPS pour s'afficher dans Zonos Checkout. string / HTTPS URL
items[index]itemBrand
Marque de l'article string
items[index]itemCategory
Catégorie de l'article ; si plusieurs catégories, les transmettre séparées par une barre verticale. Exemples de valeurs : « shoes » ou « shoes|sport-shoes|discount-shoes »string
items[index]itemCustomization
Détails supplémentaires de l'article non affichés dans Zonos Checkout ; récupérables via l'endpoint API « orderDetail ».
items[index]itemHSCode
Code HS de l'article, avec ou sans points. Exemples de valeurs : « 3926901000 » ou « 3926.90.1000 »string
items[index].itemURL
URL de la page produit. string / URL
items[index].length
Longueur de l'article ; fortement recommandée pour des offres d'expédition précises. Unité de longueur
REQUIRED
en pouces. string - positive floating point, two decimal places / integer (inches)
items[index].nonShippable
Indique si l'article est inclus dans les calculs d'expédition, de droits et de taxes. Téléchargements numériques, codes de réduction, frais de traitement, etc. doivent être transmis avec la valeur « true ». boolean: true or false
items[index].productId
ID produit de la ligne. string
items[index].quantity
REQUIRED
Quantité de la ligne. string
items[index].sku
SKU / UPC / etc. de l'article. string
items[index].unitPrice
REQUIRED
Prix unitaire de la ligne. positive floating point, two decimal places / integer
items[index].weight
Poids de l'article ; fortement recommandé pour des offres d'expédition précises. Unité de poids par défaut « LBS », sauf indication contraire dans items[index].itemWeightUnits.string - positive floating point, two decimal places / integer
items[index].weightUnits
Remplace l'unité de poids par défaut. Par défaut « LBS », sauf indication contraire ici. string - "LB", "OZ", "KG", or "G”
items[index].width
Largeur de l'article ; fortement recommandée pour des offres d'expédition précises. Unité de largeur
REQUIRED
en pouces. string - positive floating point, two decimal places / integer (inches)
misc1 - misc6
Diverses données de commande via l'API Zonos ; récupérables avec les données de commande renvoyées par « orderDetail ». string
referenceId
ID de référence unique pour le panier, la session, etc. dans votre système. Permet de retrouver l'ID de commande Zonos via « orderDetail ». string
Les remises, bons et codes promo doivent être transmis comme article distinct avec une valeur négative pour unitPrice et nonShippable: true dans le POST serveur.
Contient un GUID pour le panier international du client dans le système Zonos. Transmis comme paramètre de requête URL string lors de la redirection du navigateur 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é non traitable.
500
« storeId » incorrect ou corps JSON impossible à analyser.
Après une réponse réussie contenant tempCartUUID, votre serveur redirige le navigateur du client vers Zonos Checkout avec les paramètres de requête URL décrits ci-dessous.
Exemple d'URL de redirection : https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Remarque : [yourassignedsubdomain] — Contactez votre équipe d'implémentation Zonos pour obtenir votre sous-domaine Zonos.com.
Paramètres de requête URL
Champ↕
Remarques↕
tempCartUUID
REQUIRED
Valeur renvoyée par l'endpoint API Zonos createTempCart. string / GUID
country
Code pays ISO à deux lettres du pays de destination. Nous recommandons fortement ce paramètre pour l'expérience utilisateur. country présélectionne le pays de destination dans Zonos Checkout. Avec Zonos Hello JS sur le site, vous obtenez la valeur via zonos.country(). string (Length: 2)
Créer un Checkout
Créer un Checkout
Vue d'ensemble des paires clé-valeur lors de la création d'un Checkout.
Cet endpoint API envoie les informations du panier et les articles du panier client à l'API Zonos.
Vous recevez une réponse JSON contenant
tempCartUUID, un identifiant de panier unique dans le système Zonos. Utilisez-le pour rediriger le client vers Zonos Checkout afin de 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 de dimensions de cartons et de quantités. Dans l'exemple ci-dessus, il y a 4 cartons au total. Le premier carton de la liste mesure 22 pouces de long, 15 pouces de large et 15 pouces de haut. Un seul carton de cette taille est utilisé. Il y a deux cartons de taille 8x8x4 pouces. Il est autorisé de transmettre plusieurs fois la même dimension de carton, par exemple « 22x15x15(1),22x15x15(1) » — cela signifie 2 cartons de taille 22x15x15 pouces. Ce champ décrit les cartons utilisés pour l'expédition de la commande. On ne s'attend pas à ce qu'un marchand le connaisse au moment de la commande ; s'il est connu, il peut être transmis 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].itemMaterialRemises, bons et codes promo
Les remises, bons et codes promo doivent être transmis comme article distinct avec une valeur négative pour
unitPriceetnonShippable: true dans le POST serveur.{"description": "Discount (10OFF) - 10% OFF","unitPrice": -15.5,"quantity": 1,"nonShippable": true}Réponse HTTPS
Réponse HTTP réussie
Format du message : JSON
{"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"}Définitions du JSON de réponse
tempCartUUIDstringlors de la redirection du navigateur 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 une réponse réussie contenant
tempCartUUID, votre serveur redirige le navigateur du client vers Zonos Checkout avec les paramètres de requête URL décrits ci-dessous.Paramètres de requête URL
tempCartUUIDREQUIRED
createTempCart.string / GUIDcountrycountryprésélectionne le pays de destination dans Zonos Checkout. Avec Zonos Hello JS sur le site, vous obtenez la valeur viazonos.country().string(Length: 2)Types de données string supplémentaires
customerNamecustomerCompanycustomerEmailcustomerPhonecustomerAltPhonecustomerAddress1customerAddress2customerCitycustomerStatecustomerZipCette page a-t-elle été utile?