Endepunkt
Merk: Svarnøklene kan bli endret og/eller ytterligere nøkler kan bli lagt til. Hvis du skal bruke endepunktet, vennligst sett opp koden din for å imøtekomme disse mulighetene.
POST | https://api.iglobalstores.com/v2/orderDetail
HTTPS-forespørsel
felt | notater |
---|---|
HTTP-metode | POST |
Endepunkt | https://api.iglobalstores.com/v2/orderDetail |
Protokoll | HTTPS |
Meldingsformat | JSON |
Aksepter HTTP-header | Accept: application/json |
Content-Type HTTP-header | Content-Type: application/json |
JSON nøkkel/verdi-par i forespørselens kropp
felt | notater |
---|---|
orderId VALGFRI, hvis du sender referenceId -parameter | Zonos bestillings-ID kan sendes med eller uten butikk-ID og bindestrek (Eksempel: 123-45678 eller 45678). Merk: Etter fullføring av bestilling og betaling, vil kunden bli omdirigert til en bestillingsfullførings-/takk for bestilling-siden som er vert på ditt domene. URL-en vil inneholde en spørringsparameter “orderId” som vil inneholde denne verdien.integer / string |
referenceId VALGFRI, hvis du sender “orderId”-parameter | Denne parameteren brukes til å se opp dataene til en bestilling ved hjelp av den unike referenceId sendt i createTempCart API-tjenesteendepunktet. Denne parameteren bør utelates eller være null når man har til hensikt å se opp bestillingsdetaljene basert på orderId -parameter.string |
secret PÅKREVES | API-hemmelig GUID gitt av Zonosstring |
storeId PÅKREVES | Butikk-ID gitt av Zonos.integer |
Feil HTTP-responser
Feilkode | melding | betydning |
---|---|---|
415 | Ugyldig medietype | HTML-enhet. HTTP “Content-Type” header er ugyldig. |
406 | Ikke akseptabel | HTML-enhet. HTTP “Accept” header er ugyldig. |
400 | Ugyldig forespørsel | “error”:”orderId: 999-99999 er ikke en gyldig orderId”“error”:”Kunne ikke finne en bestilling med orderId: 999-99999”“error”:”Ugyldige sikkerhetslegitimasjoner”“error”:”Ugyldig postkropp”“error”:”Parameter orderId eller referenceId er påkrevd”“error”:”Kan ikke spesifisere begge parameterne orderId og referenceId”“error”:”Ingen bestilling funnet med orderId: 999-99999”“error”:”Parameter butikk påkrevd”“error”:”Ingen bestilling funnet med referenceId: 999999 for storeId: 999”“error”:”referenceId: 999999 for storeId: 999 har blitt duplisert”“error”:”Kunne ikke hente bestilling med referenceId: 999999” |
500 | Intern serverfeil | “error”:”Kunne ikke behandle bestillingsdetaljer” |
Respons JSON-definisjoner
felt | notater |
---|---|
error | Denne parameteren er til stede kun når det har oppstått en feil og vil inneholde en feilmelding.string |
order | Dette er et kart over ordredetaljene.JSON string |
order.billingZip | Fakturaadresse for bestillingen - verdiene ble skrevet inn i Zonos Checkout.string |
orderboxCount | Dette feltet beskriver boksene som vil bli brukt til å sende bestillingen, sendt inn i createTempCart forespørselen.string |
order.carrierAccountNumber | En besøkers eget fraktfirma konto nummer; brukt når besøkerens fraktkontoer er aktivertstring |
order.carrierAccountShippingMethod | Den valgte fraktmetoden på besøkerens eget fraktfirma konto; brukt når besøkerens fraktkontoer er aktivertstring |
order.cslListMatch | Konsolidert screeningliste (CSL) samsvar. En boolsk verdi som indikerer når kundeinformasjonen har produsert et samsvar i den amerikanske konsoliderte screeninglisten og bør vurderes for mulig tilknytning til nektede parter.boolean |
order.customerSelectedShippingName | Fraktalternativets visningsnavn inne i Zonos Checkoutstring |
order.dutyTaxesBreakdown | Et kart over avgifts-/skatteoppdelingen. Merk - Hvis aktuelt, er IPF (Internasjonal behandlingsavgift) ikke inkludert.JSON string |
order.dutyTaxesBreakdown.brokerageFee | Megleravgift i USD; positivt flyttall, to desimalerinteger |
order.dutyTaxesBreakdown.dispursementFee | Utbetalingsavgift i USD; positivt flyttall, to desimalerinteger |
order.dutyTaxesBreakdown.duty | Avgiftsbeløp i USD; positivt flyttall, to desimalerinteger |
order.dutyTaxesBreakdown.prepaymentFee | Forhåndsbetalingsavgift i USD; positivt flyttall, to desimalerinteger |
order.dutyTaxesBreakdown.vatOnDispursementFee | MVA/avgiftsbeløp på utbetalingsavgift i USD; positivt flyttall, to desimalerinteger |
order.dutyTaxesBreakdown.vatTax | MVA/avgiftsbeløp i USD, inkluderer ikke MVA/avgiften på utbetalingsavgiften; positivt flyttall, to desimalerinteger |
order.dutyTaxesTotal | Totalt avgift og skatt i USD; positivt flyttall, to desimalerinteger |
order.foreignCurrencyCode | Valutakoden som bestillingsbetalingen ble gjort i.string |
remittance_amount | Beløpet som må overføres til et spesifikt land (f.eks. UK MVA).decimal |
order.grandTotal | Totalbeløp i USD; positivt flyttall, to desimalerinteger |
order.grandTotalForeign | Totalbeløp i den avregnede valutaen; positivt flyttall, to desimalerinteger |
order.items | En liste over varekart. Varekartet inneholder detaljer om varen som ble sendt til Zonos Checkout ved opprettelse av midlertidig handlekurv. For mer informasjon om vareegenskaper, vennligst se createTempCart API-dokumentasjonenJSON string |
order.itemsCount | Antall ordrelinjerinteger |
order.itemsTotal | Vare-/produkttotal i USD; positivt flyttall, to desimalerinteger |
order.itemsTotalForeign | Vare-/produkttotal i den avregnede valutaen; positivt flyttall, to desimalerinteger |
order.items[index].height | Positivt flyttall, to desimalerinteger |
order.items[index].itemNonShippable | boolean |
order.items[index].length | Positivt flyttall, to desimalerinteger |
order.items[index].quantity | integer |
order.items[index].weight | Positiv flyttall, to desimalerinteger |
order.items[index].width | Positiv flyttall, to desimalerinteger |
order.items[index].unitPrice | Positiv flyttall, to desimalerinteger |
order.merchantOrderId | MerchantOrderId assosiert med bestillingen gjennom updateMerchantOrderId API-tjenestepunktet.string |
order.misc1 | Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string |
order.misc2 | Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string |
order.misc3 | Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string |
order.misc4 | Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string |
order.misc5 | Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string |
order.misc6 | Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string |
order.nationalIdentifier | Ekstra internasjonal faktureringsadresseinformasjon for bestillingen når det er nødvendig. Verdiene ble lagt inn i Zonos Checkout.string |
order.notes | En liste over notatkart; notatkartet inneholder detaljer om bestillingsnotatet.JSON string |
order.notes[index].createdByUser | string |
order.notes[index].customerNote | En boolsk verdi som indikerer om dette var et kundelaget notat om bestillingen, frakt, osv.boolean |
order.notes[index].dateCreated | millis |
order.notes[index].dateCreatedString | string |
order.notes[index].flagged | En boolean som indikerer om dette notatet ble flagget som viktig |
order.notes[index].note | Innholdet i notatetstring |
order.optInEmail | Indikerer at kunden valgte avmerkingsboksen for “meld deg på vårt nyhetsbrev” inne i Zonos Checkout. Gjelder kun hvis du har valgt å vise denne avmerkingsboksen på checkout-sidenboolean |
order.orderId | Bestillingens identifikasjonsnummer i Zonos-systemetstring |
order.orderDate | Tidsstempelet for bestillingens opprettelse i millis i UTC/GMT.millis |
order.orderDateString | Tidsstempelet for bestillingens opprettelse som streng i UTC/GMT.string |
order.orderStatus | Status/tilstand for bestillingen i Zonos-systemet. For mer informasjon om bruken av orderStatus , vennligst se Hent et bestillingsdokument her. Ytterligere informasjon om bestillingsstatusene kan finnes i Oppdater et bestillingsdokument her.string |
order.orderStatusDate | Tidsstempelet i millis i UTC/GMT for den nyeste orderStatus -endringen i Zonos-systemet.millis |
order.orderStatusDateString | Tidsstempelet som streng i UTC/GMT for den nyeste orderStatus -endringen i Zonos-systemet.string |
order.paymentProcessing | Et kart over detaljene for paymentProcessing . Noen parametere kan være ikke-gjeldende for kontoen din og vil bli utelatt fra svaret.JSON string |
order.paymentProcessing.captureDate | Datoen for betalingsbehandling i millis, hvis tilgjengelig. Hvis Zonos behandler betalingen, vil denne noden bli utelatt fra svaret.millis |
order.paymentProcessing.captureDateString | Datoen for betalingsbehandling som streng, hvis tilgjengelig. Hvis Zonos behandler betalingen, vil denne noden bli utelatt fra svaret.string |
order.paymentProcessing.cardType | Kredittkortmerke. Hvis Zonos behandler betalingen, vil denne noden bli utelatt fra svaret.string |
order.paymentProcessing.lastFour | De siste fire sifrene av kredittkortnummeret for fakturering. Hvis Zonos behandler betalingen, ekskluderes denne noden fra svaret.string |
order.paymentProcessing.paymentGateway | Navn på betalingsgateway. Hvis Zonos behandler betalingen, vil det indikere “iGlobal_CC” eller “iGlobal_PayPal”.string |
order.paymentProcessing.transactionType | Indikerer transaksjonstypen “AUTH_CAPTURE” eller “AUTH_ONLY”. Hvis Zonos behandler betalingen, ekskluderes denne noden fra svaret.string |
order.poNumber | Et innkjøpsordrenummer for bestillingen spesifisert inne i Zonos Checkout; brukes når innkjøpsordrer er aktivertstring |
order.quotedDutyTaxes | Toll og skatt sitert i Zonos Checkout, vist i USD; positivt flyttall, to desimalerinteger |
order.quotedDutyTaxesForeign | Toll og skatt sitert i Zonos Checkout. Vist i avregnet valuta; positivt flyttall, to desimalerinteger |
order.referenceId | Unik referenceId knyttet til bestillingen gjennom createTempCart API-tjenestepunktet.string |
order.shipComplete | Indikerer om bestillingen skal sendes i flere delerboolean |
order.shippingCarrierServiceLevel | Transportør- og tjenestenivåidentifikator for det valgte fraktalternativetstring |
order.shippingInstructions | Tilpassbare instruksjoner for frakttjenestenivåetstring |
order.shippingTotal | Frakt totalt i USD; positivt flyttall, to desimaler integer |
order.shippingTotalForeign | Frakt totalt i den avregnede valutaen; positivt flyttall, to desimalerinteger |
order.testOrder | Indikerer om bestillingen er en testbestilling.boolean |
order.trackingNumber | Sporingsnummer generert for forsendelsen, hvis aktuelt.string |
order.zip | Destinasjon / fraktadresse for bestillingen - verdiene ble skrevet inn i Zonos Checkout eller ble sendt til bestillingen gjennom omdirigeringen til Zonos Checkout.string |
Ytterligere 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
Bestillingsdetaljer
Lær hvordan bestillingsdetaljer-endepunktet fungerer.orderDetail
-endepunktet brukes til å sikkert hente bestillingsdetaljer og status for en bestilling fullført via Zonos Checkout.