Vad är slutpunkten för Checkout API?

Slutpunkten för Checkout API är 'orderDetail'. Den här API-slutpunkten används för att säkert hämta orderdetaljer och status för en order som har slutförts via Zonos Checkout.

Vilken HTTPS-begäran används för Checkout API?

HTTPS-begäran för Checkout API omfattar HTTP-metoden (POST), slutpunkten ('https://api.iglobalstores.com/v2/orderDetail'), protokollet (HTTPS), meddelandeformatet (JSON) och HTTP-huvuden (Accept: application/json, Content-Type: application/json).

Vilka JSON-nyckel-/värdepar finns i begärandetexten?

JSON-nyckel-/värdeparen i begärandetexten omfattar 'orderId', 'referenceId', 'secret' och 'storeId'. 'orderId' och 'referenceId' är valfria, men en av dem måste skickas. 'secret' och 'storeId' är obligatoriska.

Vilka HTTP-felsvar är möjliga?

Möjliga HTTP-felsvar omfattar 415 (Medietypen stöds inte), 406 (Inte acceptabelt), 400 (Felaktig begäran) och 500 (Internt serverfel). Varje felkod motsvarar en specifik feltyp.

Vilka definitioner finns i svars-JSON?

Definitionerna i svars-JSON omfattar olika parametrar kopplade till orderdetaljer, till exempel 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' och många andra. Varje parameter tillhandahåller specifik information om ordern.

Checkout•

HemAPI-referens Checkout REST API Orderdetaljer

Orderdetaljer

Lär er hur slutpunkten för orderdetaljer fungerar.

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

Slutpunkt

Obs: Svarsnycklarna kan ändras och/eller ytterligare nycklar kan läggas till. Om ni använder slutpunkten ska ni konfigurera er kod för att hantera dessa möjligheter.

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

HTTPS-begäran

fält↕	anteckningar↕
HTTP-metod	POST
Slutpunkt	`https://api.iglobalstores.com/v2/orderDetail`
Protokoll	HTTPS
Meddelandeformat	JSON
HTTP-huvud för Accept	Accept: application/json
HTTP-huvud för Content-Type	Content-Type: application/json

JSON-nyckel-/värdepar i begärandetexten

fält↕	anteckningar↕
`orderId` VALFRI, om parametern `referenceId` skickas	Zonos order-ID kan skickas med eller utan ert butiks-ID och bindestreck (exempel: 123-45678 eller 45678). Obs: När ordern har slutförts och betalats omdirigeras kunden till en sida för orderbekräftelse eller ordertack som finns på er domän. URL:en innehåller en frågesträngsparameter, ”orderId”, som innehåller detta värde.`integer / string`
`referenceId` VALFRI, om parametern ”orderId” skickas	Den här parametern används för att slå upp en orders data med det unika `referenceId` som skickas i API-tjänstens slutpunkt `createTempCart`. Parametern ska utelämnas eller vara null när ni vill slå upp orderdetaljen baserat på parametern `orderId`.`string`
`secret` OBLIGATORISK	Hemlig API-GUID som tillhandahålls av Zonos`string`
`storeId` OBLIGATORISK	Butiks-ID som tillhandahålls av Zonos.`integer`

HTTP-felsvar

Felkod↕	meddelande↕	betydelse↕
415	Medietypen stöds inte	HTML-entitet. HTTP-huvudet ”Content-Type” är ogiltigt.
406	Inte acceptabelt	HTML-entitet. HTTP-huvudet ”Accept” är ogiltigt.
400	Felaktig begäran	”error”:”orderId: 999-99999 är inte ett giltigt orderId””error”:”Kunde inte hitta en order med orderId: 999-99999””error”:”Ogiltiga säkerhetsuppgifter””error”:”Ogiltig POST-text””error”:”Parametern orderId eller referenceId krävs””error”:”Det går inte att ange både parametrarna orderId och referenceId””error”:”Ingen order hittades med orderId: 999-99999””error”:”Parametern store 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 behandla orderdetaljer”

