Attributter
JSON nøkkel/verdi-par i forespørselens kropp
POST https://api.iglobalstores.com/v1/createTempCart
felt | notater |
---|---|
boxCount | Eksempelverdi: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Komma-separert liste over boksdimensjoner og antall. I eksempelet ovenfor er det totalt 4 bokser. Den første boksen i listen vil være 22 tommer lang, 15 tommer bred og 15 tommer høy. Det vil kun være én boks brukt for den størrelsen. Det vil være to bokser av størrelse: 8x8x4 tommer. Det er akseptabelt å sende de samme boksdimensjonene flere ganger hvis det er enklere for deg, slik: “22x15x15(1),22x15x15(1)”, som betyr 2 bokser av størrelse: 22x15x15 tommer. Dette feltet beskriver boksene som vil bli brukt til å sende bestillingen. Det forventes ikke at en selger vet dette på tidspunktet for bestilling; imidlertid, hvis det er kjent, kan det sendes i string format. |
contShoppingURL | Dette feltet brukes til å sende en URL for å overstyre HREF-en til "Fortsett å handle"-knappen inne i Zonos Checkout. string |
domesticShippingCharge | Dette feltet brukes til å sende en innenlandsk fraktkostnad til Zonos Checkout, og beløpet vil bli lagt til frakten. Dette kan konfigureres for å legge til fraktbeløpet eller brytes ut som en egen linjepost. positiv flyttall, to desimaler |
externalConfirmationPageURL | Dette feltet brukes til å sende en URL til din bestillingsbekreftelse / takk-siden. Etter at en kunde har fullført betalingen inne i Zonos Checkout, vil de bli omdirigert til denne URL-en for bestillingsbekreftelse. Denne URL-en brukes ofte til å utløse et kall til Zonos “orderDetail” API-tjenesteendepunktet for å hente bestillingsdetaljene og importere bestillingen inn i systemet. string |
footerHTML | Dette feltet brukes til å sende en URL-kodet HTML-streng. Denne HTML-strengen vil bli dekodet og plassert før den lukkende body-taggen på checkout siden. Vanligvis brukt til å sende kode for re-markedsføring, analyse, osv. URL-kodet streng |
items PÅKREVD | Dette feltet er en liste over varekart. JSON streng |
items[index].countryOfOrigin | Dette feltet brukes til å sende varens opprinnelsesland. Parameteren må være landet to-bokstavers ISO-kode. string |
items[index].description PÅKREVD | Dette feltet brukes til å sende en full varebeskrivelse av handlekurvlinjeelementet, inkludert eventuelle varealternativer, farger, osv. string |
items[index].height | Dette feltet brukes til å sende varens høyde og er sterkt anbefalt for nøyaktige fraktpriser. Høydeenheter er PÅKREVD string - positiv flyttall, to desimaler / heltall (tommer) |
items[index].imageURL PÅKREVD | Dette feltet brukes til å sende URL-en til vareproduktbildet. URL-en må være HTTPS for å vises inne i Zonos Checkout. string / HTTPS URL |
items[index]itemBrand | Dette feltet brukes til å sende varemerket string |
items[index]itemCategory | Dette feltet brukes til å sende varekategorien og kan sendes med pipe-separerte verdier hvis varen har mer enn én kategori. Eksempelverdier: “sko” eller “sko|sport-sko|rabatt-sko” string |
items[index]itemCustomization | Dette feltet brukes til å sende tilleggsdetaljer om varen som ikke vises i Zonos Checkout; imidlertid kan dette hentes gjennom “orderDetail” API-tjenestepunktet. |
items[index]itemHSCode | Dette feltet brukes til å sende vare HS-koden og kan være med eller uten punktum. Eksempelverdier: “3926901000” eller “3926.90.1000” string |
items[index].itemURL | Dette feltet brukes til å sende URL-en til vareproduktets side. string / URL |
items[index].length | Dette feltet brukes til å sende varelengden og anbefales sterkt for nøyaktige fraktpriser. Lengdeenheter er PÅKREVD string - positivt flyttall, to desimaler / heltall (tommer) |
items[index].nonShippable | Dette feltet brukes til å indikere om varen skal inkluderes i frakt-, avgifts- og skatteberegningene. Digitale nedlastinger, rabattkoder, håndteringsgebyrer osv. skal sendes med verdien “true”. boolean: true eller false |
items[index].productId | Dette feltet brukes til å sende antallet for linjevaren. string |
items[index].quantity PÅKREVD | Dette feltet brukes til å sende antallet for linjevaren. string |
items[index].sku | Dette feltet brukes til å sende vare SKU / UPC / osv. string |
items[index].unitPrice PÅKREVD | Dette feltet brukes til å sende enhetsprisen for linjevaren. positivt flyttall, to desimaler / heltall |
items[index].weight | Dette feltet brukes til å sende varevekten og anbefales sterkt for nøyaktige fraktpriser. Vektenheter er som standard “LBS” med mindre en annen vektenhet sendes i items[index].itemWeightUnits``string - positivt flyttall, to desimaler / heltall |
items[index].weightUnits | Dette feltet brukes til å overstyre standard varevektenheter. Varevektenheter er som standard “LBS” med mindre en annen vektenhet sendes i dette feltet. string - "LB", "OZ", "KG", eller "G” |
items[index].width | Dette feltet brukes til å sende varebredden og anbefales sterkt for nøyaktige fraktpriser. Breddeenheter er PÅKREVD string - positivt flyttall, to desimaler / heltall (tommer) |
misc1 - misc6 | Dette feltet brukes til å sende diverse data knyttet til bestillingen gjennom Zonos API for å bli hentet sammen med bestillingsdataene som returneres fra Zonos “orderDetail” API-tjenestepunktet. string |
referenceId | Dette feltet brukes til å sende en unik referanseidentifikasjonsverdi for handlekurven/sesjonen/osv. i systemet ditt. Dette kan brukes til å se opp Zonos bestillings-ID via Zonos “orderDetail” API-tjenestepunktet. string |
storeId PÅKREVD | Butikk-ID levert av Zonos. heltall |
Ytterligere strenger datatyper
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Rabatter, kuponger og kampanjekoder
For å sende rabatter, kuponger og kampanjekoder til Zonos gjennom serverinnlegget, må de sendes som en egen vare med en negativ verdi for parametrene: “unitPrice”
og “nonShippable”:true
.
EKSEMPEL PÅ RABATT VAREKART
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
HTTPS-respons
Suksess HTTP-respons
Meldingsformat: JSON
EKSEMPEL PÅ SUKSESSRESPONS
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Respons JSON-definisjoner
felt | notater |
---|---|
tempCartUUID | Denne parameteren vil inneholde en GUID tildelt til kundens internasjonale handlekurv og opprettet i Zonos-systemet. Dette feltet vil bli sendt via en URL-spørring string -parameter mens brukerens nettleser omdirigeres til Zonos Checkout. |
Feil HTTP-responser
Feilkode | betydning |
---|---|
400 | Uventet tegn i forespørselens kropp. |
406 | Ikke akseptabelt. HTTP-header for “Accept” er ugyldig. |
415 | Ustøttet mediatype. HTTP-header for “Content-Type” er ugyldig. |
422 | Ubehandlet enhet. |
500 | “storeId” var feil eller JSON-kroppen kunne ikke bli analysert. |
EKSEMPEL PÅ FEILRESPONS
<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
Etter å ha mottatt et vellykket svar som inneholder tempCartUUID
, vil serveren din sende en omdirigering fra kundens nettleser til Zonos Checkout med de passende URL-spørringsparameterne som dekkes nedenfor.
Eksempel på Omdirigerings-URL: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Merk: [yourassignedsubdomain] - Kontakt medlemmet av implementeringsteamet ditt for Zonos for å motta din Zonos.com subdomene.
URL forespørsel parametere
felt | notater |
---|---|
tempCartUUID PÅKREVD | Denne verdien oppnås ved å kalle Zonos createTempCart API-tjenestepunktet. string / GUID |
country | Destinasjonslandets to-bokstavers ISO-kode. Vi anbefaler sterkt å sende denne parameteren for brukeropplevelse. country -parameteren vil forhåndsvelge destinasjonslandet inne i Zonos Checkout. Når du bruker Zonos Hello JS (JavaScript) på nettstedet, kan du oppnå denne verdien ved å kalle JavaScript-metoden: zonos.country() . string (Lengde: 2) |
Ytterligere strenge datatyper
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Opprett en checkout
Utforsk nøkkel/verdi-parene involvert i oppretting av en checkout.
Dette API-endepunktet brukes til å sende handlekurv informasjon og varer fra kundens handlekurv til Zonos API.
Du vil motta et JSON-svar som inneholder en
tempCartUUID
, en unik handlekurvidentifikator i Zonos Systemet. Dette vil bli brukt til å omdirigere kunden til Zonos Checkout for å fullføre bestillingen.