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 diese Möglichkeiten berücksichtigt werden.
POST | https://api.iglobalstores.com/v2/orderDetail
HTTPS-Anfrage
Feld | Hinweise |
---|---|
HTTP-Methode | POST |
Endpunkt | https://api.iglobalstores.com/v2/orderDetail |
Protokoll | HTTPS |
Nachrichtenformat | JSON |
Accept HTTP-Header | Accept: application/json |
Content-Type HTTP-Header | Content-Type: application/json |
JSON-Schlüssel/Wert-Paare im Anfragetext
Feld | Hinweise |
---|---|
orderId OPTIONAL, wenn referenceId -Parameter übergeben wird | Die Zonos Bestell-ID kann mit oder ohne Ihrer Store-ID und Bindestrich übergeben werden (Beispiel: 123-45678 oder 45678). Hinweis: Nach Abschluss der Bestellung und Zahlung wird der Kunde zu einer Bestellabschluss-/Dankeseite auf Ihrer Domain weitergeleitet. Die URL enthält einen Querystring-Parameter „orderId“, der diesen Wert enthält.integer / string |
referenceId OPTIONAL, wenn „orderId“-Parameter übergeben wird | Dieser Parameter wird verwendet, um die Daten einer Bestellung anhand der eindeutigen referenceId abzurufen, die im createTempCart API-Service-Endpunkt übergeben wurde. Dieser Parameter sollte weggelassen oder auf null gesetzt werden, wenn die Bestelldetails basierend auf dem orderId -Parameter abgerufen werden sollen.string |
secret ERFORDERLICH | API-Geheim-GUID, bereitgestellt von Zonosstring |
storeId ERFORDERLICH | Store-ID, bereitgestellt von Zonos.integer |
Fehler-HTTP-Antworten
Fehlercode | Nachricht | Bedeutung |
---|---|---|
415 | Unsupported media type | HTML-Entität. HTTP „Content-Type“-Header ist ungültig. |
406 | Not Acceptable | HTML-Entität. HTTP „Accept“-Header ist ungültig. |
400 | Bad Request | „error“:„orderId: 999-99999 ist keine gültige orderId“„error“:„Konnte keine Bestellung mit orderId: 999-99999 finden“„error“:„Ungültige Sicherheitsanmeldeinformationen“„error“:„Ungültiger Anfragetext“„error“:„Parameter orderId oder referenceId ist erforderlich“„error“:„Kann nicht beide Parameter orderId und referenceId angeben“„error“:„Keine Bestellung mit orderId: 999-99999 gefunden“„error“:„Parameter store erforderlich“„error“:„Keine Bestellung mit referenceId: 999999 für storeId: 999 gefunden“„error“:„referenceId: 999999 für storeId: 999 wurde dupliziert“„error“:„Konnte Bestellung mit referenceId: 999999 nicht abrufen“ |
500 | Internal Server Error | „error“:„Konnte Bestelldetails nicht verarbeiten“ |
Definitionen der JSON-Antworten
Feld | Hinweise |
---|---|
error | Dieser Parameter wird nur angezeigt, 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 im Zonos Checkout eingegeben.string |
orderboxCount | Dieses Feld beschreibt die Kartons, die für den Versand der Bestellung verwendet werden, die in die createTempCart -Anfrage übergeben wurden.string |
order.carrierAccountNumber | Die eigene Versandträgerkontonummer eines Besuchers; wird verwendet, wenn Besucherkonten für Versandträger aktiviert sindstring |
order.carrierAccountShippingMethod | Die ausgewählte Versandmethode auf dem eigenen Versandträgerkonto des Besuchers; wird verwendet, wenn Besucherkonten für Versandträger aktiviert sindstring |
order.cslListMatch | Konsolidierte Screening-Liste (CSL) Übereinstimmung. Ein boolescher Wert, der anzeigt, wenn die Kundendaten eine Übereinstimmung in der US-Konsolidierten Screening-Liste ergeben haben und auf mögliche Verbindungen zu abgelehnten Parteien überprüft werden sollten.boolean |
order.customerSelectedShippingName | Anzeigename der Versandoption im Zonos Checkoutstring |
order.dutyTaxesBreakdown | Eine Karte der Zoll- / Steuer-AufschlüsselungHinweis - Falls zutreffend, ist die IPF (Internationale Bearbeitungsgebühr) nicht enthalten.JSON string |
order.dutyTaxesBreakdown.brokerageFee | Maklergebührsbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.dutyTaxesBreakdown.dispursementFee | Auszahlungsgebührsbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.dutyTaxesBreakdown.duty | Zollbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.dutyTaxesBreakdown.prepaymentFee | Vorauszahlungsgebührsbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.dutyTaxesBreakdown.vatOnDispursementFee | MwSt./Steuerbetrag auf Auszahlungsgebühr in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.dutyTaxesBreakdown.vatTax | MwSt./Steuerbetrag in USD, enthält nicht die MwSt./Steuer auf die Auszahlungsgebühr; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.dutyTaxesTotal | Gesamtzoll- und Steuerbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.foreignCurrencyCode | Der Währungscode, in dem die Bestellzahlung abgewickelt wurde.string |
remittance_amount | Der Betrag, der an ein bestimmtes Land (z.B. UK MwSt.) überwiesen werden muss.decimal |
order.grandTotal | Gesamtsumme in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.grandTotalForeign | Gesamtsumme in abgewickelter Währung; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.items | Eine Liste von ArtikelkartenDie Artikelkarte enthält Details zum Artikel, die beim Erstellen des Zonos Checkout im temp Cart übergeben wurdenFür weitere Details zu den Artikelattributen lesen Sie bitte die createTempCart API-DokumentationJSON string |
order.itemsCount | Anzahl der Bestellpositioneninteger |
order.itemsTotal | Gesamtsumme der Artikel/Produkte in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.itemsTotalForeign | Gesamtsumme der Artikel/Produkte in abgewickelter Währung; positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.items[index].height | Positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.items[index].itemNonShippable | boolean |
order.items[index].length | Positiver Gleitkommawert, zwei Dezimalstelleninteger |
order.items[index].quantity | integer |
order.items[index].weight | Positive floating point, two decimal placesinteger |
order.items[index].width | Positive floating point, two decimal placesinteger |
order.items[index].unitPrice | Positive floating point, two decimal placesinteger |
order.merchantOrderId | MerchantOrderId verbunden mit der Bestellung über den updateMerchantOrderId API-Service-Endpunkt.string |
order.misc1 | Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string |
order.misc2 | Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string |
order.misc3 | Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string |
order.misc4 | Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string |
order.misc5 | Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string |
order.misc6 | Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string |
order.nationalIdentifier | Zusätzliche internationale Rechnungsadressinformationen für die Bestellung, wenn erforderlich. Die Werte wurden im Zonos Checkout eingegeben.string |
order.notes | Eine Liste von Notizen-Maps; die Notiz-Map enthält Details zur Bestellnotiz.JSON string |
order.notes[index].createdByUser | string |
order.notes[index].customerNote | Ein Boolean, der angibt, ob dies eine vom Kunden erstellte Notiz zur Bestellung, zum Versand usw. war.boolean |
order.notes[index].dateCreated | millis |
order.notes[index].dateCreatedString | string |
order.notes[index].flagged | Ein boolean , der angibt, ob diese Notiz als wichtig markiert wurde |
order.notes[index].note | Der Notizinhaltstring |
order.optInEmail | Gibt an, dass der Kunde das Kontrollkästchen für "Newsletter abonnieren" im Zonos Checkout ausgewählt hat. Nur anwendbar, wenn Sie sich dafür entschieden haben, dieses Kontrollkästchen auf der checkout-Seite anzuzeigenboolean |
order.orderId | Die Bestellungsidentifikationsnummer im Zonos-Systemstring |
order.orderDate | Der Bestellerstellungstimestamp in Millisekunden in UTC/GMT.millis |
order.orderDateString | Der Bestellerstellungstimestamp-String in UTC/GMT.string |
order.orderStatus | Der Status/Zustand der Bestellung im Zonos-System. Für weitere Details zur Verwendung von orderStatus lesen Sie bitte das Dokument zur Bestellungswiederherstellung hier. Weitere Informationen zu den Bestellstatus finden Sie im Dokument zur Bestellaktualisierung hier.string |
order.orderStatusDate | Der Zeitstempel in Millisekunden in UTC/GMT der letzten Änderung des orderStatus im Zonos-System.millis |
order.orderStatusDateString | Der Zeitstempel-String in UTC/GMT der letzten Änderung des orderStatus im Zonos-System.string |
order.paymentProcessing | Eine Map 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 String, falls verfügbar. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.string |
order.paymentProcessing.cardType | Kreditkartenmarke. Wenn 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 Zahlungsgateways. Wenn Zonos die Zahlung verarbeitet, wird "iGlobal_CC" oder "iGlobal_PayPal" angezeigt. string |
order.paymentProcessing.transactionType | Gibt den Transaktionstyp an "AUTH_CAPTURE" oder "AUTH_ONLY". 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 Bestellnummern aktiviert sind. string |
order.quotedDutyTaxes | In Zonos Checkout angegebene Zoll- und Steuerkosten, angezeigt in USD; positive Gleitkommazahl, zwei Dezimalstellen. integer |
order.quotedDutyTaxesForeign | In Zonos Checkout angegebene Zoll- und Steuerkosten. Angezeigt in abgerechneter Währung; positive Gleitkommazahl, zwei Dezimalstellen. integer |
order.referenceId | Eindeutige referenceId , die mit der Bestellung über den createTempCart API-Service-Endpunkt verknüpft ist. string |
order.shipComplete | Gibt an, ob die Bestellung in mehreren Teilen versendet werden soll. boolean |
order.shippingCarrierServiceLevel | Träger- und Servicestufenkennung für die ausgewählte Versandoption. string |
order.shippingInstructions | Anpassbare Anweisungen für die Versanddienstleistung. string |
order.shippingTotal | Gesamtkosten für den Versand in USD; positive Gleitkommazahl, zwei Dezimalstellen. integer |
order.shippingTotalForeign | Gesamtkosten für den Versand in abgerechneter Währung; positive Gleitkommazahl, zwei Dezimalstellen. integer |
order.testOrder | Gibt an, ob es sich um eine Testbestellung handelt. boolean |
order.trackingNumber | Für die Sendung generierte Trackingnummer, falls zutreffend. string |
order.zip | Ziel-/Versandadresse für die Bestellung - die Werte wurden im Zonos Checkout eingegeben oder wurden über die Weiterleitung zum 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
Bestelldetails
Erfahren Sie, wie der Bestelldetails-Endpunkt funktioniert.Der
orderDetail
-Endpunkt wird verwendet, um die Bestelldetails und den Status einer über den Zonos Checkout abgeschlossenen Bestellung sicher abzurufen.