DOCS

Order details

/

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

feltnoter
HTTP-metodePOST
Endpointhttps://api.iglobalstores.com/v2/orderDetail
ProtokolHTTPS
MeddelelsesformatJSON
Accept HTTP-headerAccept: application/json
Content-Type HTTP-headerContent-Type: application/json

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

feltnoter
orderId VALGFRI, hvis du sender referenceId parameterZonos 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” parameterDenne 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ÆVETAPI hemmelig GUID leveret af Zonosstring
storeId PÅKRÆVETButik ID leveret af Zonos.integer

Fejl HTTP-svar

Fejlkodebeskedbetydning
415Unsupported media typeHTML-enhed. HTTP “Content-Type” header er ugyldig.
406Not AcceptableHTML-enhed. HTTP “Accept” header er ugyldig.
400Bad 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”
500Internal Server Error“error”:”Kunne ikke behandle ordreoplysninger”

Response JSON definitioner

feltnoter
errorDenne parameter er kun til stede, når der er opstået en fejl, og vil indeholde en fejbeskrivelse.string
orderDette er et kort over ordredetaljerne.JSON string
order.billingZipFaktureringsadresse for ordren - værdierne blev indtastet i Zonos Checkout.string
orderboxCountDette felt beskriver de kasser, der vil blive brugt til at sende ordren, sendt ind i createTempCart anmodningen.string
order.carrierAccountNumberEn besøgendes eget fragtfirma konto nummer; bruges når besøgendes fragtfirma konti er aktiveretstring
order.carrierAccountShippingMethodDen valgte forsendelsesmetode på besøgendes eget fragtfirma konto; bruges når besøgendes fragtfirma konti er aktiveretstring
order.cslListMatchKonsolideret 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.customerSelectedShippingNameForsendelsesmulighedens visningsnavn inde i Zonos Checkoutstring
order.dutyTaxesBreakdownEt kort over told-/skatteopdelingen. Bemærk - Hvis relevant, er IPF (International Processing Fee) ikke inkluderet.JSON string
order.dutyTaxesBreakdown.brokerageFeeMæglergebyr beløb i USD; positivt flydende punkt, to decimalerinteger
order.dutyTaxesBreakdown.dispursementFeeUdbetalingsgebyr beløb i USD; positivt flydende punkt, to decimalerinteger
order.dutyTaxesBreakdown.dutyToldbeløb i USD; positivt flydende punkt, to decimalerinteger
order.dutyTaxesBreakdown.prepaymentFeeForudbetalingsgebyr beløb i USD; positivt flydende punkt, to decimalerinteger
order.dutyTaxesBreakdown.vatOnDispursementFeeMOMS/skattebeløb på udbetalingsgebyr i USD; positivt flydende punkt, to decimalerinteger
order.dutyTaxesBreakdown.vatTaxMOMS/skattebeløb i USD, inkluderer ikke MOMS/skatten på udbetalingsgebyret; positivt flydende punkt, to decimalerinteger
order.dutyTaxesTotalTold- og skattebeløb i USD; positivt flydende punkt, to decimalerinteger
order.foreignCurrencyCodeValutakoden, som ordrebetalingen blev afregnet i.string
remittance_amountDet beløb, der skal overføres til et specifikt land, f.eks. _ UK VAT_.decimal
order.grandTotalSamlet beløb i USD; positivt flydende punkt, to decimalerinteger
order.grandTotalForeignSamlet beløb i afregnet valuta; positivt flydende punkt, to decimalerinteger
order.itemsEn 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-dokumentationenJSON string
order.itemsCountAntal ordrelinjevarerinteger
order.itemsTotalVare-/produkt total i USD; positivt flydende punkt, to decimalerinteger
order.itemsTotalForeignVare-/produkt total i den afregnede valuta; positivt flydende punkt, to decimalerinteger
order.items[index].heightPositivt flydende punkt, to decimalerinteger
order.items[index].itemNonShippableboolean
order.items[index].lengthPositivt flydende punkt, to decimalerinteger
order.items[index].quantityinteger
order.items[index].weightPositivt flydende punkt, to decimalerinteger
order.items[index].widthPositivt flydende punkt, to decimalerinteger
order.items[index].unitPricePositivt flydende punkt, to decimalerinteger
order.merchantOrderIdMerchantOrderId tilknyttet ordren gennem updateMerchantOrderId API service endpoint.string
order.misc1Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.string
order.misc2Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.string
order.misc3Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.string
order.misc4Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.string
order.misc5Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.string
order.misc6Yderligere værdi tilknyttet ordren gennem createTempCart API service endpoint.string
order.nationalIdentifierYderligere international faktureringsadresseinformation for ordren, når det er nødvendigt. Værdierne blev indtastet i Zonos Checkout.string
order.notesEn liste over notekort; notekortet indeholder detaljer om ordrenote.JSON string
order.notes[index].createdByUserstring
order.notes[index].customerNoteEn boolesk værdi, der angiver, om dette var en kundeskabt note om ordren, forsendelse osv.boolean
order.notes[index].dateCreatedmillis
order.notes[index].dateCreatedStringstring
order.notes[index].flaggedEn boolean der angiver, om denne note blev markeret som vigtig
order.notes[index].noteNoteindholdstring
order.optInEmailAngiver, 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 sidenboolean
order.orderIdOrdrenummeret i Zonos systemetstring
order.orderDateOrdreoprettelsestidspunkt i millis i UTC/GMT.millis
order.orderDateStringOrdreoprettelsestidspunkt som streng i UTC/GMT.string
order.orderStatusStatus/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.orderStatusDateTidsstempel millis i UTC/GMT for den seneste orderStatus ændring i Zonos systemet.millis
order.orderStatusDateStringTidsstempel som streng i UTC/GMT for den seneste orderStatus ændring i Zonos systemet.string
order.paymentProcessingEt kort over paymentProcessing detaljer. Nogle parametre er muligvis ikke relevante for din konto og vil blive udeladt fra svaret.JSON string
order.paymentProcessing.captureDateDatoen for betalingsfangst i millis, hvis tilgængelig. Hvis Zonos behandler betalingen, udelades denne node fra svaret.millis
order.paymentProcessing.captureDateStringDatoen for betalingsfangst som streng, hvis tilgængelig. Hvis Zonos behandler betalingen, udelades denne node fra svaret.string
order.paymentProcessing.cardTypeKreditkortmærke. Hvis Zonos behandler betalingen, udelades denne node fra svaret.string
order.paymentProcessing.lastFourDe sidste fire cifre af kreditkortnummeret til fakturering. Hvis Zonos behandler betalingen, udelukkes denne node fra svaret. string
order.paymentProcessing.paymentGatewayBetalingsgateway navn. Hvis Zonos behandler betalingen, vil det angive “iGlobal_CC” eller “iGlobal_PayPal”. string
order.paymentProcessing.transactionTypeAngiver transaktionstypen “AUTH_CAPTURE” eller “AUTH_ONLY”. Hvis Zonos behandler betalingen, udelukkes denne node fra svaret. string
order.poNumberEt indkøbsordrenummer for ordren angivet inde i Zonos Checkout; bruges når indkøbsordrer er aktiveret. string
order.quotedDutyTaxesTold og skat citeret i Zonos Checkout, vist i USD; positivt flydende punkt, to decimaler. integer
order.quotedDutyTaxesForeignTold og skat citeret i Zonos Checkout. Vist i den afregnede valuta; positivt flydende punkt, to decimaler. integer
order.referenceIdUnik referenceId tilknyttet ordren gennem createTempCart API service endpoint. string
order.shipCompleteAngiver om ordren skal sendes i flere dele. boolean
order.shippingCarrierServiceLevelTransportør og serviceniveau identifikator for den valgte forsendelsesmulighed. string
order.shippingInstructionsTilpassede instruktioner til forsendelsesserviceniveau. string
order.shippingTotalForsendelsens samlede beløb i USD; positivt flydende punkt, to decimaler. integer
order.shippingTotalForeignForsendelsens samlede beløb i den afregnede valuta; positivt flydende punkt, to decimaler. integer
order.testOrderAngiver om ordren er en testordre. boolean
order.trackingNumberSporingsnummer genereret for forsendelsen, hvis relevant. string
order.zipDestination / 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?