Attribut
JSON nyckel/värde-par i begärningskroppen
POST https://api.iglobalstores.com/v1/createTempCart
fält | anteckningar |
---|---|
boxCount | Exempelvärde: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Komma-separerad lista över boxdimensioner och antal. I exemplet ovan finns det totalt 4 lådor. Den första lådan i listan kommer att vara 22 tum lång, 15 tum bred och 15 tum hög. Det kommer endast att användas en låda för den storleken. Det kommer att finnas två lådor av storlek: 8x8x4 tum. Det är acceptabelt att skicka samma boxdimension flera gånger om det är lättare för dig, som så här: “22x15x15(1),22x15x15(1)”, vilket betyder 2 lådor av storlek: 22x15x15 tum. Detta fält beskriver de lådor som kommer att användas för att skicka beställningen. Det förväntas inte att en handlare känner till detta vid beställningstillfället; men om det är känt kan det skickas i string format. |
contShoppingURL | Detta fält används för att skicka en URL för att åsidosätta HREF för "Fortsätt handla"-knappen inuti Zonos Checkout. string |
domesticShippingCharge | Detta fält används för att skicka en inhemsk fraktkostnad till Zonos Checkout, och beloppet kommer att läggas till frakten. Detta kan konfigureras för att lägga till fraktbeloppet eller brytas ut som en separat post. positiv flyttal, två decimaler |
externalConfirmationPageURL | Detta fält används för att skicka en URL till din orderbekräftelse / tack-sida. Efter att en kund har slutfört betalningen inuti Zonos Checkout, kommer de att omdirigeras till denna URL för orderbekräftelse. Denna URL används ofta för att utlösa ett samtal till Zonos “orderDetail” API-tjänstslutpunkt för att hämta orderdetaljer och importera ordern i systemet. string |
footerHTML | Detta fält används för att skicka en URL-kodad HTML-sträng. Denna HTML-sträng kommer att avkodas och placeras före den stängande body-taggen på checkout sidan. Vanligtvis används för att skicka kod för remarketing, analys, etc. URL-kodad sträng |
items OBLIGATORISK | Detta fält är en lista över artikelkartor. JSON-sträng |
items[index].countryOfOrigin | Detta fält används för att skicka artikelns ursprungsland. Parametern måste vara landet två-bokstavs ISO-kod. string |
items[index].description OBLIGATORISK | Detta fält används för att skicka en fullständig artikelbeskrivning av kundvagnens radartikel, inklusive eventuella artikelalternativ, färger, etc. string |
items[index].height | Detta fält används för att skicka artikelns höjd och rekommenderas starkt för exakta fraktpriser. Höjdenheten är OBLIGATORISK string - positiv flyttal, två decimaler / heltal (tum) |
items[index].imageURL OBLIGATORISK | Detta fält används för att skicka URL:en till artikelns produktbild. URL:en måste vara HTTPS för att visas inuti Zonos Checkout. string / HTTPS URL |
items[index]itemBrand | Detta fält används för att skicka artikelns märke string |
items[index]itemCategory | Detta fält används för att skicka varukategorin och kan skickas med rördelade värden om varan har mer än en kategori. Exempelvärden: “skor” eller “skor|sportskor|rabatterade-skor” string |
items[index]itemCustomization | Detta fält används för att skicka ytterligare detaljer om varan som inte visas i Zonos Checkout; dock kan detta hämtas via “orderDetail” API-tjänstpunkten. |
items[index]itemHSCode | Detta fält används för att skicka varans HS-kod och kan vara med eller utan punkter. Exempelvärden: “3926901000” eller “3926.90.1000” string |
items[index].itemURL | Detta fält används för att skicka URL:en till varans produktsida. string / URL |
items[index].length | Detta fält används för att skicka varans längd och rekommenderas starkt för exakta fraktkostnader. Längdenheter är OBLIGATORISKA string - positivt flyttal, två decimaler / heltal (tum) |
items[index].nonShippable | Detta fält används för att ange om varan ska inkluderas i frakt-, tull- och skatteberäkningarna. Digitala nedladdningar, rabattkoder, hanteringsavgifter, etc. ska skickas med värdet “true”. boolean: true or false |
items[index].productId | Detta fält används för att skicka kvantiteten av linjevaran. string |
items[index].quantity OBLIGATORISKT | Detta fält används för att skicka kvantiteten av linjevaran. string |
items[index].sku | Detta fält används för att skicka varans SKU / UPC / etc. string |
items[index].unitPrice OBLIGATORISKT | Detta fält används för att skicka enhetspriset för linjevaran. positivt flyttal, två decimaler / heltal |
items[index].weight | Detta fält används för att skicka varans vikt och rekommenderas starkt för exakta fraktkostnader. Viktens enheter är som standard “LBS” om inte en annan viktenhet skickas i items[index].itemWeightUnits``string - positivt flyttal, två decimaler / heltal |
items[index].weightUnits | Detta fält används för att åsidosätta standardviktenheterna för varan. Värdenheterna för varan är som standard “LBS” om inte en annan viktenhet skickas i detta fält. string - "LB", "OZ", "KG", eller "G” |
items[index].width | Detta fält används för att skicka varans bredd och rekommenderas starkt för exakta fraktkostnader. Breddenheter är OBLIGATORISKA string - positivt flyttal, två decimaler / heltal (tum) |
misc1 - misc6 | Detta fält används för att skicka diverse data kopplad till beställningen genom Zonos API för att hämtas tillsammans med beställningsdata som returneras från Zonos “orderDetail” API-tjänstpunkten. string |
referenceId | Detta fält används för att skicka ett unikt referensidentifieringsvärde för kundvagnen/sessionen/etc. i ditt system. Detta kan användas för att slå upp Zonos beställnings-ID via Zonos “orderDetail” API-tjänstpunkten. string |
storeId OBLIGATORISKT | Butiks-ID tillhandahållet av Zonos. heltal |
Ytterligare strängdatatyper
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Rabatter, kuponger och kampanjkoder
För att skicka rabatter, kuponger och kampanjkoder till Zonos via serverpost, måste de skickas som en separat vara med ett negativt värde för parametrarna: “unitPrice”
och “nonShippable”:true
.
EXEMPEL RABATTVARA KARTA
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
HTTPS-svar
Framgång HTTP-svar
Meddelandets format: JSON
EXEMPEL PÅ FRAMGÅNGSSVAR
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Svar JSON-definitioner
fält | anteckningar |
---|---|
tempCartUUID | Denna parameter kommer att innehålla en GUID som tilldelats din kunds internationella kundvagn och skapats i Zonos-systemet. Detta fält kommer att skickas via en URL-frågesträng parameter när användarens webbläsare omdirigeras till Zonos Checkout. |
Fel HTTP-svar
Felkod | betydelse |
---|---|
400 | Oväntad tecken i begärans kropp. |
406 | Inte acceptabelt. HTTP-huvud för "Accept" är ogiltigt. |
415 | Stöds inte mediatyp. HTTP-huvud för "Content-Type" är ogiltigt. |
422 | Obehandlingsbar enhet. |
500 | "storeId" var felaktigt eller JSON-kroppen kunde inte tolkas. |
EXEMPEL PÅ FELSVAR
<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>
Omdirigering till Zonos Checkout
Efter att ha mottagit ett framgångsrikt svar som innehåller tempCartUUID
, kommer din server att skicka en omdirigering från kundens webbläsare till Zonos Checkout med de lämpliga URL-frågesträngparametrarna som täcks nedan.
Exempel på Omdirigerings-URL: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Notera: [yourassignedsubdomain] - Kontakta din Zonos implementeringsteammedlem för att få din Zonos.com subdomän.
URL-förfrågningsparametrar
fält | anteckningar |
---|---|
tempCartUUID OBLIGATORISK | Detta värde erhålls genom att anropa Zonos createTempCart API-tjänstpunkt. sträng / GUID |
country | Destinationens lands tvåbokstavskod. Vi rekommenderar starkt att skicka denna parameter för användarupplevelsen. Parametern country kommer att förvälja destinationslandet inuti Zonos Checkout. När du använder Zonos Hello JS (JavaScript) på webbplatsen kan du få detta värde genom att anropa JavaScript-metoden: zonos.country() . sträng (Längd: 2) |
Ytterligare strängdatatyper
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Skapa en checkout
Utforska nyckel/värde-par som är involverade i att skapa en checkout.
Denna API-slutpunkt används för att skicka kundvagnsinformation och artiklar från kundens kundvagn till Zonos API.
Du kommer att få ett JSON-svar som innehåller en
tempCartUUID
, en unik identifierare för kundvagnen i Zonos System. Detta kommer att användas för att omdirigera kunden till Zonos Checkout för att slutföra beställningen.