Ordreoplysninger

Lær hvordan endpointet for ordreoplysninger fungerer.

orderDetail endpointet bruges til sikkert at hente ordreoplysninger og status for en ordre, der er gennemført via Zonos Checkout.

Endpoint

Bemærk: Svarnøglerne kan blive ændret og/eller yderligere nøgler kan blive tilføjet. Hvis du vil bruge endpointet, skal du indstille din kode til at tage højde for disse muligheder.

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

HTTPS-anmodning

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

JSON nøgle/værdi-par i anmodningskroppen

felt	noter
`orderId` VALGFRI, hvis du sender `referenceId` parameter	Zonos ordre Id kan sendes med eller uden din butik Id og bindestreg (Eksempel: 123-45678 eller 45678). Bemærk: Efter ordreafslutning og betaling vil kunden blive omdirigeret til en Ordreafslutning / Tak for ordren-side, der er hostet på dit domæne. URL'en vil indeholde en forespørgselsparameter “orderId”, der vil indeholde denne værdi.`integer / string`
`referenceId` VALGFRI, hvis du sender “orderId” parameter	Denne parameter bruges til at slå en ordres data op ved den unikke `referenceId`, der blev sendt i `createTempCart` API Service endpointet. Denne parameter bør udelades eller være null, når du har til hensigt at slå ordreoplysningerne op baseret på `orderId` parameter.`string`
`secret` PÅKRÆVET	API hemmelig GUID leveret af Zonos`string`
`storeId` PÅKRÆVET	Butik ID leveret af Zonos.`integer`

Fejl HTTP-svar

Fejlkode	besked	betydning
415	Unsupported media type	HTML-enhed. HTTP “Content-Type” header er ugyldig.
406	Not Acceptable	HTML-enhed. HTTP “Accept” header er ugyldig.
400	Bad Request	“error”:”orderId: 999-99999 er ikke en gyldig orderId”“error”:”Kunne ikke finde en ordre med orderId: 999-99999”“error”:”Ugyldige sikkerhedscertifikater”“error”:”Ugyldigt postkrop”“error”:”Parameter orderId eller referenceId er påkrævet”“error”:”Kan ikke angive begge parametre orderId og referenceId”“error”:”Ingen ordre fundet med orderId: 999-99999”“error”:”Parameter butik 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 referenceId: 999999”
500	Internal Server Error	“error”:”Kunne ikke behandle ordreoplysninger”

Response JSON definitioner

