DOCS

Order details

/

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.

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

FeldHinweise
HTTP-MethodePOST
Endpunkthttps://api.iglobalstores.com/v2/orderDetail
ProtokollHTTPS
NachrichtenformatJSON
Accept HTTP-HeaderAccept: application/json
Content-Type HTTP-HeaderContent-Type: application/json

JSON-Schlüssel/Wert-Paare im Anfragetext

FeldHinweise
orderId OPTIONAL, wenn referenceId-Parameter übergeben wirdDie 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 wirdDieser 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 ERFORDERLICHAPI-Geheim-GUID, bereitgestellt von Zonosstring
storeId ERFORDERLICHStore-ID, bereitgestellt von Zonos.integer

Fehler-HTTP-Antworten

FehlercodeNachrichtBedeutung
415Unsupported media typeHTML-Entität. HTTP „Content-Type“-Header ist ungültig.
406Not AcceptableHTML-Entität. HTTP „Accept“-Header ist ungültig.
400Bad 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“
500Internal Server Error„error“:„Konnte Bestelldetails nicht verarbeiten“

Definitionen der JSON-Antworten

FeldHinweise
errorDieser Parameter wird nur angezeigt, wenn ein Fehler aufgetreten ist und enthält eine Fehlerbeschreibung.string
orderDies ist eine Karte der Bestelldetails.JSON string
order.billingZipRechnungsadresse für die Bestellung - die Werte wurden im Zonos Checkout eingegeben.string
orderboxCountDieses Feld beschreibt die Kartons, die für den Versand der Bestellung verwendet werden, die in die createTempCart -Anfrage übergeben wurden.string
order.carrierAccountNumberDie eigene Versandträgerkontonummer eines Besuchers; wird verwendet, wenn Besucherkonten für Versandträger aktiviert sindstring
order.carrierAccountShippingMethodDie ausgewählte Versandmethode auf dem eigenen Versandträgerkonto des Besuchers; wird verwendet, wenn Besucherkonten für Versandträger aktiviert sindstring
order.cslListMatchKonsolidierte 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.customerSelectedShippingNameAnzeigename der Versandoption im Zonos Checkoutstring
order.dutyTaxesBreakdownEine Karte der Zoll- / Steuer-AufschlüsselungHinweis - Falls zutreffend, ist die IPF (Internationale Bearbeitungsgebühr) nicht enthalten.JSON string
order.dutyTaxesBreakdown.brokerageFeeMaklergebührsbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.dutyTaxesBreakdown.dispursementFeeAuszahlungsgebührsbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.dutyTaxesBreakdown.dutyZollbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.dutyTaxesBreakdown.prepaymentFeeVorauszahlungsgebührsbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.dutyTaxesBreakdown.vatOnDispursementFeeMwSt./Steuerbetrag auf Auszahlungsgebühr in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.dutyTaxesBreakdown.vatTaxMwSt./Steuerbetrag in USD, enthält nicht die MwSt./Steuer auf die Auszahlungsgebühr; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.dutyTaxesTotalGesamtzoll- und Steuerbetrag in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.foreignCurrencyCodeDer Währungscode, in dem die Bestellzahlung abgewickelt wurde.string
remittance_amountDer Betrag, der an ein bestimmtes Land (z.B. UK MwSt.) überwiesen werden muss.decimal
order.grandTotalGesamtsumme in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.grandTotalForeignGesamtsumme in abgewickelter Währung; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.itemsEine 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.itemsCountAnzahl der Bestellpositioneninteger
order.itemsTotalGesamtsumme der Artikel/Produkte in USD; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.itemsTotalForeignGesamtsumme der Artikel/Produkte in abgewickelter Währung; positiver Gleitkommawert, zwei Dezimalstelleninteger
order.items[index].heightPositiver Gleitkommawert, zwei Dezimalstelleninteger
order.items[index].itemNonShippableboolean
order.items[index].lengthPositiver Gleitkommawert, zwei Dezimalstelleninteger
order.items[index].quantityinteger
order.items[index].weightPositive floating point, two decimal placesinteger
order.items[index].widthPositive floating point, two decimal placesinteger
order.items[index].unitPricePositive floating point, two decimal placesinteger
order.merchantOrderIdMerchantOrderId verbunden mit der Bestellung über den updateMerchantOrderId API-Service-Endpunkt.string
order.misc1Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string
order.misc2Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string
order.misc3Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string
order.misc4Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string
order.misc5Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string
order.misc6Zusätzlicher Wert, der mit der Bestellung über den createTempCart API-Service-Endpunkt verbunden ist.string
order.nationalIdentifierZusätzliche internationale Rechnungsadressinformationen für die Bestellung, wenn erforderlich. Die Werte wurden im Zonos Checkout eingegeben.string
order.notesEine Liste von Notizen-Maps; die Notiz-Map enthält Details zur Bestellnotiz.JSON string
order.notes[index].createdByUserstring
order.notes[index].customerNoteEin Boolean, der angibt, ob dies eine vom Kunden erstellte Notiz zur Bestellung, zum Versand usw. war.boolean
order.notes[index].dateCreatedmillis
order.notes[index].dateCreatedStringstring
order.notes[index].flaggedEin boolean, der angibt, ob diese Notiz als wichtig markiert wurde
order.notes[index].noteDer Notizinhaltstring
order.optInEmailGibt 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.orderIdDie Bestellungsidentifikationsnummer im Zonos-Systemstring
order.orderDateDer Bestellerstellungstimestamp in Millisekunden in UTC/GMT.millis
order.orderDateStringDer Bestellerstellungstimestamp-String in UTC/GMT.string
order.orderStatusDer 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.orderStatusDateDer Zeitstempel in Millisekunden in UTC/GMT der letzten Änderung des orderStatus im Zonos-System.millis
order.orderStatusDateStringDer Zeitstempel-String in UTC/GMT der letzten Änderung des orderStatus im Zonos-System.string
order.paymentProcessingEine Map der paymentProcessing-Details. Einige Parameter sind möglicherweise nicht auf Ihr Konto anwendbar und werden von der Antwort ausgeschlossen.JSON string
order.paymentProcessing.captureDateDas Datum der Zahlungserfassung in Millisekunden, falls verfügbar. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.millis
order.paymentProcessing.captureDateStringDas Datum der Zahlungserfassung als String, falls verfügbar. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.string
order.paymentProcessing.cardTypeKreditkartenmarke. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen.string
order.paymentProcessing.lastFourDie letzten vier Ziffern der Rechnungskreditkartennummer. Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen. string
order.paymentProcessing.paymentGatewayName des Zahlungsgateways. Wenn Zonos die Zahlung verarbeitet, wird "iGlobal_CC" oder "iGlobal_PayPal" angezeigt. string
order.paymentProcessing.transactionTypeGibt den Transaktionstyp an "AUTH_CAPTURE" oder "AUTH_ONLY". Wenn Zonos die Zahlung verarbeitet, wird dieser Knoten von der Antwort ausgeschlossen. string
order.poNumberEine Bestellnummer für die im Zonos Checkout angegebene Bestellung; wird verwendet, wenn Bestellnummern aktiviert sind. string
order.quotedDutyTaxesIn Zonos Checkout angegebene Zoll- und Steuerkosten, angezeigt in USD; positive Gleitkommazahl, zwei Dezimalstellen. integer
order.quotedDutyTaxesForeignIn Zonos Checkout angegebene Zoll- und Steuerkosten. Angezeigt in abgerechneter Währung; positive Gleitkommazahl, zwei Dezimalstellen. integer
order.referenceIdEindeutige referenceId, die mit der Bestellung über den createTempCart API-Service-Endpunkt verknüpft ist. string
order.shipCompleteGibt an, ob die Bestellung in mehreren Teilen versendet werden soll. boolean
order.shippingCarrierServiceLevelTräger- und Servicestufenkennung für die ausgewählte Versandoption. string
order.shippingInstructionsAnpassbare Anweisungen für die Versanddienstleistung. string
order.shippingTotalGesamtkosten für den Versand in USD; positive Gleitkommazahl, zwei Dezimalstellen. integer
order.shippingTotalForeignGesamtkosten für den Versand in abgerechneter Währung; positive Gleitkommazahl, zwei Dezimalstellen. integer
order.testOrderGibt an, ob es sich um eine Testbestellung handelt. boolean
order.trackingNumberFür die Sendung generierte Trackingnummer, falls zutreffend. string
order.zipZiel-/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

War diese Seite hilfreich?


Auf dieser Seite: