DOCS

Order details

/

Bestillingsdetaljer

Lær hvordan bestillingsdetaljer-endepunktet fungerer.

orderDetail-endepunktet brukes til å sikkert hente bestillingsdetaljer og status for en bestilling fullført via Zonos Checkout.

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

feltnotater
HTTP-metodePOST
Endepunkthttps://api.iglobalstores.com/v2/orderDetail
ProtokollHTTPS
MeldingsformatJSON
Aksepter HTTP-headerAccept: application/json
Content-Type HTTP-headerContent-Type: application/json

JSON nøkkel/verdi-par i forespørselens kropp

feltnotater
orderId VALGFRI, hvis du sender referenceId-parameterZonos 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”-parameterDenne 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ÅKREVESAPI-hemmelig GUID gitt av Zonosstring
storeId PÅKREVESButikk-ID gitt av Zonos.integer

Feil HTTP-responser

Feilkodemeldingbetydning
415Ugyldig medietypeHTML-enhet. HTTP “Content-Type” header er ugyldig.
406Ikke akseptabelHTML-enhet. HTTP “Accept” header er ugyldig.
400Ugyldig 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”
500Intern serverfeil“error”:”Kunne ikke behandle bestillingsdetaljer”

Respons JSON-definisjoner

feltnotater
errorDenne parameteren er til stede kun når det har oppstått en feil og vil inneholde en feilmelding.string
orderDette er et kart over ordredetaljene.JSON string
order.billingZipFakturaadresse for bestillingen - verdiene ble skrevet inn i Zonos Checkout.string
orderboxCountDette feltet beskriver boksene som vil bli brukt til å sende bestillingen, sendt inn i createTempCart forespørselen.string
order.carrierAccountNumberEn besøkers eget fraktfirma konto nummer; brukt når besøkerens fraktkontoer er aktivertstring
order.carrierAccountShippingMethodDen valgte fraktmetoden på besøkerens eget fraktfirma konto; brukt når besøkerens fraktkontoer er aktivertstring
order.cslListMatchKonsolidert 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.customerSelectedShippingNameFraktalternativets visningsnavn inne i Zonos Checkoutstring
order.dutyTaxesBreakdownEt kart over avgifts-/skatteoppdelingen. Merk - Hvis aktuelt, er IPF (Internasjonal behandlingsavgift) ikke inkludert.JSON string
order.dutyTaxesBreakdown.brokerageFeeMegleravgift i USD; positivt flyttall, to desimalerinteger
order.dutyTaxesBreakdown.dispursementFeeUtbetalingsavgift i USD; positivt flyttall, to desimalerinteger
order.dutyTaxesBreakdown.dutyAvgiftsbeløp i USD; positivt flyttall, to desimalerinteger
order.dutyTaxesBreakdown.prepaymentFeeForhåndsbetalingsavgift i USD; positivt flyttall, to desimalerinteger
order.dutyTaxesBreakdown.vatOnDispursementFeeMVA/avgiftsbeløp på utbetalingsavgift i USD; positivt flyttall, to desimalerinteger
order.dutyTaxesBreakdown.vatTaxMVA/avgiftsbeløp i USD, inkluderer ikke MVA/avgiften på utbetalingsavgiften; positivt flyttall, to desimalerinteger
order.dutyTaxesTotalTotalt avgift og skatt i USD; positivt flyttall, to desimalerinteger
order.foreignCurrencyCodeValutakoden som bestillingsbetalingen ble gjort i.string
remittance_amountBeløpet som må overføres til et spesifikt land (f.eks. UK MVA).decimal
order.grandTotalTotalbeløp i USD; positivt flyttall, to desimalerinteger
order.grandTotalForeignTotalbeløp i den avregnede valutaen; positivt flyttall, to desimalerinteger
order.itemsEn 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.itemsCountAntall ordrelinjerinteger
order.itemsTotalVare-/produkttotal i USD; positivt flyttall, to desimalerinteger
order.itemsTotalForeignVare-/produkttotal i den avregnede valutaen; positivt flyttall, to desimalerinteger
order.items[index].heightPositivt flyttall, to desimalerinteger
order.items[index].itemNonShippableboolean
order.items[index].lengthPositivt flyttall, to desimalerinteger
order.items[index].quantityinteger
order.items[index].weightPositiv flyttall, to desimalerinteger
order.items[index].widthPositiv flyttall, to desimalerinteger
order.items[index].unitPricePositiv flyttall, to desimalerinteger
order.merchantOrderIdMerchantOrderId assosiert med bestillingen gjennom updateMerchantOrderId API-tjenestepunktet.string
order.misc1Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string
order.misc2Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string
order.misc3Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string
order.misc4Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string
order.misc5Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string
order.misc6Ekstra verdi assosiert med bestillingen gjennom createTempCart API-tjenestepunktet.string
order.nationalIdentifierEkstra internasjonal faktureringsadresseinformasjon for bestillingen når det er nødvendig. Verdiene ble lagt inn i Zonos Checkout.string
order.notesEn liste over notatkart; notatkartet inneholder detaljer om bestillingsnotatet.JSON string
order.notes[index].createdByUserstring
order.notes[index].customerNoteEn boolsk verdi som indikerer om dette var et kundelaget notat om bestillingen, frakt, osv.boolean
order.notes[index].dateCreatedmillis
order.notes[index].dateCreatedStringstring
order.notes[index].flaggedEn boolean som indikerer om dette notatet ble flagget som viktig
order.notes[index].noteInnholdet i notatetstring
order.optInEmailIndikerer 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.orderIdBestillingens identifikasjonsnummer i Zonos-systemetstring
order.orderDateTidsstempelet for bestillingens opprettelse i millis i UTC/GMT.millis
order.orderDateStringTidsstempelet for bestillingens opprettelse som streng i UTC/GMT.string
order.orderStatusStatus/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.orderStatusDateTidsstempelet i millis i UTC/GMT for den nyeste orderStatus-endringen i Zonos-systemet.millis
order.orderStatusDateStringTidsstempelet som streng i UTC/GMT for den nyeste orderStatus-endringen i Zonos-systemet.string
order.paymentProcessingEt 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.captureDateDatoen for betalingsbehandling i millis, hvis tilgjengelig. Hvis Zonos behandler betalingen, vil denne noden bli utelatt fra svaret.millis
order.paymentProcessing.captureDateStringDatoen for betalingsbehandling som streng, hvis tilgjengelig. Hvis Zonos behandler betalingen, vil denne noden bli utelatt fra svaret.string
order.paymentProcessing.cardTypeKredittkortmerke. Hvis Zonos behandler betalingen, vil denne noden bli utelatt fra svaret.string
order.paymentProcessing.lastFourDe siste fire sifrene av kredittkortnummeret for fakturering. Hvis Zonos behandler betalingen, ekskluderes denne noden fra svaret.string
order.paymentProcessing.paymentGatewayNavn på betalingsgateway. Hvis Zonos behandler betalingen, vil det indikere “iGlobal_CC” eller “iGlobal_PayPal”.string
order.paymentProcessing.transactionTypeIndikerer transaksjonstypen “AUTH_CAPTURE” eller “AUTH_ONLY”. Hvis Zonos behandler betalingen, ekskluderes denne noden fra svaret.string
order.poNumberEt innkjøpsordrenummer for bestillingen spesifisert inne i Zonos Checkout; brukes når innkjøpsordrer er aktivertstring
order.quotedDutyTaxesToll og skatt sitert i Zonos Checkout, vist i USD; positivt flyttall, to desimalerinteger
order.quotedDutyTaxesForeignToll og skatt sitert i Zonos Checkout. Vist i avregnet valuta; positivt flyttall, to desimalerinteger
order.referenceIdUnik referenceId knyttet til bestillingen gjennom createTempCart API-tjenestepunktet.string
order.shipCompleteIndikerer om bestillingen skal sendes i flere delerboolean
order.shippingCarrierServiceLevelTransportør- og tjenestenivåidentifikator for det valgte fraktalternativetstring
order.shippingInstructionsTilpassbare instruksjoner for frakttjenestenivåetstring
order.shippingTotalFrakt totalt i USD; positivt flyttall, to desimaler integer
order.shippingTotalForeignFrakt totalt i den avregnede valutaen; positivt flyttall, to desimalerinteger
order.testOrderIndikerer om bestillingen er en testbestilling.boolean
order.trackingNumberSporingsnummer generert for forsendelsen, hvis aktuelt.string
order.zipDestinasjon / 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

Var denne siden nyttig?