Hvad er HTTPS-anmodningen for Checkout API?

HTTPS-anmodningen for Checkout API inkluderer HTTP-metoden (POST), slutpunktet ('https://api.iglobalstores.com/v2/orderDetail'), protokollen (HTTPS), meddelelsesformatet (JSON) og HTTP-headerne (Accept: application/json, Content-Type: application/json).

Hvad er JSON-nøgle/værdi-parrene i anmodningens brødtekst?

JSON-nøgle/værdi-parrene i anmodningsteksten inkluderer 'orderId', 'referenceId', 'secret' og 'storeId'. 'orderId' og 'referenceId' er valgfrie, men en af dem skal angives. 'secret' og 'storeId' er påkrævet.

Hvad er de mulige HTTP-fejlsvar?

De mulige HTTP-fejlsvar inkluderer 415 (Ikke-understøttet medietype), 406 (Ikke acceptabelt), 400 (Dårlig anmodning) og 500 (intern serverfejl). Hver fejlkode svarer til en bestemt type fejl.

Hvad er JSON-responsdefinitionerne?

Svarets JSON-definitioner inkluderer forskellige parametre relateret til ordredetaljerne, såsom 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' og mange andre. Hver parameter giver specifikke oplysninger om ordren.

Checkout•

HjemAPI reference Checkout REST API Ordredetaljer

Ordredetaljer

Q: Hvad er Checkout API-slutpunktet?

Checkout API-slutpunktet er 'orderDetail'. Dette API-slutpunkt bruges til sikkert at hente ordredetaljerne og status for en ordre gennemført via Zonos Checkout.

Lær, hvordan slutpunktet for ordredetaljer fungerer.

DeorderDetailslutpunkt bruges til sikkert at hente ordredetaljerne og status for en ordre gennemført via Zonos Checkout.

Slutpunkt

**Note:**Svartasterne kan modificeres og/eller yderligere nøgler kan tilføjes. Hvis du skal bruge slutpunktet, skal du konfigurere din kode, så den passer til disse muligheder.

POST | `https://api.iglobalstores.com/v2/orderDetail`

HTTPS-anmodning

felt↕	noter↕
HTTP-metode	POST
Slutpunkt	`https://api.iglobalstores.com/v2/orderDetail`
Protokol	HTTPS
Meddelelsesformat	JSON
Accepter HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON-nøgle/værdi-par i anmodningens brødtekst

felt↕	noter↕
`orderId`VALGFRI, hvis `referenceId`-parameteren sendes	Zonos ordre-id kan sendes med eller uden dit butiks-id og bindestreg (eksempel: 123-45678 eller 45678). Bemærk: Efter ordreafslutning og betaling vil kunden blive omdirigeret til en ordregennemførelse/ordretak-side, der er hostet på dit domæne. URL'en vil indeholde en forespørgselsstrengparameter "orderId", der vil indeholde denne værdi.`integer / string`
`referenceId`VALGFRI, hvis "orderId"-parameteren sendes	Denne parameter bruges til at slå en ordres data op efter det unikke`referenceId`, der er angivet i`createTempCart`API Service slutpunkt. Denne parameter bør udelades eller nulstilles, når man har til hensigt at slå ordredetaljen op baseret på`orderId`parameter.`string`
`secret`PÅKRÆVET	API hemmelig GUID leveret af Zonos`string`
`storeId`PÅKRÆVET	Butiks-id leveret af Zonos.`integer`

Fejl i HTTP-svar

Fejlkode↕	besked↕	betydning↕
415	Ikke-understøttet medietype	HTML-enhed. HTTP "Content-Type" header er ugyldig.
406	Ikke acceptabelt	HTML-enhed. HTTP "Accepter"-headeren er ugyldig.
400	Dårlig anmodning	"error":"orderId: 999-99999 er ikke et gyldigt orderId""error":"Kunne ikke finde en ordre med orderId: 999-99999""error":"Ugyldige sikkerhedsoplysninger""error":"Ugyldig posttekst""error":"Parameter orderId eller referenceId er påkrævet""error":"Kan ikke angive både parametrene orderId og referenceId""error":"Ingen ordre fundet med orderId: 999-99999""error":"Parameterlager påkrævet""error":"Ingen ordre fundet med referenceId: 999999 for storeId: 999""error":"referenceId: 999999 for storeId: 999 er blevet duplikeret""error":"Kunne ikke hente ordre med reference-id: 999999"
500	Intern serverfejl	"error":"Kunne ikke behandle ordreoplysninger"

Svar JSON definitioner

