Was ist der Checkout-API-Endpunkt?

Der Checkout-API-Endpunkt ist orderDetail. Dieser API-Endpunkt ruft sicher die Bestelldetails und den Status einer über Zonos Checkout abgeschlossenen Bestellung ab.

Wie lautet die HTTPS-Anfrage für die Checkout-API?

Die HTTPS-Anfrage für die Checkout-API umfasst die HTTP-Methode (POST), den Endpunkt (https://api.iglobalstores.com/v2/orderDetail), das Protokoll (HTTPS), das Nachrichtenformat (JSON) und die HTTP-Header (Accept: application/json, Content-Type: application/json).

Welche JSON-Schlüssel-Wert-Paare gibt es im Request-Body?

Die JSON-Schlüssel-Wert-Paare im Request-Body umfassen orderId, referenceId, secret und storeId. orderId und referenceId sind optional, aber einer von beiden muss übergeben werden. secret und storeId sind erforderlich.

Welche Fehler-HTTP-Antworten sind möglich?

Mögliche Fehler-HTTP-Antworten sind 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request) und 500 (Internal Server Error). Jeder Fehlercode entspricht einem bestimmten Fehlertyp.

Was sind die Definitionen der Antwort-JSON?

Die Antwort-JSON-Definitionen umfassen verschiedene Parameter zu Bestelldetails, z. B. error, order, order.billingZip, orderboxCount, order.carrierAccountNumber und viele weitere. Jeder Parameter liefert spezifische Bestellinformationen.

Checkout•

StartseiteAPI-Referenz Checkout REST API Bestelldetails

Bestelldetails

Erfahren Sie, wie der Bestelldetails-Endpunkt funktioniert.

Der orderDetail-Endpunkt wird verwendet, um die Bestelldetails und den Status einer über Zonos Checkout abgeschlossenen Bestellung sicher abzurufen.

Endpunkt

Hinweis: Die Antwortschlüssel können geändert und/oder zusätzliche Schlüssel hinzugefügt werden. Wenn Sie den Endpunkt verwenden, richten Sie bitte Ihren Code so ein, dass er diese Möglichkeiten berücksichtigt.

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

HTTPS-Anfrage

Feld↕	Notizen↕
HTTP-Methode	POST
Endpunkt	`https://api.iglobalstores.com/v2/orderDetail`
Protokoll	HTTPS
Nachrichtenformat	JSON
HTTP-Header akzeptieren	Akzeptieren: application/json
Inhaltstyp-HTTP-Header	Inhaltstyp: application/json

JSON-Schlüssel/Wert-Paare im Anfragetext

Feld↕	Notizen↕
`orderId` OPTIONAL, wenn `referenceId` Parameter	übergeben wird Die Bestell-ID Zonos kann mit oder ohne Ihre Shop-ID und Bindestrich übergeben werden (Beispiel: 123-45678 oder 45678). Hinweis: Nach Abschluss und Zahlung der Bestellung wird der Kunde zu einer auf Ihrer Domain gehosteten Bestellabschluss-/Bestelldankseite weitergeleitet. Die URL enthält einen Querystring-Parameter „orderId“, der diesen Wert enthält.`integer / string`
`referenceId` OPTIONAL, wenn der Parameter „orderId“	übergeben wird Dieser Parameter wird verwendet, um die Daten einer Bestellung anhand des eindeutigen `referenceId` nachzuschlagen, das im API-Service-Endpunkt `createTempCart` übergeben wird. Dieser Parameter sollte weggelassen oder null sein, wenn Sie beabsichtigen, die Bestelldetails basierend auf dem Parameter `orderId` nachzuschlagen.`string`
`secret` ERFORDERLICH	Geheime API-GUID bereitgestellt von Zonos`string`
`storeId` ERFORDERLICH	Store-ID bereitgestellt von Zonos.`integer`

Fehler bei HTTP-Antworten

Fehlercode↕	Nachricht↕	Bedeutung↕
415	Nicht unterstützter Medientyp	HTML-Entität. Der HTTP-Header „Content-Type“ ist ungültig.
406	Nicht akzeptabel	HTML-Entität. Der HTTP-Header „Accept“ ist ungültig.
400	Ungültige Anfrage	„error“: „orderId: 999-99999 ist keine gültige orderId“ „error“: „Es konnte keine Bestellung mit orderId gefunden werden: 999-99999“ „error“: „Ungültige Sicherheitsanmeldeinformationen“ „error“: „Ungültiger Beitragstext“ „error“: „Parameter orderId oder referenceId ist erforderlich“ „error“: „Es können nicht beide Parameter orderId und angegeben werden.“ referenceId““error“:“Keine Bestellung mit orderId: 999-99999 gefunden““error“:“Parameterspeicher erforderlich““error“:“Keine Bestellung mit referenceId: 999999 für storeId: 999 gefunden““error“:“referenceId: 999999 für storeId: 999 wurde dupliziert““error“:“Bestellung mit referenceId konnte nicht abgerufen werden: 999999“
500	Interner Serverfehler	„Fehler“: „Bestelldetails konnten nicht verarbeitet werden“