Definitioner av svars-JSON

fält↕	anteckningar↕
`error`	Den här parametern finns endast när ett fel har inträffat och innehåller en felbeskrivning.`string`
`order`	Detta är en mappning av orderdetaljerna.`JSON string`
`order.billingZip`	Faktureringsadress för ordern – värdena angavs i Zonos Checkout.`string`
`orderboxCount`	Det här fältet beskriver de lådor som används för att skicka ordern och skickas i begäran createTempCart .`string`
`order.carrierAccountNumber`	En besökares eget kontonummer hos frakttransportören; används när besökares transportörskonton är aktiverade`string`
`order.carrierAccountShippingMethod`	Den valda fraktmetoden på besökarens eget konto hos frakttransportören; används när besökares transportörskonton är aktiverade`string`
`order.cslListMatch`	Träff i Consolidated Screening List (CSL). Ett booleskt värde som anger när kundinformationen har gett en träff i USA:s Consolidated Screening List och bör granskas för eventuell koppling till en nekad part.`boolean`
`order.customerSelectedShippingName`	Visningsnamn för fraktalternativet i Zonos Checkout`string`
`order.dutyTaxesBreakdown`	En mappning av uppdelningen av tullar/skatter. Obs: IPF (International Processing Fee) ingår inte om den är tillämplig.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Belopp för förmedlingsavgift i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Belopp för utbetalningsavgift i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.duty`	Tullbelopp i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Belopp för förskottsbetalningsavgift i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Moms-/skattebelopp på utbetalningsavgiften i USD; positivt flyttal, två decimaler`integer`
`order.dutyTaxesBreakdown.vatTax`	Moms-/skattebelopp i USD, exklusive moms/skatt på utbetalningsavgiften; positivt flyttal, två decimaler`integer`
`order.dutyTaxesTotal`	Summa för tullar och skatter i USD; positivt flyttal, två decimaler`integer`
`order.foreignCurrencyCode`	Valutakoden som orderbetalningen avräknades i.`string`
`remittance_amount`	Det belopp som behöver överföras till ett visst land, till exempel _ UK VAT_.`decimal`
`order.grandTotal`	Totalsumma i USD; positivt flyttal, två decimaler`integer`
`order.grandTotalForeign`	Totalsumma i avräkningsvalutan; positivt flyttal, två decimaler`integer`
`order.items`	En lista över artikelmappningar. Artikelmappningen innehåller information om artikeln som skickades till Zonos Checkout när den tillfälliga kundvagnen skapades. Mer information om artikelattribut finns i API-dokumentationen för createTempCart .`JSON string`
`order.itemsCount`	Antal orderrader`integer`
`order.itemsTotal`	Summa för artiklar/produkter i USD; positivt flyttal, två decimaler`integer`
`order.itemsTotalForeign`	Summa för artiklar/produkter i avräkningsvalutan; 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` som är kopplat till ordern via API-tjänstens slutpunkt updateMerchantOrderId .`string`
`order.misc1`	Ytterligare värde som är kopplat till ordern via API-tjänstens slutpunkt createTempCart .`string`
`order.misc2`	Ytterligare värde som är kopplat till ordern via API-tjänstens slutpunkt createTempCart .`string`
`order.misc3`	Ytterligare värde som är kopplat till ordern via API-tjänstens slutpunkt createTempCart .`string`
`order.misc4`	Ytterligare värde som är kopplat till ordern via API-tjänstens slutpunkt createTempCart .`string`
`order.misc5`	Ytterligare värde som är kopplat till ordern via API-tjänstens slutpunkt createTempCart .`string`
`order.misc6`	Ytterligare värde som är kopplat till ordern via API-tjänstens slutpunkt createTempCart .`string`
`order.nationalIdentifier`	Ytterligare internationell faktureringsadressinformation för ordern när det krävs. Värdena angavs i Zonos Checkout.`string`
`order.notes`	En lista över anteckningsmappningar; anteckningsmappningen innehåller information om orderanteckningen.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Ett booleskt värde som anger om detta var en kundskapad anteckning om ordern, frakten osv.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Ett `boolean` som anger om denna anteckning har markerats som viktig
`order.notes[index].note`	Anteckningens innehåll`string`
`order.optInEmail`	Anger att kunden markerade kryssrutan ”anmäl dig till vårt nyhetsbrev” i Zonos Checkout. Gäller endast om ni har valt att visa denna kryssruta på Checkout-sidan.`boolean`
`order.orderId`	Orderns identifikationsnummer i Zonos system`string`
`order.orderDate`	Tidsstämpeln för när ordern skapades i millisekunder enligt UTC/GMT.`millis`
`order.orderDateString`	Strängen för tidsstämpeln när ordern skapades enligt UTC/GMT.`string`
`order.orderStatus`	Orderns status/tillstånd i Zonos system. Mer information om användning av `orderStatus` finns i Hämta ett orderdokument här. Ytterligare information om orderstatusar finns i Uppdatera ett orderdokument här.`string`
`order.orderStatusDate`	Tidsstämpeln i millisekunder enligt UTC/GMT för den senaste ändringen av `orderStatus` i Zonos system.`millis`
`order.orderStatusDateString`	Tidsstämpelsträngen enligt UTC/GMT för den senaste ändringen av `orderStatus` i Zonos system.`string`
`order.paymentProcessing`	En mappning av informationen i `paymentProcessing`. Vissa parametrar kanske inte gäller för ert konto och utesluts från svaret.`JSON string`
`order.paymentProcessing.captureDate`	Datumet för betalningsregistrering i millisekunder, om tillgängligt. Om Zonos behandlar betalningen utesluts denna nod från svaret.`millis`
`order.paymentProcessing.captureDateString`	Datumet för betalningsregistrering som sträng, om tillgängligt. Om Zonos behandlar betalningen utesluts denna nod från svaret.`string`
`order.paymentProcessing.cardType`	Kreditkortsmärke. Om Zonos behandlar betalningen utesluts denna nod från svaret.`string`
`order.paymentProcessing.lastFour`	De sista fyra siffrorna i faktureringskortets nummer. Om Zonos behandlar betalningen utesluts denna nod från svaret.`string`
`order.paymentProcessing.paymentGateway`	Namn på betalningsgateway. Om Zonos behandlar betalningen anges ”iGlobal_CC” eller ”iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Anger transaktionstypen ”AUTH_CAPTURE” eller ”AUTH_ONLY”. Om Zonos behandlar betalningen utesluts denna nod från svaret.`string`
`order.poNumber`	Ett inköpsordernummer för ordern som anges i Zonos Checkout; används när inköpsordrar är aktiverade`string`
`order.quotedDutyTaxes`	Tullar och skatter som anges i Zonos Checkout, visas i USD; positivt flyttal, två decimaler`integer`
`order.quotedDutyTaxesForeign`	Tullar och skatter som anges i Zonos Checkout. Visas i avräkningsvalutan; positivt flyttal, två decimaler`integer`
`order.referenceId`	Unikt `referenceId` som är kopplat till ordern via API-tjänstens slutpunkt createTempCart.`string`
`order.shipComplete`	Anger om ordern 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 fraktens servicenivå`string`
`order.shippingTotal`	Fraktsumma i USD; positivt flyttal, två decimaler `integer`
`order.shippingTotalForeign`	Fraktsumma i avräkningsvalutan; positivt flyttal, två decimaler`integer`
`order.testOrder`	Anger om ordern är en testorder.`boolean`
`order.trackingNumber`	Spårningsnummer som skapats för försändelsen, om tillämpligt.`string`
`order.zip`	Destinations-/leveransadress för ordern – värdena angavs i Zonos Checkout eller skickades till ordern genom omdirigeringen 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

Boka en demo