Attributs
Paires clé/valeur JSON dans le corps de la requête
POST https://api.iglobalstores.com/v1/createTempCart
champ | notes |
---|---|
boxCount | Valeur d'exemple: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Liste séparée par des virgules des dimensions des boîtes et du nombre. Dans l'exemple ci-dessus, il y a un total de 4 boîtes. La première boîte de la liste fera 22 pouces de long, 15 pouces de large et 15 pouces de haut. Il n'y aura qu'une seule boîte utilisée pour cette taille. Il y aura deux boîtes de taille : 8x8x4 pouces. Il est acceptable de passer la même dimension de boîte plusieurs fois si c'est plus facile pour vous, comme ceci : "22x15x15(1),22x15x15(1)", ce qui signifie 2 boîtes de taille : 22x15x15 pouces. Ce champ décrit les boîtes qui seront utilisées pour expédier la commande. Il n'est pas attendu qu'un commerçant le sache au moment de la commande ; cependant, s'il est connu, il peut être transmis au format string . |
contShoppingURL | Ce champ est utilisé pour transmettre une URL pour remplacer le lien du bouton "Continuer vos achats" à l'intérieur du Zonos Checkout. string |
domesticShippingCharge | Ce champ est utilisé pour transmettre un frais de livraison domestique au Zonos Checkout, et le montant sera ajouté aux frais de livraison. Cela peut être configuré pour ajouter le total des frais de livraison ou être décomposé en tant que ligne distincte. nombre flottant positif, deux décimales |
externalConfirmationPageURL | Ce champ est utilisé pour transmettre une URL de votre page de confirmation de commande / de remerciement. Après qu'un client ait effectué le paiement à l'intérieur du Zonos Checkout, il sera redirigé vers cette URL pour la confirmation de la commande. Cette URL est fréquemment utilisée pour déclencher un appel au point de terminaison du service API "orderDetail" de Zonos pour récupérer les détails de la commande et importer la commande dans le système. string |
footerHTML | Ce champ est utilisé pour transmettre une chaîne HTML encodée en URL. Cette chaîne HTML sera décodée et placée avant la balise de fermeture du corps sur la page de checkout. Communément utilisé pour transmettre du code pour le remarketing, les analyses, etc. chaîne encodée en URL |
items OBLIGATOIRE | Ce champ est une liste de cartes d'articles. chaîne JSON |
items[index].countryOfOrigin | Ce champ est utilisé pour transmettre le pays d'origine de l'article. Le paramètre doit être le pays code ISO à deux lettres. string |
items[index].description OBLIGATOIRE | Ce champ est utilisé pour transmettre une description complète de l'article de la ligne du panier, y compris toutes les options d'article, couleurs, etc. string |
items[index].height | Ce champ est utilisé pour transmettre la hauteur de l'article et est fortement recommandé pour des devis de livraison précis. Les unités de hauteur sont OBLIGATOIRES chaîne - nombre flottant positif, deux décimales / entier (pouces) |
items[index].imageURL OBLIGATOIRE | Ce champ est utilisé pour transmettre l'URL de l'image du produit de l'article. L'URL doit être HTTPS pour s'afficher à l'intérieur du Zonos Checkout. string / URL HTTPS |
items[index]itemBrand | Ce champ est utilisé pour transmettre la marque de l'articlestring |
items[index]itemCategory | Ce champ est utilisé pour transmettre la catégorie de l'article et peut être transmis avec des délimiteurs de barre verticale s'il y a plus d'une catégorie pour l'article. Exemples de valeurs: "chaussures" ou "chaussures|chaussures-de-sport|chaussures-en-solde" chaîne de caractères |
items[index]itemCustomization | Ce champ est utilisé pour transmettre des détails supplémentaires sur l'article qui ne sont pas affichés dans le Zonos Checkout; cependant, cela peut être récupéré via le point de terminaison du service API "orderDetail". |
items[index]itemHSCode | Ce champ est utilisé pour transmettre le code HS de l'article et peut être avec ou sans points. Exemples de valeurs: "3926901000" ou "3926.90.1000" chaîne de caractères |
items[index].itemURL | Ce champ est utilisé pour transmettre l'URL vers la page produit de l'article. chaîne de caractères / URL |
items[index].length | Ce champ est utilisé pour transmettre la longueur de l'article et est fortement recommandé pour des devis d'expédition précis. Les unités de longueur sont REQUISES chaîne de caractères - nombre flottant positif, deux décimales / entier (pouces) |
items[index].nonShippable | Ce champ est utilisé pour indiquer si l'article doit être inclus dans les calculs d'expédition, de droits et de taxes. Les téléchargements numériques, les codes de réduction, les frais de manutention, etc. doivent être transmis avec une valeur de "true". booléen: true ou false |
items[index].productId | Ce champ est utilisé pour transmettre la quantité de l'article. chaîne de caractères |
items[index].quantity REQUISE | Ce champ est utilisé pour transmettre la quantité de l'article. chaîne de caractères |
items[index].sku | Ce champ est utilisé pour transmettre le SKU / UPC / etc. de l'article. chaîne de caractères |
items[index].unitPrice REQUISE | Ce champ est utilisé pour transmettre le prix unitaire de l'article. nombre flottant positif, deux décimales / entier |
items[index].weight | Ce champ est utilisé pour transmettre le poids de l'article et est fortement recommandé pour des devis d'expédition précis. Les unités de poids sont par défaut en "LBS" sauf si une autre unité de poids est transmise dans items[index].itemWeightUnits``chaîne de caractères - nombre flottant positif, deux décimales / entier |
items[index].weightUnits | Ce champ est utilisé pour remplacer les unités de poids par défaut de l'article. Les unités de poids des articles sont par défaut en "LBS" sauf si une autre unité de poids est transmise dans ce champ. chaîne de caractères - "LB", "OZ", "KG" ou "G” |
items[index].width | Ce champ est utilisé pour transmettre la largeur de l'article et est fortement recommandé pour des devis d'expédition précis. Les unités de largeur sont REQUISES chaîne de caractères - nombre flottant positif, deux décimales / entier (pouces) |
misc1 - misc6 | Ce champ est utilisé pour transmettre des données diverses associées à la commande via l'API Zonos pour être récupérées avec les données de commande renvoyées par le point de terminaison du service API "orderDetail" de Zonos. chaîne de caractères |
referenceId | Ce champ est utilisé pour transmettre une valeur d'identification de référence unique pour le panier/session/etc. dans votre système. Cela peut être utilisé pour rechercher l'ID de commande Zonos via le point de terminaison du service API "orderDetail" de Zonos. chaîne de caractères |
storeId REQUIS | Identifiant de magasin fourni par Zonos. entier |
Types de données de chaîne supplémentaires
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Réductions, coupons et codes promotionnels
Pour envoyer des réductions, des coupons et des codes promotionnels à Zonos via le serveur post, ils doivent être transmis en tant qu'article séparé avec une valeur négative pour les paramètres: “unitPrice”
et “nonShippable”:true
.
EXEMPLE DE CARTE D'ARTICLE DE RÉDUCTION
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
Réponse HTTPS
Réponse HTTP réussie
Format du message: JSON
EXEMPLE DE RÉPONSE RÉUSSIE
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Définitions JSON de réponse
champ | notes |
---|---|
tempCartUUID | Ce paramètre contiendra un GUID attribué au panier international de votre client et créé dans le système Zonos. Ce champ sera transmis via un paramètre de chaîne de requête d'URL lors de la redirection du navigateur de l'utilisateur vers le Zonos Checkout. |
Réponses d'erreur HTTP
Code d'erreur | signification |
---|---|
400 | Caractère inattendu dans le corps de la requête. |
406 | Non acceptable. L'en-tête HTTP pour "Accept" n'est pas valide. |
415 | Type de média non supporté. L'en-tête HTTP pour "Content-Type" n'est pas valide. |
422 | Entité non traitable. |
500 | "storeId" était incorrect ou le corps JSON n'a pas pu être analysé. |
EXEMPLE DE RÉPONSE D'ERREUR
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Error 422 Unprocessable Entity</title>
</head>
<body>
<h2>HTTP ERROR 422</h2>
<p>
Problem accessing /v2/createTempCart. Reason:
<pre>Unprocessable Entity</pre>
</p>
<h2>The request entity had the following errors:</h2>
<ul>
<li>items may not be empty (was null)</li>
<li>items may not be null (was null)</li>
</ul>
</body>
</html>
Redirection vers le Zonos Checkout
Après avoir reçu une réponse réussie contenant le tempCartUUID
, votre serveur enverra une redirection du navigateur du client vers le Zonos Checkout avec les paramètres de chaîne de requête d'URL appropriés couverts ci-dessous.
Exemple d'URL de redirection: https://[votresous-domaineassigné].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Remarque: [votresous-domaineassigné] - Contactez votre membre de l'équipe de mise en œuvre de Zonos pour recevoir votre sous-domaine Zonos.com.
Paramètres de requête d'URL
champ | notes |
---|---|
tempCartUUID OBLIGATOIRE | Cette valeur est obtenue en appelant le point de terminaison du service API createTempCart de Zonos. chaîne / GUID |
country | Code ISO à deux lettres du pays de destination. Nous recommandons vivement de passer ce paramètre pour l'expérience utilisateur. Le paramètre country pré-sélectionnera le pays de destination à l'intérieur du Zonos Checkout. Lors de l'utilisation de Zonos Hello JS (JavaScript) sur le site, vous pouvez obtenir cette valeur en appelant la méthode JavaScript : zonos.country() . chaîne (Longueur : 2) |
Types de données de chaîne supplémentaires
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Créer un checkout
Explorez les paires clé/valeur impliquées dans la création d'un checkout.
Ce point de terminaison API est utilisé pour envoyer les informations du panier et les articles du panier du client vers l'API de Zonos.
Vous recevrez une réponse JSON contenant un
tempCartUUID
, un identifiant de panier unique dans le système de Zonos. Cela sera utilisé pour rediriger le client vers le Zonos Checkout pour finaliser la commande.