Antwort-JSON-Definitionen

Feld↕	Notizen↕
`error`	Dieser Parameter ist nur vorhanden, wenn ein Fehler aufgetreten ist, und enthält eine Fehlerbeschreibung.`string`
`order`	Dies ist eine Karte der Bestelldetails.`JSON string`
`order.billingZip`	Rechnungsadresse für die Bestellung – die Werte wurden in das Feld Zonos Checkout eingegeben.`string`
`orderboxCount`	Dieses Feld beschreibt die Kartons, die zum Versenden der Bestellung verwendet werden und wird an createTempCart request übergeben.`string`
`order.carrierAccountNumber`	Die Kontonummer des eigenen Spediteurs eines Besuchers; Wird verwendet, wenn Besucher-Carrier-Konten aktiviert sind`string`
`order.carrierAccountShippingMethod`	Die ausgewählte Versandart im eigenen Spediteurkonto des Besuchers; Wird verwendet, wenn Besucher-Carrier-Konten aktiviert sind`string`
`order.cslListMatch`	Übereinstimmung mit der konsolidierten Screening-Liste (CSL). Ein boolescher Wert, der angibt, wann die Kundeninformationen eine Übereinstimmung in der US Consolidated Screening List ergeben haben und auf eine mögliche Zugehörigkeit zu einer abgelehnten Partei überprüft werden sollten.`boolean`
`order.customerSelectedShippingName`	Anzeigename der Versandoption innerhalb von Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Eine Karte der Zoll-/Steueraufschlüsselung. Hinweis: Falls zutreffend, ist IPF (International Processing Fee) nicht enthalten.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Betrag der Maklergebühr in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Dispursement fee amount in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.dutyTaxesBreakdown.duty`	Zollbetrag in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Prepayment fee amount in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Mehrwertsteuer-/Steuerbetrag auf die Auszahlungsgebühr in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.dutyTaxesBreakdown.vatTax`	Der Mehrwertsteuer-/Steuerbetrag in USD beinhaltet nicht die Mehrwertsteuer/Steuer auf die Auszahlungsgebühr. positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.dutyTaxesTotal`	Zoll- und Steuersumme in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.foreignCurrencyCode`	Der Währungscode, in dem die Bestellzahlung abgewickelt wurde.`string`
`remittance_amount`	Der Geldbetrag, der in ein bestimmtes Land überwiesen werden muss, z. B. _ UK VAT_.`decimal`
`order.grandTotal`	Gesamtsumme in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.grandTotalForeign`	Gesamtsumme in abgerechneter Währung; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.items`	Eine Liste von Artikelzuordnungen. Die Artikelzuordnung enthält Details zu dem Artikel, die bei der temporären Warenkorberstellung an Zonos Checkout übergeben wurden. Weitere Einzelheiten zu Artikeleigenschaften finden Sie im createTempCart API-Dokument`JSON string`
`order.itemsCount`	Anzahl der Bestellpositionen`integer`
`order.itemsTotal`	Artikel/Produktsumme in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.itemsTotalForeign`	Artikel-/Produktsumme in der abgerechneten Währung; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.items[index].height`	Positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.items[index].width`	Positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.items[index].unitPrice`	Positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.merchantOrderId`	`MerchantOrderId` ist mit der Bestellung über den updateMerchantOrderId API-Dienstendpunkt verknüpft.`string`
`order.misc1`	Zusätzlicher Wert, der der Bestellung über den createTempCart API-Dienstendpunkt zugeordnet ist.`string`
`order.misc2`	Zusätzlicher Wert, der der Bestellung über den createTempCart API-Dienstendpunkt zugeordnet ist.`string`
`order.misc3`	Zusätzlicher Wert, der der Bestellung über den createTempCart API-Dienstendpunkt zugeordnet ist.`string`
`order.misc4`	Zusätzlicher Wert, der der Bestellung über den createTempCart API-Dienstendpunkt zugeordnet ist.`string`
`order.misc5`	Zusätzlicher Wert, der der Bestellung über den createTempCart API-Dienstendpunkt zugeordnet ist.`string`
`order.misc6`	Zusätzlicher Wert, der der Bestellung über den createTempCart API-Dienstendpunkt zugeordnet ist.`string`
`order.nationalIdentifier`	Zusätzliche Informationen zur internationalen Rechnungsadresse für die Bestellung, falls erforderlich. Die Werte wurden in das Zonos Checkout eingegeben.`string`
`order.notes`	Eine Liste von Notizkarten; Die Notizkarte enthält Details zur Bestellnotiz.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Ein boolescher Wert, der angibt, ob es sich um eine vom Kunden erstellte Notiz zur Bestellung, zum Versand usw. handelte.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Ein `boolean` zeigt an, ob diese Notiz als wichtig markiert wurde
`order.notes[index].note`	Der Notizinhalt`string`
`order.optInEmail`	Zeigt an, dass der Kunde das Kontrollkästchen „Für unseren Newsletter anmelden“ im Zonos Checkoutangewählt hat. Gilt nur, wenn Sie sich entschieden haben, dieses Kontrollkästchen auf der Checkout-Seite anzuzeigen`boolean`
`order.orderId`	Die Identifikationsnummer der Bestellung im Zonos System`string`
`order.orderDate`	Der Zeitstempel der Auftragserstellung beträgt Millisekunden in UTC/GMT.`millis`
`order.orderDateString`	Die Zeitstempelzeichenfolge für die Auftragserstellung in UTC/GMT.`string`
`order.orderStatus`	Der Status/Zustand der Bestellung im Zonos System. Weitere Einzelheiten zur Verwendung von `orderStatus` finden Sie in Retrieve an order document here. Weitere Informationen zu den Bestellstatus finden Sie in Update an order document here.`string`
`order.orderStatusDate`	Der Zeitstempel in UTC/GMT der letzten `orderStatus` Änderung im Zonos System.`millis`
`order.orderStatusDateString`	Die Zeitstempelzeichenfolge in UTC/GMT der letzten `orderStatus` Änderung im Zonos System.`string`
`order.paymentProcessing`	Eine Karte der `paymentProcessing` Details. Einige Parameter sind möglicherweise nicht auf Ihr Konto anwendbar und werden von der Antwort ausgeschlossen.`JSON string`
`order.paymentProcessing.captureDate`	Das Datum der Zahlungserfassung in Millisekunden, falls verfügbar. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.`millis`
`order.paymentProcessing.captureDateString`	Das Datum der Zahlungserfassung als Zeichenfolge, falls verfügbar. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.`string`
`order.paymentProcessing.cardType`	KreditkartenmarkeWenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.`string`
`order.paymentProcessing.lastFour`	Die letzten vier Ziffern der Rechnungskreditkartennummer. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.`string`
`order.paymentProcessing.paymentGateway`	Name des ZahlungsgatewaysWenn Zonos die Zahlung verarbeitet, wird „iGlobal_CC“ oder „iGlobal_PayPal“ angezeigt.`string`
`order.paymentProcessing.transactionType`	Gibt den Transaktionstyp „AUTH_CAPTURE“ oder „AUTH_ONLY“ an. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.`string`
`order.poNumber`	Eine Bestellnummer für die im Zonos Checkout angegebene Bestellung; Wird verwendet, wenn Bestellungen aktiviert sind`string`
`order.quotedDutyTaxes`	Im Zonos Checkout angegebene Zölle und Steuern, angezeigt in USD; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.quotedDutyTaxesForeign`	Zölle und Steuern sind im Zonos Checkout angegeben. Wird in der abgerechneten Währung angezeigt; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.referenceId`	Eindeutiges `referenceId`, das der Bestellung über den API-Service-Endpunkt createTempCart zugeordnet ist.`string`
`order.shipComplete`	Gibt an, ob die Bestellung in mehreren Teilen versendet werden soll`boolean`
`order.shippingCarrierServiceLevel`	Spediteur- und Service-Level-ID für die ausgewählte Versandoption`string`
`order.shippingInstructions`	Anpassbare Anweisungen für den Versandservicelevel`string`
`order.shippingTotal`	Gesamtversand in USD; positiver Gleitkomma, zwei Dezimalstellen `integer`
`order.shippingTotalForeign`	Gesamtversand in der abgerechneten Währung; positiver Gleitkomma, zwei Dezimalstellen`integer`
`order.testOrder`	Gibt an, ob es sich bei der Bestellung um eine Testbestellung handelt.`boolean`
`order.trackingNumber`	Gegebenenfalls für die Sendung generierte Sendungsverfolgungsnummer.`string`
`order.zip`	Ziel-/Versandadresse für die Bestellung – die Werte wurden in Zonos Checkout eingegeben oder durch die Weiterleitung an Zonos Checkout an die Bestellung übergeben.`string`

Zusätzliche Datentypen:

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

Buchen Sie eine Demo