Orderdetaljer

Lär dig hur endpointen för orderdetaljer fungerar.

Den orderDetail endpointen används för att säkert hämta orderdetaljer och status för en order som slutförts via Zonos Checkout.

Endpoint

Obs: Svarstangenterna kan modifieras och/eller ytterligare tangenter kan läggas till. Om du kommer att använda endpointen, vänligen ställ in din kod för att ta hänsyn till dessa möjligheter.

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

HTTPS-förfrågan

fält	anteckningar
HTTP-metod	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protokoll	HTTPS
Meddelandeformat	JSON
Accept HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON nyckel/värde-par i begärans kropp

fält	anteckningar
`orderId` VALFRI, om `referenceId` parameter passerar	Zonos order Id kan skickas med eller utan din butik Id och bindestreck (Exempel: 123-45678 eller 45678). Obs: Efter orderkomplettering och betalning kommer kunden att omdirigeras till en Order Completion / Order Thank You-sida som är värd på din domän. URL:en kommer att innehålla en querystringparameter “orderId” som kommer att innehålla detta värde.`integer / string`
`referenceId` VALFRI, om “orderId” parameter passerar	Denna parameter används för att slå upp en orders data med det unika `referenceId` som skickas i `createTempCart` API Service endpoint. Denna parameter bör lämnas bort eller vara null när man avser att slå upp orderdetaljen baserat på `orderId` parameter.`string`
`secret` KRÄVS	API-hemlig GUID som tillhandahålls av Zonos`string`
`storeId` KRÄVS	Butik ID som tillhandahålls av Zonos.`integer`

Fel HTTP-svar

Felkod	meddelande	betydelse
415	Ogiltig mediatyp	HTML-enhet. HTTP “Content-Type” header är ogiltig.
406	Inte acceptabel	HTML-enhet. HTTP “Accept” header är ogiltig.
400	Ogiltig begäran	“error”:”orderId: 999-99999 är inte en giltig orderId”“error”:”Kunde inte hitta en order med orderId: 999-99999”“error”:”Ogiltiga säkerhetsuppgifter”“error”:”Ogiltig postkropp”“error”:”Parameter orderId eller referenceId krävs”“error”:”Kan inte specificera både parametrar orderId och referenceId”“error”:”Ingen order hittades med orderId: 999-99999”“error”:”Parameter butik krävs”“error”:”Ingen order hittades med referenceId: 999999 för storeId: 999”“error”:”referenceId: 999999 för storeId: 999 har duplicerats”“error”:”Kunde inte hämta order med referenceId: 999999”
500	Internt serverfel	“error”:”Kunde inte bearbeta orderdetaljer”

Svar JSON-definitioner

