Orderdetails

Leer hoe de Orderdetails-eindpunt werkt.

De orderDetail eindpunt wordt gebruikt om veilig de orderdetails en status van een bestelling die via de Zonos Checkout is voltooid op te halen.

Eindpunt

Opmerking: De respons-sleutels kunnen worden gewijzigd en/of er kunnen extra sleutels worden toegevoegd. Als u de eindpunt gaat gebruiken, stel dan uw code in om rekening te houden met deze mogelijkheden.

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

HTTPS-verzoek

veld	opmerkingen
HTTP-methode	POST
Eindpunt	`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 sleutel/waarde paren in de aanvraagbody

veld	opmerkingen
`orderId` OPTIONEEL, als u de `referenceId` parameter doorgeeft	De Zonos order Id kan worden doorgegeven met of zonder uw winkel Id en koppelteken (Voorbeeld: 123-45678 of 45678). Opmerking: Na voltooiing van de bestelling en betaling, wordt de klant omgeleid naar een Order Voltooiing / Bedankpagina die op uw domein is gehost. De URL bevat een querystringparameter “orderId” die deze waarde zal bevatten.`integer / string`
`referenceId` OPTIONEEL, als u de “orderId” parameter doorgeeft	Deze parameter wordt gebruikt om de gegevens van een bestelling op te zoeken aan de hand van de unieke `referenceId` die is doorgegeven in de `createTempCart` API Service eindpunt. Deze parameter moet worden weggelaten of null zijn wanneer u van plan bent de orderdetails op te zoeken op basis van de `orderId` parameter.`string`
`secret` VERPLICHT	API geheime GUID verstrekt door Zonos`string`
`storeId` VERPLICHT	Winkel ID verstrekt door Zonos.`integer`

Fout HTTP-responsen

Foutcode	bericht	betekenis
415	Ongeldig mediatype	HTML-entiteit. HTTP “Content-Type” header is ongeldig.
406	Niet Acceptabel	HTML-entiteit. HTTP “Accept” header is ongeldig.
400	Slechte aanvraag	“error”:”orderId: 999-99999 is geen geldige orderId”“error”:”Kon geen bestelling vinden met orderId: 999-99999”“error”:”Ongeldige beveiligingsreferenties”“error”:”Ongeldige postbody”“error”:”Parameter orderId of referenceId is vereist”“error”:”Kan beide parameters orderId en referenceId niet specificeren”“error”:”Geen bestelling gevonden met orderId: 999-99999”“error”:”Parameter winkel vereist”“error”:”Geen bestelling gevonden met referenceId: 999999 voor storeId: 999”“error”:”referenceId: 999999 voor storeId: 999 is gedupliceerd”“error”:”Kon bestelling met referenceId: 999999 niet ophalen”
500	Interne serverfout	“error”:”Kon de orderdetails niet verwerken”

Response JSON-definities

veld	opmerkingen
`error`	Deze parameter is alleen aanwezig wanneer er een fout is opgetreden en bevat een foutbeschrijving.`string`
`order`	Dit is een kaart van de orderdetails.`JSON string`
`order.billingZip`	Factuuradres voor de bestelling - de waarden zijn ingevoerd in de Zonos Checkout.`string`
`orderboxCount`	Dit veld beschrijft de dozen die zullen worden gebruikt om de bestelling te verzenden, doorgegeven in de createTempCart aanvraag.`string`
`order.carrierAccountNumber`	Het eigen verzendaccountnummer van een bezoeker; gebruikt wanneer verzendaccounts van bezoekers zijn ingeschakeld`string`
`order.carrierAccountShippingMethod`	De geselecteerde verzendmethode op het eigen verzendaccount van de bezoeker; gebruikt wanneer verzendaccounts van bezoekers zijn ingeschakeld`string`
`order.cslListMatch`	Gecentraliseerde Screeninglijst (CSL) match. Een boolean die aangeeft wanneer de klantinformatie een match heeft opgeleverd in de Amerikaanse Gecentraliseerde Screeninglijst en moet worden beoordeeld op mogelijke betrokkenheid bij een geweigerde partij.`boolean`
`order.customerSelectedShippingName`	Weergavenaam van de verzendoptie binnen de Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Een kaart van de douane-/belastingopdelingOpmerking - Indien van toepassing, is de IPF (Internationale Verwerkingskosten) niet inbegrepen.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Bedrag van de makelaarskosten in USD; positief drijvend getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Bedrag van de uitbetalingskosten in USD; positief drijvend getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.duty`	Douanebedrag in USD; positief drijvend getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Bedrag van de vooruitbetalingskosten in USD; positief drijvend getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	BTW/belastingbedrag op uitbetalingskosten in USD; positief drijvend getal, twee decimalen`integer`
`order.dutyTaxesBreakdown.vatTax`	BTW/belastingbedrag in USD, exclusief de BTW/belasting op de uitbetalingskosten; positief drijvend getal, twee decimalen`integer`
`order.dutyTaxesTotal`	Totaal van douane en belasting in USD; positief drijvend getal, twee decimalen`integer`
`order.foreignCurrencyCode`	De valutacode waarin de betaling van de bestelling is afgewikkeld.`string`
`remittance_amount`	Het bedrag dat moet worden overgemaakt naar een specifiek land (bijv. VK BTW).`decimal`
`order.grandTotal`	Totaalbedrag in USD; positief drijvend getal, twee decimalen`integer`
`order.grandTotalForeign`	Totaalbedrag in de afgewikkelde valuta; positief drijvend getal, twee decimalen`integer`
`order.items`	Een lijst van itemkaartenDe itemkaart bevat details over het item die zijn doorgegeven aan de Zonos Checkout bij het aanmaken van de tijdelijke winkelwagentjeVoor meer details over itemeigenschappen, raadpleeg de createTempCart API-doc`JSON string`
`order.itemsCount`	Aantal orderregelitems`integer`
`order.itemsTotal`	Totaal van items/producten in USD; positief drijvend getal, twee decimalen`integer`
`order.itemsTotalForeign`	Totaal van items/producten in de afgewikkelde valuta; positief drijvend getal, twee decimalen`integer`
`order.items[index].height`	Positief drijvend getal, twee decimalen`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Positief drijvend getal, twee decimalen`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Positief drijvend getal, twee decimalen`integer`
`order.items[index].width`	Positief drijvend getal, twee decimalen`integer`
`order.items[index].unitPrice`	Positief drijvend getal, twee decimalen`integer`
`order.merchantOrderId`	`MerchantOrderId` geassocieerd met de bestelling via de updateMerchantOrderId API service endpoint.`string`
`order.misc1`	Extra waarde geassocieerd met de bestelling via de createTempCart API service endpoint.`string`
`order.misc2`	Extra waarde geassocieerd met de bestelling via de createTempCart API service endpoint.`string`
`order.misc3`	Extra waarde geassocieerd met de bestelling via de createTempCart API service endpoint.`string`
`order.misc4`	Extra waarde geassocieerd met de bestelling via de createTempCart API service endpoint.`string`
`order.misc5`	Extra waarde geassocieerd met de bestelling via de createTempCart API service endpoint.`string`
`order.misc6`	Extra waarde geassocieerd met de bestelling via de createTempCart API service endpoint.`string`
`order.nationalIdentifier`	Extra internationale factuuradresinformatie voor de bestelling wanneer vereist. De waarden zijn ingevoerd in de Zonos Checkout.`string`
`order.notes`	Een lijst van notitiekaarten; de notitiekaart bevat details over de notitie van de bestelling.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Een boolean die aangeeft of dit een door de klant gemaakte notitie over de bestelling, verzending, enz. was.`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 voor “aanmelden voor onze nieuwsbrief” in de Zonos Checkout heeft geselecteerd. Toepasbaar alleen als u ervoor heeft gekozen om dit selectievakje op de checkout pagina weer te geven.`boolean`
`order.orderId`	Het identificatienummer van de bestelling in het Zonos systeem`string`
`order.orderDate`	De tijdstempel van de bestelling in millis in UTC/GMT.`millis`
`order.orderDateString`	De tijdstempel van de bestelling als string in UTC/GMT.`string`
`order.orderStatus`	De status/toestand van de bestelling in het Zonos systeem. Voor meer details over het gebruik van `orderStatus`, raadpleeg de Haal hier een bestellingsdocument op. Extra informatie over de bestelstatussen is te vinden in het Update hier een bestellingsdocument.`string`
`order.orderStatusDate`	De tijdstempel in millis in UTC/GMT van de meest recente `orderStatus` wijziging in het Zonos systeem.`millis`
`order.orderStatusDateString`	De tijdstempel als string in UTC/GMT van de meest recente `orderStatus` wijziging in het Zonos systeem.`string`
`order.paymentProcessing`	Een kaart van de `paymentProcessing` details. Sommige parameters zijn mogelijk niet van toepassing op uw account en worden uitgesloten van de respons.`JSON string`
`order.paymentProcessing.captureDate`	De datum van betaling vastlegging in millis, indien beschikbaar. Als Zonos de betaling verwerkt, wordt deze node uitgesloten van de respons.`millis`
`order.paymentProcessing.captureDateString`	De datum van betaling vastlegging als string, indien beschikbaar. Als Zonos de betaling verwerkt, wordt deze node uitgesloten van de respons.`string`
`order.paymentProcessing.cardType`	Creditcard merk. Als Zonos de betaling verwerkt, wordt deze node uitgesloten van de respons.`string`
`order.paymentProcessing.lastFour`	De laatste vier cijfers van het factureringscreditcardnummer. Als Zonos de betaling verwerkt, wordt deze node uitgesloten van de respons.`string`
`order.paymentProcessing.paymentGateway`	Naam van de betalingsgateway. Als Zonos de betaling verwerkt, zal dit “iGlobal_CC” of “iGlobal_PayPal” aangeven.`string`
`order.paymentProcessing.transactionType`	Geeft het type transactie aan: “AUTH_CAPTURE” of “AUTH_ONLY”. Als Zonos de betaling verwerkt, wordt deze node uitgesloten van de respons.`string`
`order.poNumber`	Een inkoopordernummer voor de bestelling die is opgegeven in de Zonos Checkout; gebruikt wanneer inkooporders zijn ingeschakeld.`string`
`order.quotedDutyTaxes`	Douane- en belastingtarieven geciteerd in de Zonos Checkout, weergegeven in USD; positieve drijvende komma, twee decimalen.`integer`
`order.quotedDutyTaxesForeign`	Douane- en belastingtarieven geciteerd in de Zonos Checkout. Weergegeven in de vereffende valuta; positieve drijvende komma, twee decimalen.`integer`
`order.referenceId`	Unieke `referenceId` die aan de bestelling is gekoppeld via de createTempCart API-service-eindpunt.`string`
`order.shipComplete`	Geeft aan of de bestelling in meerdere delen moet worden verzonden.`boolean`
`order.shippingCarrierServiceLevel`	Draag- en serviceniveau-identificatie voor de geselecteerde verzendoptie.`string`
`order.shippingInstructions`	Aanpasbare instructies voor het verzendserviceniveau.`string`
`order.shippingTotal`	Verzendkosten in USD; positieve drijvende komma, twee decimalen.`integer`
`order.shippingTotalForeign`	Verzendkosten in de vereffende valuta; positieve drijvende komma, twee decimalen.`integer`
`order.testOrder`	Geeft aan of de bestelling een testbestelling is.`boolean`
`order.trackingNumber`	Volgnummer dat voor de zending is gegenereerd, indien van toepassing.`string`
`order.zip`	Bestemmings- / verzendadres voor de bestelling - de waarden zijn ingevoerd in de Zonos Checkout of zijn doorgegeven aan de bestelling via de omleiding naar de Zonos Checkout.`string`

Aanvullende gegevenstypen:

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

Was deze pagina nuttig?

Vragen?

Neem contact met ons op.

Zie Zonos

beleid en overeenkomsten