Hva er Checkout API-endepunktet?

Checkout API-endepunktet er 'orderDetail'. Dette API-endepunktet brukes til å hente ordredetaljer og status for en ordre som er fullført via Zonos Checkout på en sikker måte.

Hva er HTTPS-forespørselen for Checkout API?

HTTPS-forespørselen for Checkout API inkluderer HTTP-metoden (POST), endepunktet ('https://api.iglobalstores.com/v2/orderDetail'), protokollen (HTTPS), meldingsformatet (JSON), og HTTP-hodene (Accept: application/json, Content-Type: application/json).

Hva er JSON nøkkel/verdi-parene i forespørselsteksten?

JSON nøkkel/verdi-parene i forespørselsteksten inkluderer 'orderId', 'referenceId', 'secret' og 'storeId'. 'orderId' og 'referenceId' er valgfritt, men en av dem må sendes. 'secret' og 'storeId' er påkrevd.

Hva er mulige feil HTTP-svar?

De mulige feil HTTP-svar inkluderer 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request), og 500 (Internal Server Error). Hver feilkode tilsvarer en spesifikk type feil.

Hva er JSON-definisjonene for respons?

JSON-definisjonene for respons inkluderer ulike parametere relatert til ordredetaljer, som 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' og mange andre. Hver parameter gir spesifikk informasjon om ordren.

Checkout•

HjemAPI-referanse Checkout REST API Ordredetaljer

Ordredetaljer

Lær hvordan Order details-endepunktet fungerer.

Endepunktet orderDetail brukes til å hente ordredetaljer og status for en ordre som er fullført via Zonos Checkout på en sikker måte.

Endepunkt

Merk: Responsnøklene kan endres og/eller flere nøkler kan legges til. Hvis du vil bruke endepunktet, bør du sette opp koden din til å tillate 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
Godta HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON nøkkel/verdi-par i forespørselsteksten

felt↕	notater↕
`orderId` VALGFRITT, hvis `referenceId`-parameter sendes	Zonos-ordre-Id kan sendes med eller uten butikk-Id og bindestrek (Eksempel: 123-45678 eller 45678). Merk: Etter ordrebekreftelse og betaling, blir kunden omdirigert til en Order Completion / Order Thank You-side som er hostet på ditt domene. URL-en inneholder en querystring-parameter "orderId" som inneholder denne verdien.`integer / string`
`referenceId` VALGFRITT, hvis "orderId"-parameter sendes	Denne parameteren brukes til å slå opp en ordres data etter den unike `referenceId` som ble sendt til `createTempCart` API Service-endepunktet. Denne parameteren bør være fraværende eller null når du skal slå opp ordredetaljer basert på `orderId`-parameteren.`string`
`secret` PÅKREVD	API-hemmelighet GUID gitt av Zonos`string`
`storeId` PÅKREVD	Butikk-ID gitt av Zonos.`integer`

Feil HTTP-svar

Feilkode↕	melding↕	betydning↕
415	Unsupported media type	HTML Entity. HTTP "Content-Type"-header er ugyldig.
406	Not Acceptable	HTML Entity. HTTP "Accept"-header er ugyldig.
400	Bad Request	"error":"orderId: 999-99999 is not a valid orderId""error":"Could not find an order with orderId: 999-99999""error":"Invalid security credentials""error":"Invalid post body""error":"Parameter orderId or referenceId is required""error":"Cannot specify both Parameters orderId and referenceId""error":"No order found with orderId: 999-99999""error":"Parameter store required""error":"No order found with referenceId: 999999 for storeId: 999""error":"referenceId: 999999 for storeId: 999 has been duplicated""error":"Couldn't retrieve order with referenceId: 999999"
500	Internal Server Error	"error":"Couldn't process order details"

Respons JSON-definisjoner

