Wat is het HTTPS-request voor de Checkout API?

Het HTTPS-request gebruikt POST naar https://api.iglobalstores.com/v2/orderDetail met JSON-body en headers Accept: application/json en Content-Type: application/json.

Wat zijn de JSON key/value-pairs in de request body?

De request body bevat optioneel orderId of referenceId, plus verplichte secret en storeId.

Wat zijn de mogelijke error HTTP-responses?

Mogelijke responses zijn 415 Unsupported media type, 406 Not Acceptable, 400 Bad Request en 500 Internal Server Error met beschrijvende foutmeldingen.

Wat zijn de response JSON-definities?

De response bevat orderdetails inclusief facturatie- en verzendgegevens, totalen, status en iteminformatie, of een error-veld bij fouten.

Checkout•

StartpaginaAPI-referentie Checkout REST API Orderdetails

Orderdetails

Q: Wat is het Checkout API-endpoint?

Het orderDetail-endpoint wordt gebruikt om veilig orderdetails en status op te halen van een order die via Zonos Checkout is voltooid.

Leer hoe het Orderdetails-endpoint werkt.

Het orderDetail-endpoint wordt gebruikt om veilig orderdetails en status op te halen van een order die via Zonos Checkout is voltooid.

Endpoint

Opmerking: De sleutels in de response kunnen worden gewijzigd en/of er kunnen extra sleutels worden toegevoegd. Als u dit endpoint gaat gebruiken, zorg er dan voor dat uw code hierop is voorbereid.

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

HTTPS-request

Veld↕	Notities↕
HTTP-methode	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protocol	HTTPS
Berichtformaat	JSON
Accept HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON key/value-pairs in de request body

Veld↕	Notities↕
`orderId` OPTIONAL, indien de parameter `referenceId` wordt doorgegeven	Het Zonos order-ID kan worden doorgegeven met of zonder uw store-ID en koppelteken (voorbeeld: 123-45678 of 45678). Opmerking: na orderafronding en betaling wordt de klant doorgestuurd naar een Order Completion-/Order Thank You-pagina die op uw domein wordt gehost. De URL bevat een querystringparameter “orderId” met deze waarde.`integer / string`
`referenceId` OPTIONAL, indien de parameter “orderId” wordt doorgegeven	Deze parameter wordt gebruikt om de gegevens van een order op te zoeken via de unieke `referenceId` die is doorgegeven in het `createTempCart`-API-serviceendpoint. Laat deze parameter weg of gebruik null wanneer u de orderdetails wilt opzoeken op basis van de parameter `orderId`.`string`
`secret` REQUIRED	API secret GUID verstrekt door Zonos`string`
`storeId` REQUIRED	Store-ID verstrekt door Zonos.`integer`

Error HTTP-responses

Foutcode↕	bericht↕	betekenis↕
415	Unsupported media type	HTML-entiteit. HTTP-header “Content-Type” is ongeldig.
406	Not Acceptable	HTML-entiteit. HTTP-header “Accept” is ongeldig.
400	Bad Request	“error”:”orderId: 999-99999 is not a valid orderId”“error”:”Could not find an order with orderId: 999-99999”“error”:”Invalid security credentials”“error”:”Invalid post body”“error”:”Parameter orderId or referenceId is required”“error”:”Cannot specify both Parameters orderId and referenceId”“error”:”No order found with orderId: 999-99999”“error”:”Parameter store required”“error”:”No order found with referenceId: 999999 for storeId: 999”“error”:”referenceId: 999999 for storeId: 999 has been duplicated”“error”:”Couldn’t retrieve order with referenceId: 999999”
500	Internal Server Error	“error”:”Couldn’t process order details”

Response JSON-definities