fält	anteckningar
`error`	Denna parameter är endast när ett fel har inträffat och kommer att innehålla en felbeskrivning.`string`
`order`	Detta är en karta över orderdetaljer.`JSON-sträng`
`order.billingZip`	Faktureringsadress för beställningen - värdena angavs i Zonos Checkout.`string`
`orderboxCount`	Detta fält beskriver de lådor som kommer att användas för att skicka beställningen, passerade in i createTempCart begäran.`string`
`order.carrierAccountNumber`	En besökares eget fraktföretagskontonummer; används när besökarens fraktkonton är aktiverade`string`
`order.carrierAccountShippingMethod`	Den valda fraktmetoden på besökarens eget fraktföretagskonto; används när besökarens fraktkonton är aktiverade`string`
`order.cslListMatch`	Konsoliderad screeninglista (CSL) match. En boolean som indikerar när kundinformationen har gett en matchning i den amerikanska konsoliderade screeninglistan och bör granskas för eventuell nekad partstillhörighet.`boolean`
`order.customerSelectedShippingName`	Fraktalternativets visningsnamn inuti Zonos Checkout`string`
`order.dutyTaxesBreakdown`	En karta över tull-/skatteuppdelningen. Notera - Om tillämpligt ingår inte IPF (International Processing Fee).`JSON-sträng`
`order.dutyTaxesBreakdown.brokerageFee`	Avgift för mäklare i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Utbetalningsavgift i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.duty`	Tullbelopp i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Förskottsavgift i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Moms/skattebelopp på utbetalningsavgift i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.vatTax`	Moms/skattebelopp i USD, inkluderar inte moms/skatt på utbetalningsavgiften; positivt flyttal, två decimaler`integer`
`order.dutyTaxesTotal`	Totalt tull- och skattebelopp i USD; positivt flyttal, två decimaler`integer`
`order.foreignCurrencyCode`	Valutakoden som beställningsbetalningen avvecklades i.`string`
`remittance_amount`	Det belopp som behöver remitteras till ett specifikt land (t.ex. UK VAT).`decimal`
`order.grandTotal`	Totalt belopp i USD; positivt flyttal, två decimaler`integer`
`order.grandTotalForeign`	Totalt belopp i avvecklad valuta; positivt flyttal, två decimaler`integer`
`order.items`	En lista över artikelkartor. Artikelkartan innehåller detaljer om artikeln som passerades till Zonos Checkout vid skapandet av temporär kundvagn. För mer information om artikelns egenskaper, vänligen granska createTempCart API-dokumentet`JSON-sträng`
`order.itemsCount`	Antal orderlinjeposter`integer`
`order.itemsTotal`	Totalt belopp för artiklar/produkter i USD; positivt flyttal, två decimaler`integer`
`order.itemsTotalForeign`	Totalt belopp för artiklar/produkter i den avvecklade valutan; positivt flyttal, två decimaler`integer`
`order.items[index].height`	Positivt flyttal, två decimaler`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Positivt flyttal, två decimaler`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Positivt flyttal, två decimaler`integer`
`order.items[index].width`	Positivt flyttal, två decimaler`integer`
`order.items[index].unitPrice`	Positivt flyttal, två decimaler`integer`
`order.merchantOrderId`	`MerchantOrderId` kopplad till beställningen genom updateMerchantOrderId API-tjänstpunkten.`string`
`order.misc1`	Ytterligare värde kopplat till beställningen genom createTempCart API-tjänstpunkten.`string`
`order.misc2`	Ytterligare värde kopplat till beställningen genom createTempCart API-tjänstpunkten.`string`
`order.misc3`	Ytterligare värde kopplat till beställningen genom createTempCart API-tjänstpunkten.`string`
`order.misc4`	Ytterligare värde kopplat till beställningen genom createTempCart API-tjänstpunkten.`string`
`order.misc5`	Ytterligare värde kopplat till beställningen genom createTempCart API-tjänstpunkten.`string`
`order.misc6`	Ytterligare värde kopplat till beställningen genom createTempCart API-tjänstpunkten.`string`
`order.nationalIdentifier`	Ytterligare internationell faktureringsadressinformation för beställningen när det krävs. Värdena angavs i Zonos Checkout.`string`
`order.notes`	En lista över noteringskartor; noteringskartan innehåller detaljer om beställningsnoteringen.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	En boolean som indikerar om detta var en kundskapad notering om beställningen, frakt, etc.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	En `boolean` som indikerar om denna notering markerades som viktig
`order.notes[index].note`	Innehållet i noteringen`string`
`order.optInEmail`	Indikerar att kunden valde kryssrutan för “anmäla sig till vårt nyhetsbrev” inne i Zonos Checkout. Gäller endast om du har valt att visa denna kryssruta på checkout-sidan`boolean`
`order.orderId`	Beställningens identifieringsnummer i Zonos-systemet`string`
`order.orderDate`	Tidsstämpel för beställningens skapande i millis i UTC/GMT.`millis`
`order.orderDateString`	Tidsstämpel för beställningens skapande som sträng i UTC/GMT.`string`
`order.orderStatus`	Status/tillstånd för beställningen i Zonos-systemet. För mer information om användning av `orderStatus`, vänligen granska Hämta ett beställningsdokument här. Ytterligare information om beställningsstatusar kan hittas i Uppdatera ett beställningsdokument här.`string`
`order.orderStatusDate`	Tidsstämpel i millis i UTC/GMT för den senaste `orderStatus`-ändringen i Zonos-systemet.`millis`
`order.orderStatusDateString`	Tidsstämpel som sträng i UTC/GMT för den senaste `orderStatus`-ändringen i Zonos-systemet.`string`
`order.paymentProcessing`	En karta över detaljerna för `paymentProcessing`. Vissa parametrar kanske inte är tillämpliga för ditt konto och kommer att uteslutas från svaret.`JSON string`
`order.paymentProcessing.captureDate`	Datum för betalningsfångst i millis, om tillgängligt. Om Zonos behandlar betalningen, utesluts denna nod från svaret.`millis`
`order.paymentProcessing.captureDateString`	Datum för betalningsfångst som sträng, om tillgängligt. Om Zonos behandlar betalningen, utesluts denna nod från svaret.`string`
`order.paymentProcessing.cardType`	Kreditkortsvarumärke. Om Zonos behandlar betalningen, utesluts denna nod från svaret.`string`
`order.paymentProcessing.lastFour`	De sista fyra siffrorna av kreditkortnumret för fakturering. Om Zonos behandlar betalningen, utesluts denna nod från svaret.`string`
`order.paymentProcessing.paymentGateway`	Betalningsgatewayens namn. Om Zonos behandlar betalningen, kommer det att indikera “iGlobal_CC” eller “iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Indikerar transaktionstypen “AUTH_CAPTURE” eller “AUTH_ONLY”. Om Zonos behandlar betalningen, utesluts denna nod från svaret.`string`
`order.poNumber`	Ett inköpsordernummer för beställningen som specificeras inuti Zonos Checkout; används när inköpsorder är aktiverade.`string`
`order.quotedDutyTaxes`	Tull och skatt som anges i Zonos Checkout, visas i USD; positivt flyttal, två decimaler.`integer`
`order.quotedDutyTaxesForeign`	Tull och skatt som anges i Zonos Checkout. Visas i den avräknade valutan; positivt flyttal, två decimaler.`integer`
`order.referenceId`	Unik `referenceId` kopplad till beställningen genom createTempCart API-tjänstpunkt.`string`
`order.shipComplete`	Indikerar om beställningen ska skickas i flera delar.`boolean`
`order.shippingCarrierServiceLevel`	Identifierare för transportör och servicenivå för det valda fraktalternativet.`string`
`order.shippingInstructions`	Anpassningsbara instruktioner för fraktnivån.`string`
`order.shippingTotal`	Fraktkostnad i USD; positivt flyttal, två decimaler.`integer`
`order.shippingTotalForeign`	Fraktkostnad i den avräknade valutan; positivt flyttal, två decimaler.`integer`
`order.testOrder`	Indikerar om beställningen är en testbeställning.`boolean`
`order.trackingNumber`	Spårningsnummer som genererats för försändelsen, om tillämpligt.`string`
`order.zip`	Destination / fraktadress för beställningen - värdena angavs i Zonos Checkout eller överfördes till beställningen genom omdirigering till Zonos Checkout.`string`

Ytterligare 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 den här sidan hjälpsam?

Frågor?

Kontakta oss.

Se Zonos

policyer och avtal