Attribute
JSON-Schlüssel/Wert-Paare im Anforderungskörper
POST https://api.iglobalstores.com/v1/createTempCart
Feld | Hinweise |
---|---|
boxCount | Beispielwert: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Komma-separierte Liste von Feldabmessungen und Anzahl. Im obigen Beispiel gibt es insgesamt 4 Boxen. Die erste Box in der Liste ist 22 Zoll lang, 15 Zoll breit und 15 Zoll hoch. Es wird nur eine Box dieser Größe verwendet. Es gibt zwei Boxen der Größe: 8x8x4 Zoll. Es ist akzeptabel, dieselbe Feldabmessung mehrmals zu übergeben, wenn dies für Sie einfach ist, wie z.B. "22x15x15(1),22x15x15(1)", was bedeutet, dass 2 Boxen der Größe: 22x15x15 Zoll vorhanden sind. Dieses Feld beschreibt die Boxen, die zur Versendung der Bestellung verwendet werden. Es wird nicht erwartet, dass ein Händler dies zum Zeitpunkt der Bestellung weiß; jedoch, wenn es bekannt ist, kann es im string -Format übergeben werden. |
contShoppingURL | Dieses Feld wird verwendet, um eine URL zu übergeben, um den HREF des "Weiter einkaufen"-Buttons innerhalb des Zonos Checkout zu überschreiben. string |
domesticShippingCharge | Dieses Feld wird verwendet, um eine inländische Versandgebühr an den Zonos Checkout zu übergeben, und der Betrag wird zum Versand hinzugefügt. Dies kann konfiguriert werden, um den Gesamtversand hinzuzufügen oder als separate Position aufzuschlüsseln. positive Gleitkommazahl, zwei Dezimalstellen |
externalConfirmationPageURL | Dieses Feld wird verwendet, um eine URL Ihrer Bestellbestätigungs-/Dankeseite zu übergeben. Nachdem ein Kunde die Zahlung im Zonos Checkout abgeschlossen hat, wird er zu dieser URL zur Bestellbestätigung weitergeleitet. Diese URL wird häufig verwendet, um einen Aufruf an den Zonos "orderDetail" API-Service-Endpunkt auszulösen, um die Bestelldetails abzurufen und die Bestellung in das System zu importieren. string |
footerHTML | Dieses Feld wird verwendet, um eine URL-codierte HTML-Zeichenfolge zu übergeben. Diese HTML-Zeichenfolge wird dekodiert und vor dem schließenden Body-Tag auf der checkout-Seite platziert. Häufig verwendet, um Code für Remarketing, Analytik, etc. zu übergeben. URL-codierte Zeichenfolge |
items ERFORDERLICH | Dieses Feld ist eine Liste von Artikelzuordnungen. JSON-Zeichenfolge |
items[index].countryOfOrigin | Dieses Feld wird verwendet, um das Herkunftsland des Artikels zu übergeben. Der Parameter muss das Länderkürzel zweibuchstabiger ISO-Code sein. string |
items[index].description ERFORDERLICH | Dieses Feld wird verwendet, um eine vollständige Artikelbeschreibung der Warenkorbposition zu übergeben, einschließlich etwaiger Artikeloptionen, Farben, etc. string |
items[index].height | Dieses Feld wird verwendet, um die Höhe des Artikels zu übergeben und wird für genaue Versandangebote dringend empfohlen. Die Höheneinheiten sind ERFORDERLICH string - positive Gleitkommazahl, zwei Dezimalstellen / Ganzzahl (Zoll) |
items[index].imageURL ERFORDERLICH | Dieses Feld wird verwendet, um die URL zum Produktbild des Artikels zu übergeben. Die URL muss HTTPS sein, um im Zonos Checkout angezeigt zu werden. string / HTTPS-URL |
items[index]itemBrand | Dieses Feld wird verwendet, um die Marke des Artikels zu übergeben. string |
items[index]itemCategory | Dieses Feld wird verwendet, um die Artikelkategorie zu übergeben und kann durch Pipe getrennt übergeben werden, wenn der Artikel mehr als eine Kategorie hat. Beispielwerte: "Schuhe" oder "Schuhe|Sport-Schuhe|Rabatt-Schuhe" string |
items[index]itemCustomization | Dieses Feld wird verwendet, um zusätzliche Details über den Artikel zu übergeben, die nicht im Zonos Checkout angezeigt werden; diese können jedoch über den "orderDetail" API-Service-Endpunkt abgerufen werden. |
items[index]itemHSCode | Dieses Feld wird verwendet, um den HS-Code des Artikels zu übergeben und kann mit oder ohne Punkte übergeben werden. Beispielwerte: "3926901000" oder "3926.90.1000" string |
items[index].itemURL | Dieses Feld wird verwendet, um die URL zur Produktseite des Artikels zu übergeben. string / URL |
items[index].length | Dieses Feld wird verwendet, um die Länge des Artikels zu übergeben und wird für genaue Versandangebote dringend empfohlen. Längeneinheiten sind in Zoll ERFORDERLICH string - positive Dezimalzahl, zwei Dezimalstellen / Ganzzahl (Zoll) |
items[index].nonShippable | Dieses Feld wird verwendet, um anzuzeigen, ob der Artikel in die Versand-, Zoll- und Steuerberechnungen einbezogen werden soll. Digitale Downloads, Rabattcodes, Bearbeitungsgebühren usw. sollten mit dem Wert "true" übergeben werden. boolean: true oder false |
items[index].productId | Dieses Feld wird verwendet, um die Menge des Artikelposition zu übergeben. string |
items[index].quantity ERFORDERLICH | Dieses Feld wird verwendet, um die Menge des Artikelposition zu übergeben. string |
items[index].sku | Dieses Feld wird verwendet, um die Artikel-SKU / UPC / usw. zu übergeben. string |
items[index].unitPrice ERFORDERLICH | Dieses Feld wird verwendet, um den Einzelpreis des Artikelposition zu übergeben. positive Dezimalzahl, zwei Dezimalstellen / Ganzzahl |
items[index].weight | Dieses Feld wird verwendet, um das Gewicht des Artikels zu übergeben und wird für genaue Versandangebote dringend empfohlen. Gewichtseinheiten sind standardmäßig "LBS", es sei denn, eine andere Gewichtseinheit wird in items[index].itemWeightUnits übergeben. string - positive Dezimalzahl, zwei Dezimalstellen / Ganzzahl |
items[index].weightUnits | Dieses Feld wird verwendet, um die standardmäßigen Gewichtseinheiten des Artikels zu überschreiben. Die Gewichtseinheiten des Artikels sind standardmäßig "LBS", es sei denn, eine andere Gewichtseinheit wird in diesem Feld übergeben. string - "LB", "OZ", "KG" oder "G" |
items[index].width | Dieses Feld wird verwendet, um die Breite des Artikels zu übergeben und wird für genaue Versandangebote dringend empfohlen. Breiteneinheiten sind in Zoll ERFORDERLICH string - positive Dezimalzahl, zwei Dezimalstellen / Ganzzahl (Zoll) |
misc1 - misc6 | Dieses Feld wird verwendet, um verschiedene Daten, die mit der Bestellung verbunden sind, über die Zonos API zu übergeben, um zusammen mit den Bestelldaten abgerufen zu werden, die vom Zonos "orderDetail" API-Service-Endpunkt zurückgegeben werden. string |
referenceId | Dieses Feld wird verwendet, um einen eindeutigen Referenzidentifikationswert für den Warenkorb/die Sitzung/usw. in Ihrem System zu übergeben. Dies kann verwendet werden, um die Zonos Bestell-ID über den Zonos "orderDetail" API-Service-Endpunkt nachzuschlagen. string |
storeId ERFORDERLICH | Vom Zonos bereitgestellte Store-ID. integer |
Zusätzliche String-Datentypen
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Rabatte, Gutscheine und Aktionscodes
Um Rabatte, Gutscheine und Aktionscodes an Zonos über den Server-Post zu senden, müssen sie als separater Artikel mit einem negativen Wert für die Parameter: “unitPrice”
und “nonShippable”:true
übergeben werden.
BEISPIEL RABATT ARTIKEL MAP
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
HTTPS-Antwort
Erfolgreiche HTTP-Antwort
Nachrichtenformat: JSON
BEISPIEL ERFOLGSANTWORT
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Antwort JSON-Definitionen
Feld | Hinweise |
---|---|
tempCartUUID | Dieser Parameter enthält eine GUID, die dem internationalen Warenkorb Ihres Kunden im Zonos-System zugewiesen wurde. Dieses Feld wird als URL-Abfrageparameter übergeben, während der Benutzer auf die Weiterleitung zum Zonos Checkout wartet. |
Fehler HTTP-Antworten
Fehlercode | Bedeutung |
---|---|
400 | Unerwartetes Zeichen im Anforderungstext. |
406 | Nicht akzeptabel. Der HTTP-Header für "Accept" ist ungültig. |
415 | Nicht unterstützter Medientyp. Der HTTP-Header für "Content-Type" ist ungültig. |
422 | Nicht verarbeitbare Entität. |
500 | "storeId" war inkorrekt oder der JSON-Body konnte nicht geparst werden. |
BEISPIEL FEHLERANTWORT
<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>
Weiterleitung zum Zonos Checkout
Nach Erhalt einer erfolgreichen Antwort mit der tempCartUUID
sendet Ihr Server eine Weiterleitung vom Browser des Kunden zum Zonos Checkout mit den unten aufgeführten entsprechenden URL-Abfragezeichenfolgenparametern.
Beispiel-Weiterleitungs-URL: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Hinweis: [yourassignedsubdomain] - Kontaktieren Sie Ihr Mitglied des Zonos Implementierungsteams, um Ihre Zonos.com-Subdomain zu erhalten.
URL-Anforderungsparameter
Feld | Hinweise |
---|---|
tempCartUUID ERFORDERLICH | Dieser Wert wird durch Aufrufen des Zonos createTempCart API-Dienstendpunkts erhalten. string / GUID |
country | Zielland Zwei-Buchstaben-ISO-Code. Wir empfehlen dringend, diesen Parameter für die Benutzererfahrung zu übergeben. Der country -Parameter wird das Zielland im Zonos Checkout vorauswählen. Wenn Sie das Zonos Hello JS (JavaScript) auf der Website verwenden, können Sie diesen Wert durch Aufrufen der JavaScript-Methode zonos.country() erhalten. string (Länge: 2) |
Zusätzliche Zeichenfolgendatentypen
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Erstellen Sie einen checkout
Erkunden Sie die Schlüssel/Wert-Paare, die bei der Erstellung eines checkout involviert sind.
Dieser API-Endpunkt wird verwendet, um Warenkorbinformationen und Artikel aus dem Warenkorb des Kunden an die Zonos API zu senden.
Sie erhalten eine JSON-Antwort, die eine
tempCartUUID
enthält, eine eindeutige Warenkorbkennung im Zonos-System. Diese wird verwendet, um den Kunden zum Zonos Checkout weiterzuleiten, um die Bestellung abzuschließen.