Attributter
JSON nøgle/værdi-par i anmodningskroppen
POST https://api.iglobalstores.com/v1/createTempCart
felt | noter |
---|---|
boxCount | Eksempelværdi: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Komma-separeret liste over boksdimensioner og antal. I eksemplet ovenfor er der i alt 4 bokse. Den første boks i listen vil være 22 tommer lang, 15 tommer bred og 15 tommer høj. Der vil kun blive brugt én boks til den størrelse. Der vil være to bokse af størrelse: 8x8x4 tommer. Det er acceptabelt at angive den samme boksdimension flere gange, hvis det er nemt for dig, som dette: “22x15x15(1),22x15x15(1)”, hvilket betyder 2 bokse af størrelse: 22x15x15 tommer. Dette felt beskriver de bokse, der vil blive brugt til at sende ordren. Det forventes ikke, at en forhandler kender dette på tidspunktet for ordren; dog, hvis det er kendt, kan det angives i string format. |
contShoppingURL | Dette felt bruges til at angive en URL for at overskrive HREF'en for "Fortsæt med at handle" knappen inde i Zonos Checkout. string |
domesticShippingCharge | Dette felt bruges til at angive en indenlandsk forsendelsesafgift til Zonos Checkout, og beløbet vil blive tilføjet til forsendelsen. Dette kan konfigureres til at tilføje den samlede forsendelse eller brydes ud som en separat linje. positiv flydende punkt, to decimaler |
externalConfirmationPageURL | Dette felt bruges til at angive en URL til din ordrebekræftelse / takkeside. Efter at en kunde har gennemført betalingen inde i Zonos Checkout, vil de blive omdirigeret til denne URL for ordrebekræftelse. Denne URL bruges ofte til at udløse et kald til Zonos “orderDetail” API service endepunkt for at hente ordredetaljerne og importere ordren i systemet. string |
footerHTML | Dette felt bruges til at angive en URL-kodet HTML-streng. Denne HTML-streng vil blive dekodet og placeret før den afsluttende body-tag på checkout siden. Almindeligt brugt til at angive kode til remarketing, analyse osv. URL kodet streng |
items PÅKRÆVET | Dette felt er en liste over varekort. JSON streng |
items[index].countryOfOrigin | Dette felt bruges til at angive varens oprindelsesland. Parameteren skal være landet to-bogstavs ISO-kode. string |
items[index].description PÅKRÆVET | Dette felt bruges til at angive en fuld varebeskrivelse af kurvlinjevaren, inklusive eventuelle varemuligheder, farver osv. string |
items[index].height | Dette felt bruges til at angive varens højde og anbefales stærkt for nøjagtige forsendelsespriser. Højdeenheder er PÅKRÆVET string - positiv flydende punkt, to decimaler / heltal (tommer) |
items[index].imageURL PÅKRÆVET | Dette felt bruges til at angive URL'en til vareproduktbilledet. URL'en skal være HTTPS for at blive vist inde i Zonos Checkout. string / HTTPS URL |
items[index]itemBrand | Dette felt bruges til at angive varemærket string |
items[index]itemCategory | Dette felt bruges til at videregive varekategorien og kan videregives som pipe-separeret, hvis varen har mere end én kategori. Eksempelværdier: “sko” eller “sko|sportsko|rabatsko” string |
items[index]itemCustomization | Dette felt bruges til at videregive yderligere oplysninger om varen, som ikke vises i Zonos Checkout; dog kan dette hentes gennem “orderDetail” API service endpoint. |
items[index]itemHSCode | Dette felt bruges til at videregive vare HS-koden og kan være med eller uden punktummer. Eksempelværdier: “3926901000” eller “3926.90.1000” string |
items[index].itemURL | Dette felt bruges til at videregive URL'en til vareproduktets side. string / URL |
items[index].length | Dette felt bruges til at videregive varens længde og anbefales stærkt for nøjagtige forsendelsespriser. Længdeenheder er PÅKRÆVET string - positivt flydende punkt, to decimaler / heltal (tommer) |
items[index].nonShippable | Dette felt bruges til at angive, om varen skal inkluderes i forsendelses-, told- og skatteberegningerne. Digitale downloads, rabatkoder, håndteringsgebyrer osv. skal videregives med værdien “true”. boolean: true or false |
items[index].productId | Dette felt bruges til at videregive linjevaremængden. string |
items[index].quantity PÅKRÆVET | Dette felt bruges til at videregive linjevaremængden. string |
items[index].sku | Dette felt bruges til at videregive varens SKU / UPC / osv. string |
items[index].unitPrice PÅKRÆVET | Dette felt bruges til at videregive linjevareenhedsprisen. positivt flydende punkt, to decimaler / heltal |
items[index].weight | Dette felt bruges til at videregive varens vægt og anbefales stærkt for nøjagtige forsendelsespriser. Vægtenheder er som standard “LBS”, medmindre en anden vægtenhed videregives i items[index].itemWeightUnits``string - positivt flydende punkt, to decimaler / heltal |
items[index].weightUnits | Dette felt bruges til at overskrive de standard vægtenheder for varen. Vægtenheder for varen er som standard “LBS”, medmindre en anden vægtenhed videregives i dette felt. string - "LB", "OZ", "KG", eller "G” |
items[index].width | Dette felt bruges til at videregive varens bredde og anbefales stærkt for nøjagtige forsendelsespriser. Breddeenheder er PÅKRÆVET string - positivt flydende punkt, to decimaler / heltal (tommer) |
misc1 - misc6 | Dette felt bruges til at videregive diverse data forbundet med ordren gennem Zonos API for at blive hentet sammen med de ordredata, der returneres fra Zonos “orderDetail” API service endpoint. string |
referenceId | Dette felt bruges til at videregive en unik referenceidentifikationsværdi for kurven/sessionen/osv. i dit system. Dette kan bruges til at slå Zonos ordrenummeret op via Zonos “orderDetail” API service endpoint. string |
storeId PÅKRÆVET | Butiks-ID leveret af Zonos. heltal |
Yderligere strenge datatyper
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Rabatter, kuponer og kampagnekoder
For at sende rabatter, kuponer og kampagnekoder til Zonos gennem serverposten, skal de videregives som en separat vare med en negativ værdi for parametrene: “unitPrice”
og “nonShippable”:true
.
EKSEMPEL PÅ RABATVAREKORT
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
HTTPS svar
Succes HTTP svar
Beskedformat: JSON
EKSEMPEL PÅ SUCCES SVAR
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Response JSON definition
felt | noter |
---|---|
tempCartUUID | Denne parameter vil indeholde en GUID tildelt til din kundes internationale kurv og oprettet i Zonos systemet. Dette felt vil blive sendt via en URL forespørgsels string parameter, mens brugerens browser omdirigeres til Zonos Checkout. |
Fejl HTTP svar
Fejlkode | betydning |
---|---|
400 | Uventet tegn i anmodningskroppen. |
406 | Ikke acceptabel. HTTP-headeren for “Accept” er ugyldig. |
415 | Uunderstøttet medietype. HTTP-headeren for “Content-Type” er ugyldig. |
422 | Ubehandlet enhed. |
500 | “storeId” var forkert, eller JSON-kroppen kunne ikke parses. |
EKSEMPEL PÅ FEJL SVAR
<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 til Zonos Checkout
Efter at have modtaget et vellykket svar, der indeholder tempCartUUID
, vil din server sende en omdirigering fra kundens browser til Zonos Checkout med de relevante URL-forespørgselsparametre, der er dækket nedenfor.
Eksempel på Omdirigerings-URL: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Bemærk: [yourassignedsubdomain] - Kontakt dit Zonos implementeringsteammedlem for at modtage dit Zonos.com subdomæne.
URL-forespørgselsparametre
felt | noter |
---|---|
tempCartUUID PÅKRÆVET | Denne værdi opnås ved at kalde Zonos createTempCart API-service endpoint. string / GUID |
country | Destinationens lands to-bogstavs ISO-kode. Vi anbefaler stærkt at videregive denne parameter for brugeroplevelsen. country parameteren vil forudvælge destinationslandet inde i Zonos Checkout. Når du bruger Zonos Hello JS (JavaScript) på siden, kan du opnå denne værdi ved at kalde JavaScript-metoden: zonos.country() . string (Længde: 2) |
Yderligere strenge datatyper
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Opret en checkout
Udforsk nøgle/værdi-parrene involveret i oprettelsen af en checkout.
Dette API-endepunkt bruges til at sende kurvoplysninger og varer fra kundens kurv til Zonos API.
Du vil modtage et JSON-svar, der indeholder en
tempCartUUID
, en unik kurvidentifikator i Zonos Systemet. Dette vil blive brugt til at omdirigere kunden til Zonos Checkout for at fuldføre ordren.