felt	noter
`error`	Denne parameter er kun til stede, når der er opstået en fejl, og vil indeholde en fejlbeschreibung.`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 kasser, der vil blive brugt til at sende ordren, sendt ind i createTempCart anmodningen.`string`
`order.carrierAccountNumber`	En besøgendes eget fragtfirma konto nummer; bruges når besøgendes fragtfirma konti er aktiveret`string`
`order.carrierAccountShippingMethod`	Den valgte forsendelsesmetode på besøgendes eget fragtfirma konto; bruges når besøgendes fragtfirma konti er aktiveret`string`
`order.cslListMatch`	Konsolideret Screening Liste (CSL) match. En boolean, der angiver, hvornår kundeoplysningerne har givet et match i den amerikanske Konsoliderede Screening Liste og bør gennemgås for mulig nægtet part affiliation.`boolean`
`order.customerSelectedShippingName`	Forsendelsesmulighedens visningsnavn inde i Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Et kort over told-/skatteopdelingen. Bemærk - Hvis relevant, er IPF (International Processing Fee) ikke inkluderet.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Mæglergebyr beløb i USD; positivt flydende punkt, to decimaler`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Udbetalingsgebyr beløb i USD; positivt flydende punkt, to decimaler`integer`
`order.dutyTaxesBreakdown.duty`	Toldbeløb i USD; positivt flydende punkt, to decimaler`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Forudbetalingsgebyr beløb i USD; positivt flydende punkt, to decimaler`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	MOMS/skattebeløb på udbetalingsgebyr i USD; positivt flydende punkt, to decimaler`integer`
`order.dutyTaxesBreakdown.vatTax`	MOMS/skattebeløb i USD, inkluderer ikke MOMS/skatten på udbetalingsgebyret; positivt flydende punkt, to decimaler`integer`
`order.dutyTaxesTotal`	Told- og skattetotal i USD; positivt flydende punkt, to decimaler`integer`
`order.foreignCurrencyCode`	Valutakoden, som ordrebetalingen blev afregnet i.`string`
`remittance_amount`	Det beløb, der skal overføres til et specifikt land (f.eks. UK VAT).`decimal`
`order.grandTotal`	Grand total i USD; positivt flydende punkt, to decimaler`integer`
`order.grandTotalForeign`	Grand total i afregnet valuta; positivt flydende punkt, to decimaler`integer`
`order.items`	En liste over varekort. Varekortet indeholder detaljer om varen, der blev sendt til Zonos Checkout ved oprettelse af temp-kurv. For flere detaljer om vareegenskaber, se venligst createTempCart API-dokumentationen`JSON string`
`order.itemsCount`	Antal ordrelinjevarer`integer`
`order.itemsTotal`	Vare-/produkt total i USD; positivt flydende punkt, to decimaler`integer`
`order.itemsTotalForeign`	Vare-/produkt total i den afregnede valuta; positivt flydende punkt, to decimaler`integer`
`order.items[index].height`	Positivt flydende punkt, to decimaler`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Positivt flydende punkt, to decimaler`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Positivt flydende punkt, to decimaler`integer`
`order.items[index].width`	Positivt flydende punkt, to decimaler`integer`
`order.items[index].unitPrice`	Positivt flydende punkt, to decimaler`integer`
`order.merchantOrderId`	`MerchantOrderId` tilknyttet ordren gennem updateMerchantOrderId API service endpoint.`string`
`order.misc1`	Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.`string`
`order.misc2`	Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.`string`
`order.misc3`	Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.`string`
`order.misc4`	Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.`string`
`order.misc5`	Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.`string`
`order.misc6`	Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.`string`
`order.nationalIdentifier`	Yderligere international faktureringsadresseinformation for ordren, når det er nødvendigt. Værdierne blev indtastet i Zonos Checkout.`string`
`order.notes`	En liste over notekort; notekortet indeholder detaljer om ordrenote.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	En boolesk værdi, der angiver, om dette var en kundeskabt note om ordren, forsendelse osv.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	En `boolean` der angiver, om denne note blev markeret som vigtig
`order.notes[index].note`	Noteindhold`string`
`order.optInEmail`	Angiver, at kunden har valgt afkrydsningsfeltet for “tilmeld dig vores nyhedsbrev” inde i Zonos Checkout. Gælder kun, hvis du har valgt at vise dette afkrydsningsfelt på checkout siden`boolean`
`order.orderId`	Ordrenummeret i Zonos systemet`string`
`order.orderDate`	Ordreoprettelsestidspunkt i millis i UTC/GMT.`millis`
`order.orderDateString`	Ordreoprettelsestidspunkt som streng i UTC/GMT.`string`
`order.orderStatus`	Status/tilstand for ordren i Zonos systemet. For flere detaljer om `orderStatus` brug, bedes du gennemgå Hent en ordre dokument her. Yderligere information om ordrestatusser kan findes i Opdater en ordre dokument her.`string`
`order.orderStatusDate`	Tidsstempel millis i UTC/GMT for den seneste `orderStatus` ændring i Zonos systemet.`millis`
`order.orderStatusDateString`	Tidsstempel som streng i UTC/GMT for den seneste `orderStatus` ændring i Zonos systemet.`string`
`order.paymentProcessing`	Et kort over `paymentProcessing` detaljer. Nogle parametre er muligvis ikke relevante for din konto og vil blive udeladt fra svaret.`JSON string`
`order.paymentProcessing.captureDate`	Datoen for betalingsfangst i millis, hvis tilgængelig. Hvis Zonos behandler betalingen, udelades denne node fra svaret.`millis`
`order.paymentProcessing.captureDateString`	Datoen for betalingsfangst som streng, hvis tilgængelig. Hvis Zonos behandler betalingen, udelades denne node fra svaret.`string`
`order.paymentProcessing.cardType`	Kreditkortmærke. Hvis Zonos behandler betalingen, udelades denne node fra svaret.`string`
`order.paymentProcessing.lastFour`	De sidste fire cifre af kreditkortnummeret til fakturering. Hvis Zonos behandler betalingen, udelukkes denne node fra svaret. `string`
`order.paymentProcessing.paymentGateway`	Betalingsgateway navn. Hvis Zonos behandler betalingen, vil det angive “iGlobal_CC” eller “iGlobal_PayPal”. `string`
`order.paymentProcessing.transactionType`	Angiver transaktionstypen “AUTH_CAPTURE” eller “AUTH_ONLY”. Hvis Zonos behandler betalingen, udelukkes denne node fra svaret. `string`
`order.poNumber`	Et indkøbsordrenummer for ordren angivet inde i Zonos Checkout; bruges når indkøbsordrer er aktiveret. `string`
`order.quotedDutyTaxes`	Told og skat citeret i Zonos Checkout, vist i USD; positivt flydende punkt, to decimaler. `integer`
`order.quotedDutyTaxesForeign`	Told og skat citeret i Zonos Checkout. Vist i den afregnede valuta; positivt flydende punkt, to decimaler. `integer`
`order.referenceId`	Unik `referenceId` tilknyttet ordren gennem createTempCart API service endpoint. `string`
`order.shipComplete`	Angiver om ordren skal sendes i flere dele. `boolean`
`order.shippingCarrierServiceLevel`	Transportør og serviceniveau identifikator for den valgte forsendelsesmulighed. `string`
`order.shippingInstructions`	Tilpassede instruktioner til forsendelsesserviceniveau. `string`
`order.shippingTotal`	Forsendelsens samlede beløb i USD; positivt flydende punkt, to decimaler. `integer`
`order.shippingTotalForeign`	Forsendelsens samlede beløb i den afregnede valuta; positivt flydende punkt, to decimaler. `integer`
`order.testOrder`	Angiver om ordren er en testordre. `boolean`
`order.trackingNumber`	Sporingsnummer genereret for forsendelsen, hvis relevant. `string`
`order.zip`	Destination / forsendelsesadresse for ordren - værdierne blev indtastet i Zonos Checkout eller blev sendt 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

Var denne side nyttig?

Spørgsmål?

Kontakt os.

Se Zonos

politikker og aftaler