Veld↕	Notities↕
`error`	Deze parameter is alleen aanwezig wanneer er een fout is opgetreden en bevat een foutbeschrijving.`string`
`order`	Dit is een map met de orderdetails.`JSON string`
`order.billingZip`	Factuuradres voor de order - de waarden zijn ingevoerd in Zonos Checkout.`string`
`orderboxCount`	Dit veld beschrijft de dozen die worden gebruikt om de order te verzenden, doorgegeven in het createTempCart -verzoek.`string`
`order.carrierAccountNumber`	Het eigen vervoerdersaccountnummer van de bezoeker; wordt gebruikt wanneer eigen vervoerdersaccounts voor bezoekers zijn ingeschakeld`string`
`order.carrierAccountShippingMethod`	De geselecteerde verzendmethode op het eigen vervoerdersaccount van de bezoeker; wordt gebruikt wanneer eigen vervoerdersaccounts voor bezoekers zijn ingeschakeld`string`
`order.cslListMatch`	Consolidated Screening List (CSL)-overeenkomst. Een boolean die aangeeft of de klantgegevens een overeenkomst hebben opgeleverd in de Amerikaanse Consolidated Screening List en beoordeeld moeten worden op mogelijke banden met een geweigerde partij.`boolean`
`order.customerSelectedShippingName`	Weergavenaam van de verzendoptie binnen Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Een map met de uitsplitsing van rechten/belastingen. Opmerking: indien van toepassing is de IPF (International Processing Fee) hierin niet meegenomen.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Bedrag van de brokerage fee in USD; positief getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Bedrag van de uitbetalingsvergoeding in USD; positief getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.duty`	Bedrag aan invoerrechten in USD; positief getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Bedrag van de vooruitbetalingsvergoeding in USD; positief getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Btw-/belastingbedrag over de uitbetalingsvergoeding in USD; positief getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.vatTax`	Btw-/belastingbedrag in USD, exclusief de btw/belasting over de uitbetalingsvergoeding; positief getal, twee decimalen`integer`
`order.dutyTaxesTotal`	Totaal aan rechten en belastingen in USD; positief getal, twee decimalen`integer`
`order.foreignCurrencyCode`	De valutacode waarin de orderbetaling is afgewikkeld.`string`
`remittance_amount`	Het geldbedrag dat naar een specifiek land moet worden afgedragen, bijvoorbeeld btw in het VK.`decimal`
`order.grandTotal`	Eindtotaal in USD; positief getal, twee decimalen`integer`
`order.grandTotalForeign`	Eindtotaal in de afgewikkelde valuta; positief getal, twee decimalen`integer`
`order.items`	Een lijst met itemmaps. De itemmap bevat details over het item die bij het aanmaken van de tijdelijke winkelwagen naar Zonos Checkout zijn doorgegeven. Voor meer informatie over itemeigenschappen raadpleegt u de createTempCart -API-documentatie`JSON string`
`order.itemsCount`	Aantal orderregels`integer`
`order.itemsTotal`	Items-/producttotaal in USD; positief getal, twee decimalen`integer`
`order.itemsTotalForeign`	Items-/producttotaal in de afgewikkelde valuta; positief getal, twee decimalen`integer`
`order.items[index].height`	Positief getal, twee decimalen`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Positief getal, twee decimalen`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Positief getal, twee decimalen`integer`
`order.items[index].width`	Positief getal, twee decimalen`integer`
`order.items[index].unitPrice`	Positief getal, twee decimalen`integer`
`order.merchantOrderId`	`MerchantOrderId` die aan de order is gekoppeld via het updateMerchantOrderId -API-serviceendpoint.`string`
`order.misc1`	Extra waarde die aan de order is gekoppeld via het createTempCart -API-serviceendpoint.`string`
`order.misc2`	Extra waarde die aan de order is gekoppeld via het createTempCart -API-serviceendpoint.`string`
`order.misc3`	Extra waarde die aan de order is gekoppeld via het createTempCart -API-serviceendpoint.`string`
`order.misc4`	Extra waarde die aan de order is gekoppeld via het createTempCart -API-serviceendpoint.`string`
`order.misc5`	Extra waarde die aan de order is gekoppeld via het createTempCart -API-serviceendpoint.`string`
`order.misc6`	Extra waarde die aan de order is gekoppeld via het createTempCart -API-serviceendpoint.`string`
`order.nationalIdentifier`	Extra internationale factuuradresgegevens voor de order, indien vereist. De waarden zijn ingevoerd in Zonos Checkout.`string`
`order.notes`	Een lijst met notitiemaps; de notitiemap bevat details over de ordernotitie.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Een boolean die aangeeft of dit een door de klant aangemaakte notitie was over de order, verzending, enz.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Een `boolean` die aangeeft of deze notitie als belangrijk is gemarkeerd
`order.notes[index].note`	De inhoud van de notitie`string`
`order.optInEmail`	Geeft aan dat de klant het selectievakje “aanmelden voor onze nieuwsbrief” binnen Zonos Checkout heeft aangevinkt. Alleen van toepassing als u ervoor heeft gekozen dit selectievakje op de checkoutpagina weer te geven`boolean`
`order.orderId`	Het identificatienummer van de order in het Zonos-systeem`string`
`order.orderDate`	De timestamp (in milliseconden) van het aanmaken van de order in UTC/GMT.`millis`
`order.orderDateString`	De timestamp-tekenreeks van het aanmaken van de order in UTC/GMT.`string`
`order.orderStatus`	De status/toestand van de order in het Zonos-systeem. Zie voor meer informatie over het gebruik van `orderStatus` het document Een order ophalen. Meer informatie over de orderstatussen is te vinden in het document Een order bijwerken.`string`
`order.orderStatusDate`	De timestamp (in milliseconden) in UTC/GMT van de meest recente wijziging van `orderStatus` in het Zonos-systeem.`millis`
`order.orderStatusDateString`	De timestamp-tekenreeks in UTC/GMT van de meest recente wijziging van `orderStatus` in het Zonos-systeem.`string`
`order.paymentProcessing`	Een map met de `paymentProcessing`-details. Sommige parameters zijn mogelijk niet van toepassing op uw account en worden uitgesloten van de response.`JSON string`
`order.paymentProcessing.captureDate`	De datum van de betalingsafhandeling (capture) in milliseconden, indien beschikbaar. Als Zonos de betaling verwerkt, wordt dit knooppunt uitgesloten van de response.`millis`
`order.paymentProcessing.captureDateString`	De datum van de betalingsafhandeling (capture) als tekenreeks, indien beschikbaar. Als Zonos de betaling verwerkt, wordt dit knooppunt uitgesloten van de response.`string`
`order.paymentProcessing.cardType`	Merk van de creditcard. Als Zonos de betaling verwerkt, wordt dit knooppunt uitgesloten van de response.`string`
`order.paymentProcessing.lastFour`	De laatste vier cijfers van het creditcardnummer voor facturering. Als Zonos de betaling verwerkt, wordt dit knooppunt uitgesloten van de response.`string`
`order.paymentProcessing.paymentGateway`	Naam van de betalingsgateway. Als Zonos de betaling verwerkt, wordt “iGlobal_CC” of “iGlobal_PayPal” weergegeven.`string`
`order.paymentProcessing.transactionType`	Geeft het transactietype aan: “AUTH_CAPTURE” of “AUTH_ONLY”. Als Zonos de betaling verwerkt, wordt dit knooppunt uitgesloten van de response.`string`
`order.poNumber`	Een inkoopordernummer voor de order dat binnen Zonos Checkout is opgegeven; wordt gebruikt wanneer inkooporders zijn ingeschakeld`string`
`order.quotedDutyTaxes`	Rechten en belastingen zoals geoffreerd in Zonos Checkout, weergegeven in USD; positief getal, twee decimalen`integer`
`order.quotedDutyTaxesForeign`	Rechten en belastingen zoals geoffreerd in Zonos Checkout. Weergegeven in de afgewikkelde valuta; positief getal, twee decimalen`integer`
`order.referenceId`	Unieke `referenceId` die aan de order is gekoppeld via het createTempCart-API-serviceendpoint.`string`
`order.shipComplete`	Geeft aan of de order in meerdere delen moet worden verzonden`boolean`
`order.shippingCarrierServiceLevel`	Vervoerder- en service-level-identificatie voor de geselecteerde verzendoptie`string`
`order.shippingInstructions`	Aanpasbare instructies voor het verzendservicelevel`string`
`order.shippingTotal`	Verzendtotaal in USD; positief getal, twee decimalen `integer`
`order.shippingTotalForeign`	Verzendtotaal in de afgewikkelde valuta; positief getal, twee decimalen`integer`
`order.testOrder`	Geeft aan of de order een testorder is.`boolean`
`order.trackingNumber`	Trackingnummer dat voor de zending is gegenereerd, indien van toepassing.`string`
`order.zip`	Bestemmings-/verzendadres voor de order - de waarden zijn ingevoerd in Zonos Checkout of zijn aan de order doorgegeven via de redirect naar Zonos Checkout.`string`

Extra datatypes:

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

Boek een demo