felt↕	noter↕
`error`	Denne parameter er kun til stede, når der er opstået en fejl, og vil indeholde en fejlbeskrivelse.`string`
`order`	Dette er et kort over ordredetaljerne.`JSON string`
`order.billingZip`	Faktureringsadresse for ordren - værdierne blev indtastet i Zonos Checkout.`string`
`orderboxCount`	Dette felt beskriver de felter, der vil blive brugt til at sende ordren, der sendes til oprette TempCart-anmodningen.`string`
`order.carrierAccountNumber`	En besøgendes eget fragtfirmas kontonummer; bruges, når besøgendes udbyderkonti er aktiveret`string`
`order.carrierAccountShippingMethod`	Den valgte forsendelsesmetode på den besøgendes egen fragtfirmakonto; bruges, når besøgendes udbyderkonti er aktiveret`string`
`order.cslListMatch`	Konsolideret Screening List (CSL) match. En boolsk værdi, der angiver, hvornår kundeoplysningerne har produceret et match i den amerikanske konsoliderede Screening List og bør gennemgås for mulig afvist part-tilknytning.`boolean`
`order.customerSelectedShippingName`	Visningsnavn for forsendelsesmulighed inde i Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Et kort over told-/skattefordelingen Bemærk - Hvis relevant, er IPF (International Processing Fee) ikke inkluderet.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Mæglergebyr beløb i USD; positivt flydende komma, to decimaler`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Beløb for udlægsgebyr i USD; positivt flydende komma, to decimaler`integer`
`order.dutyTaxesBreakdown.duty`	Toldbeløb i USD; positivt flydende komma, to decimaler`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Prepayment gebyrbeløb i USD; positivt flydende komma, to decimaler`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	moms/afgiftsbeløb på udlægsgebyr i USD; positivt flydende komma, to decimaler`integer`
`order.dutyTaxesBreakdown.vatTax`	Moms/afgiftsbeløb i USD, inkluderer ikke momsen/afgiften på udlægsgebyret; positivt flydende komma, to decimaler`integer`
`order.dutyTaxesTotal`	Told og skat i alt i USD; positivt flydende komma, to decimaler`integer`
`order.foreignCurrencyCode`	Valutakoden, som ordrebetalingen blev afviklet i.`string`
`remittance_amount`	Det beløb, der skal overføres til et specifikt land, f.eks. _ UK VAT_.`decimal`
`order.grandTotal`	Total i USD; positivt flydende komma, to decimaler`integer`
`order.grandTotalForeign`	Totalsum i afregnet valuta; positivt flydende komma, to decimaler`integer`
`order.items`	En liste over varekort varekortet indeholder detaljer om det element, der blev sendt til Zonos Checkout ved oprettelse af midlertidig kurvFor flere detaljer om vareegenskaber, se venligst oprette TempCartAPI-dokumentet`JSON string`
`order.itemsCount`	Antal ordrelinjer`integer`
`order.itemsTotal`	Varer/produkt i alt i USD; positivt flydende komma, to decimaler`integer`
`order.itemsTotalForeign`	Varer/produkt i alt i den afregnede valuta; positivt flydende komma, to decimaler`integer`
`order.items[index].height`	Positivt flydende komma, to decimaler`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Positivt flydende komma, to decimaler`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Positivt flydende komma, to decimaler`integer`
`order.items[index].width`	Positivt flydende komma, to decimaler`integer`
`order.items[index].unitPrice`	Positivt flydende komma, to decimaler`integer`
`order.merchantOrderId`	`MerchantOrderId`knyttet til ordren gennem opdaterMerchantOrderIdAPI-serviceslutpunktet.`string`
`order.misc1`	Yderligere værdi knyttet til ordren gennem oprette TempCartAPI-serviceslutpunktet.`string`
`order.misc2`	Yderligere værdi knyttet til ordren gennem oprette TempCartAPI-serviceslutpunktet.`string`
`order.misc3`	Yderligere værdi knyttet til ordren gennem oprette TempCartAPI-serviceslutpunktet.`string`
`order.misc4`	Yderligere værdi knyttet til ordren gennem oprette TempCartAPI-serviceslutpunktet.`string`
`order.misc5`	Yderligere værdi knyttet til ordren gennem oprette TempCartAPI-serviceslutpunktet.`string`
`order.misc6`	Yderligere værdi knyttet til ordren gennem oprette TempCartAPI-serviceslutpunktet.`string`
`order.nationalIdentifier`	Yderligere internationale faktureringsadresseoplysninger for ordren, når det kræves. Værdierne blev indtastet i Zonos Checkout.`string`
`order.notes`	En liste over notekort; notekortet indeholder detaljer om ordresedlen.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	En boolesk værdi, der angiver, om dette var en kundeoprettet note om ordren, forsendelse osv.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	EN`boolean` angiver, om denne note blev markeret som vigtig
`order.notes[index].note`	Notens indhold`string`
`order.optInEmail`	Angiver, at kunden har markeret afkrydsningsfeltet for "tilmeld dig vores nyhedsbrev" i Zonos CheckoutGælder kun, hvis du har valgt at vise dette afkrydsningsfelt på betalingssiden`boolean`
`order.orderId`	Ordrens identifikationsnummer i Zonos-systemet`string`
`order.orderDate`	Ordreoprettelsens tidsstemplet millis i UTC/GMT.`millis`
`order.orderDateString`	Tidsstempelstrengen for ordreoprettelse i UTC/GMT.`string`
`order.orderStatus`	Status/tilstand for ordren i Zonos systemet. For flere detaljer vedr`orderStatus`brug, bedes du gennemgå Hent et ordredokument her. Yderligere information om ordrestatusserne kan findes i Opdater et ordredokument her.`string`
`order.orderStatusDate`	Tidsstemplet millis i UTC/GMT for den seneste`orderStatus`ændring i Zonos-systemet.`millis`
`order.orderStatusDateString`	Tidsstempelstrengen i UTC/GMT for den seneste`orderStatus`ændring i Zonos-systemet.`string`
`order.paymentProcessing`	Et kort over`paymentProcessing`detaljer. Nogle parametre er muligvis ikke gældende for din konto og vil blive udelukket fra svaret.`JSON string`
`order.paymentProcessing.captureDate`	Datoen for betaling registreres i millis, hvis tilgængelig. Hvis Zonos behandler betalingen, er denne node udelukket fra svaret.`millis`
`order.paymentProcessing.captureDateString`	Datoen for betaling registreres som streng, hvis tilgængelig. Hvis Zonos behandler betalingen, er denne node udelukket fra svaret.`string`
`order.paymentProcessing.cardType`	KreditkortmærkeHvis Zonos behandler betalingen, er denne node udelukket fra svaret.`string`
`order.paymentProcessing.lastFour`	De sidste fire numre i faktureringskreditkortnummeret. Hvis Zonos behandler betalingen, er denne node udelukket fra svaret.`string`
`order.paymentProcessing.paymentGateway`	Navn på betalingsgatewayHvis Zonos behandler betalingen, angiver "iGlobal_CC" eller "iGlobal_PayPal".`string`
`order.paymentProcessing.transactionType`	Angiver transaktionstypen "AUTH_CAPTURE" eller "AUTH_ONLY". Hvis Zonos behandler betalingen, er denne node udelukket fra svaret.`string`
`order.poNumber`	Et indkøbsordrenummer for den ordre, der er angivet i Zonos Checkout; bruges, når indkøbsordrer er aktiveret`string`
`order.quotedDutyTaxes`	Told og skat angivet i Zonos Checkout, vist i USD; positivt flydende komma, to decimaler`integer`
`order.quotedDutyTaxesForeign`	Told og skat angivet i Zonos Checkout. Vises i afregnet valuta; positivt flydende komma, to decimaler`integer`
`order.referenceId`	Enestående`referenceId`knyttet til ordren gennem oprette TempCart API-tjenesteslutpunktet.`string`
`order.shipComplete`	Angiver om ordren skal sendes i flere dele`boolean`
`order.shippingCarrierServiceLevel`	Transportør og serviceniveau-id for den valgte forsendelsesmulighed`string`
`order.shippingInstructions`	Brugerdefinerbare instruktioner til forsendelsesserviceniveauet`string`
`order.shippingTotal`	Forsendelse i alt i USD; positivt flydende komma, to decimaler`integer`
`order.shippingTotalForeign`	Forsendelsessum i den afregnet valuta; positivt flydende komma, to decimaler`integer`
`order.testOrder`	Angiver om ordren er en testordre.`boolean`
`order.trackingNumber`	Sporingsnummer genereret for forsendelsen, hvis relevant.`string`
`order.zip`	Destinations-/forsendelsesadresse for ordren - værdierne blev indtastet i Zonos Checkout eller blev videregivet til ordren gennem omdirigeringen til Zonos Checkout.`string`

Yderligere datatyper:

order.address1
order.address2
order.address3
order.altPhone
order.billingAddress1
order.billingAddress2
order.billingAddress3
order.billingAltPhone
order.billingCity
order.birthDate
order.billingCompany
order.billingCountryCode
order.billingCountryName
order.billingEmail
order.billingName
order.billingPhone
order.billingState
order.city
order.company
order.countryCode
order.countryName
order.email
order.items[index].countryOfOrigin
order.items[index].description
order.items[index].imageURL
order.items[index].itemBrand
order.items[index].itemCategory
order.items[index].itemColor
order.items[index].itemCustomization
order.items[index].itemDescriptionDetailed
order.items[index].itemDescriptionLong
order.items[index].itemFabricContent
order.items[index].itemHSCode
order.items[index].itemLtlClass
order.items[index].itemMaterial
order.items[index].itemURL
order.items[index].productId
order.items[index].sku
order.items[index].productId
order.items[index].weightUnits
order.name
order.phone
order.state

Book en demo