felt↕	notater↕
`error`	Denne parameteren er til stede bare når en feil har oppstått og inneholder en feilbeskrivelse.`string`
`order`	Dette er et kart over ordredetaljer.`JSON string`
`order.billingZip`	Fakturaadresse for ordre - verdiene ble tastet inn i Zonos Checkout.`string`
`orderboxCount`	Dette feltet beskriver boksene som skal brukes til å sende ordre, sendt til createTempCart forespørsel.`string`
`order.carrierAccountNumber`	En besøkendes eget transportørkontonummer; brukt når besøkendes transportørkontoer er aktivert`string`
`order.carrierAccountShippingMethod`	Den valgte shippingmetoden på besøkendes egen transportørkonto; brukt når besøkendes transportørkontoer er aktivert`string`
`order.cslListMatch`	Consolidated Screening List (CSL) match. En boolean som indikerer når kundeinfo har produsert et samsvar i US Consolidated Screening List og bør gjennomgås for mulig deniert part-tilknytning.`boolean`
`order.customerSelectedShippingName`	Shipping option display name i Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Et kart over tollgebyr/skatt-nedbryting.Merk - Hvis aktuelt, er IPF (International Processing Fee) ikke inkludert.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Meglergebyr i USD; positivt flytpunkt, to desimalplasser`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Utbetalingsgebyr i USD; positivt flytpunkt, to desimalplasser`integer`
`order.dutyTaxesBreakdown.duty`	Tollgebyr i USD; positivt flytpunkt, to desimalplasser`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Forskuddsgebyr i USD; positivt flytpunkt, to desimalplasser`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	MVA/skattbeløp på utbetalingsgebyr i USD; positivt flytpunkt, to desimalplasser`integer`
`order.dutyTaxesBreakdown.vatTax`	MVA/skattbeløp i USD, inkluderer ikke MVA/skatt på utbetalingsgebyret; positivt flytpunkt, to desimalplasser`integer`
`order.dutyTaxesTotal`	Tollgebyr og skatt totalt i USD; positivt flytpunkt, to desimalplasser`integer`
`order.foreignCurrencyCode`	Valutakoden som ordrebetalingen ble avgjort i.`string`
`remittance_amount`	Pengebeløpet som må remitteres til et spesifikt land, f.eks. _ UK MVA_.`decimal`
`order.grandTotal`	Totalt i USD; positivt flytpunkt, to desimalplasser`integer`
`order.grandTotalForeign`	Totalt i avgjort valuta; positivt flytpunkt, to desimalplasser`integer`
`order.items`	En liste over varekart.Varekartet inneholder detaljer om varen som ble sendt til Zonos Checkout ved oppretting av temp-vogn.For mer informasjon om vareegenskaper, se createTempCart API-dokumentasjonen`JSON string`
`order.itemsCount`	Antall ordrelinjevarer`integer`
`order.itemsTotal`	Varer/produkttotal i USD; positivt flytpunkt, to desimalplasser`integer`
`order.itemsTotalForeign`	Varer/produkttotal i avgjort valuta; positivt flytpunkt, to desimalplasser`integer`
`order.items[index].height`	Positivt flytpunkt, to desimalplasser`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Positivt flytpunkt, to desimalplasser`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Positivt flytpunkt, to desimalplasser`integer`
`order.items[index].width`	Positivt flytpunkt, to desimalplasser`integer`
`order.items[index].unitPrice`	Positivt flytpunkt, to desimalplasser`integer`
`order.merchantOrderId`	`MerchantOrderId` forbundet med ordre gjennom updateMerchantOrderId API-serviceendepunkt.`string`
`order.misc1`	Tilleggsverdi forbundet med ordre gjennom createTempCart API-serviceendepunkt.`string`
`order.misc2`	Tilleggsverdi forbundet med ordre gjennom createTempCart API-serviceendepunkt.`string`
`order.misc3`	Tilleggsverdi forbundet med ordre gjennom createTempCart API-serviceendepunkt.`string`
`order.misc4`	Tilleggsverdi forbundet med ordre gjennom createTempCart API-serviceendepunkt.`string`
`order.misc5`	Tilleggsverdi forbundet med ordre gjennom createTempCart API-serviceendepunkt.`string`
`order.misc6`	Tilleggsverdi forbundet med ordre gjennom createTempCart API-serviceendepunkt.`string`
`order.nationalIdentifier`	Tilleggsinternasjonal fakturaadresseinformasjon for ordre når nødvendig. Verdiene ble tastet inn i Zonos Checkout.`string`
`order.notes`	En liste over notemarkaper; notemappen inneholder detaljer om ordrenoten.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	En boolean som indikerer om dette var en kundeopprettet note om ordre, shipping osv.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	En `boolean` som indikerer om denne noten ble flagget som viktig
`order.notes[index].note`	Notinnholdet`string`
`order.optInEmail`	Indikerer at kunden valgte avkryssingsboksen for "registrer deg på vårt nyhetsbrev" i Zonos Checkout.Gjelder bare hvis du har valgt å vise denne avkryssingsboksen på sjekk-siden`boolean`
`order.orderId`	Ordrens identifikasjonsnummer i Zonos-systemet`string`
`order.orderDate`	Ordreopprettingstidsstempel millis i UTC/GMT.`millis`
`order.orderDateString`	Ordreopprettingstidsstempel streng i UTC/GMT.`string`
`order.orderStatus`	Status/tilstand for ordre i Zonos-systemet. For mer informasjon om `orderStatus`-bruk, se Hent et ordredokument her.Tilleggsinformasjon om ordrestatusene finner du i Oppdater et ordredokument her.`string`
`order.orderStatusDate`	Tidsstempel millis i UTC/GMT for den seneste `orderStatus`-endringen i Zonos-systemet.`millis`
`order.orderStatusDateString`	Tidsstempel streng i UTC/GMT for den seneste `orderStatus`-endringen i Zonos-systemet.`string`
`order.paymentProcessing`	Et kart over `paymentProcessing`-detaljer. Noen parametere gjelder kanskje ikke for din konto og vil bli ekskludert fra responsen.`JSON string`
`order.paymentProcessing.captureDate`	Datoen for betalingsfangst i millis, hvis tilgjengelig.Hvis Zonos behandler betalingen, er denne noden ekskludert fra responsen.`millis`
`order.paymentProcessing.captureDateString`	Datoen for betalingsfangst som streng, hvis tilgjengelig.Hvis Zonos behandler betalingen, er denne noden ekskludert fra responsen.`string`
`order.paymentProcessing.cardType`	Kredittkortmerke.Hvis Zonos behandler betalingen, er denne noden ekskludert fra responsen.`string`
`order.paymentProcessing.lastFour`	De siste fire sifrene i kredittkortbetalingsnummeret.Hvis Zonos behandler betalingen, er denne noden ekskludert fra responsen.`string`
`order.paymentProcessing.paymentGateway`	Betalingsgateway-navn.Hvis Zonos behandler betalingen, indikerer den "iGlobal_CC" eller "iGlobal_PayPal".`string`
`order.paymentProcessing.transactionType`	Indikerer transaksjonstype "AUTH_CAPTURE" eller "AUTH_ONLY".Hvis Zonos behandler betalingen, er denne noden ekskludert fra responsen.`string`
`order.poNumber`	Et innkjøpsordrenummer for ordren angitt i Zonos Checkout; brukt når innkjøpsordrer er aktivert`string`
`order.quotedDutyTaxes`	Tollgebyr og skatt sitert i Zonos Checkout, vises i USD; positivt flytpunkt, to desimalplasser`integer`
`order.quotedDutyTaxesForeign`	Tollgebyr og skatt sitert i Zonos Checkout. Vises i avgjort valuta; positivt flytpunkt, to desimalplasser`integer`
`order.referenceId`	Unik `referenceId` forbundet med ordre gjennom createTempCart API-serviceendepunkt.`string`
`order.shipComplete`	Indikerer om ordren skal sendes i flere deler`boolean`
`order.shippingCarrierServiceLevel`	Transportør- og servicenivåidentifikator for valgt shippingalternativ`string`
`order.shippingInstructions`	Tilpassbare instruksjoner for shippingservisenivå`string`
`order.shippingTotal`	Shipping totalt i USD; positivt flytpunkt, to desimalplasser `integer`
`order.shippingTotalForeign`	Shipping totalt i avgjort valuta; positivt flytpunkt, to desimalplasser`integer`
`order.testOrder`	Indikerer om ordren er en testordre.`boolean`
`order.trackingNumber`	Sporingsnummer generert for forsendelsen, hvis aktuelt.`string`
`order.zip`	Destinasjons-/shippingadresse for ordre - verdiene ble tastet inn i Zonos Checkout eller ble sendt til ordren gjennom omdirigering til Zonos Checkout.`string`

Tilleggsdatatyper:

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

Bestill en demo