VIA-Connect - REST API » SalesOrders

SalesOrders

Zuletzt geändert von Thomas Hoffmann am 2016/09/29 13:17
Kommentare (0) · Anhänge (0) · Historie

Beschreibung

Dieses EntitySet enthält allgemeine Bestelldaten (z.B. Rechnungsbetrag, Versandstatus etc.) zu einem verkauften Artikel.

Alle weiteren relevanten Bestelldaten (z.B. Adressen, Artikeldaten) werden in anderen EntitySets (siehe Navigation Properties) gespeichert.


Das EntitySet erlaubt nur die Request Methoden:  GET und PUT
Mit der PUT Methode können aber nur vereinzelte Properties verändert werden.

Properties


 Alle Datums-/Zeitangaben werden in UTC ausgegeben.
 Bei Aktualisierung von Datums-/Zeitangaben muss diese auch in UTC erfolgen.
 
Property Werttyp Angabe Änderungen (PUT) erlaubt Erläuterung 
IdInt64- NeinDamit wird ein Entity in diesem EntitySet identifiziert.

TotalPriceDecimal- NeinEnthält den Warenwert in der Account-/Shopwährung.

In der aktuellen Version erfolgt keine Umrechnung in die Account-/Shopwährung des Nutzers. 

CurrencyCodeString- NeinEnthält das Währungskürzel der Account-/Shopwährung (z.B. EUR, USD).

In der aktuellen Version erfolgt keine Umrechnung in die Account-/Shopwährung des Nutzers. 

OriginalTotalPriceDecimal- NeinEnthält den Warenwert in der Währung der Verkaufsplattform.


OriginalCurrencyCodeString- NeinEnthält das Währungskürzel der Verkaufsplattform.


ItemCount Int32- NeinEnthält die Anzahl von verkauften Artikel.

TotalAmount Int32- NeinEnthält die Gesamtanzahl der verkauften Artikel.

PlatformNameString- NeinEnthält den Namen der Verkaufsplattform.

In der aktuellen Version wird nur eBay unterstützt.

BuyerIdInt64- NeinEnthält die Id des Entities aus dem EntitySet Buyers.

AddressIdInt64- NeinEnthält die Id des Entities aus dem EntitySet Addresses.

Diese Id entspricht immer der Rechnungsadresse im EntitySet Addresses.

ShippingAddressIdInt64- NeinEnthält die Id des Entities aus dem EntitySet Addresses.

Diese Id entspricht immer der Lieferadresse im EntitySet Addresses.

CheckoutStatusInt32- NeinEnthält den Status der Kaufabwicklung.
  • 0 = Kaufabwicklung nicht abgeschlossen
  • 1 = Kaufabwicklung abgeschlossen

CheckoutCompletionDateDateTime- NeinEnthält das Datum + Uhrzeit des Abschlusses der Kaufabwicklung.

PaymentStatusString- NeinGibt den Status der Verkaufsplattform der Zahlung an

Weitere Informationen zu den Werten finden Sie hier.

PaymentOptionString - NeinEnthält die gewählte Zahlart vom Käufer.

Weitere Informationen zu den Werten finden Sie hier.

ShippingServiceString- NeinEnthält die gewählte Versandart vom Käufer.

BuyerCheckoutMessageString- NeinEnthält den Kundenkommentar.

MailStatusInt16- NeinReserviert für zukünftige Funktionalität.

ShippingStatus Int32- NeinEnthält den Versandstatus.
Der Versandstatus resultiert aus den Versandstatus der einzelnen Artikel.
  • 0 = Nicht versendet
  • 1 = Teillieferung
  • 2 = Versendet
MarkerString--Reserviert für zukünftige Funktionalität.

ShippingServiceCostDecimal-NeinEnthält der Versandkosten der gewählten Versandart.

PaymentTransactionIdString-NeinEnthält die TransaktionId von Drittanbieter Zahlarten (z.B. Paypal, Moneybookers).

MarkedAsShippedBoolean-NeinGibt an, ob der Verkauf versendet ist.

MarkedAsPayedBoolean-NeinGibt an, ob der Verkauf bezahlt ist.

ForeignOrderIdStringPflichtJaMit diesem Wert kann die Bestellung im Fremdsystem identifiziert werden.

Nur mit der Übermittlung einer ForeignOrderId kann von unserem System eine einwandfreie Bestandsänderung gewährleistet werden.

PaidAmountDecimalOptionalJaEnthält den bezahlten Betrag.

Wird der Zahlungseingang vom Fredmsystem verbucht (z.b.: bei Vorkasse),
so muss der bezahlte Betrag vom Fremdsystem an das System zurück geliefert werden.

PaidDateDateTime-NeinEnthält das Zahldatum.

Das Zahldatum wird vom System automatisch gesetzt.

ModificationDateDateTime-NeinEnthält das Änderungsdatum

Bei Änderungen vom Nutzer wird das Datum automatisch aktualisiert
 
CollectablesOrderBoolean-NeinInterner Identifikator  
 
PlatformOrderIdString-NeinEnthält die OrderId der Verkaufsplattform.

EbayModificationDateDateTime-NeinEnthält das Änderungsdatum

Bei Änderungen seitens eBay wird das Datum automatisch aktualisiert
BuyerPackageEnclosureString-NeinEnthält Zusatzinformationen für den Käufer bei "Kauf auf Rechnung"

Ist diesen Feld gefüllt, handelt es sich immer um eine "PayPal - Kauf auf Rechnung" Zahlung.
Die Bezahlung erfolgt erst durch den Käufer mittels Überweisung auf Grund der hier angegebenen Informationen.
  
OrderStatusString-NeinEnthält den Status (Aktiv, Abgeschlossen etc) der Bestellung

Weitere Informationen zu den Werten finden Sie hier.
MonetaryPaymentStatusInteger-NeinDer aktuelle Status der Käufer Zahlung,
die an einem bestimmten Zahlungsempfänger zugeordnet ist.
  • 0 = Failed
  • 1 = Succeeded
  • 2 = Pending
Die Status 'Pending' und 'Failed' können normalerweise nur bei Paypal-Zahlungen vorkommen.
Bei den anderen Zahlarten (auch Bar bei Abholung) ist der Status 'Succeeded'.

Details zu Plattformen

PaymentStatus

Der PaymentStatus gibt nicht eindeutig wieder, ob ein Verkauf bezahlt ist.

Nutzen Sie für die Feststellung, ob ein Verkauf bezahlt ist, das Property MarkedAsPayed.

Folgende Zahlungsstatus gibt es:

ValueErläuterung   
NoneNoch kein Status vorhanden
 
  
CompleteZahlung abgeschlossen

eBay kennt keine Teilzahlung. Das heisst, wird ein Zahlungeingang an eBay übermittelt, so ist die Bestellung bei eBay bezahlt.

  
IncompleteZahlung noch nicht abgeschlossen

  
NoPaymentFailureKein Fehler bei der Zahlung aufgetreten.

Gibt aber nicht an, ob die Zahlung erfolgreich gebucht wurde.

  
PendingZahlung wurde eingeleitet, aber ist noch nicht final abgeschlossen.

Dieser PaymentStatus kann bei Zahlungen mit Paypal auftreten.

  
PaymentInProcessZahlung ist in Bearbeitung

Dieser PaymentStatus kann bei Zahlungen mit Paypal auftreten.

  
PayPalPaymentInProcessZahlung ist in Bearbeitung

Dieser PaymentStatus kann bei Zahlungen mit Paypal auftreten.

 

PaymentOption

Die PaymentOption spiegeln die eBay Zahlartenbezeichnung wieder.

Value mögliche PaymentStatus Erläuterung 
CashOnPickup Complete | Incomplete | NoPaymentFailure Bar bei Abholung

COD Complete | Incomplete | NoPaymentFailure Nachnahme

MoneyXferAccepted Complete | Incomplete | NoPaymentFailure Vorkasse / Überweisung

MoneyXferAcceptedInCheckout  Complete | Incomplete | NoPaymentFailure Vorkasse / Überweisung

Paypal NoPaymentFailure | PaymentInProcess | PayPalPaymentInProcess Paypal

PaymentSeeDescription Complete | Incomplete | Pending | NoPaymentFailure Zahlart ist nicht bestimmt

 Abwicklung erfolgt ausserhalb von eBay

Other Complete | Incomplete | Pending | NoPaymentFailure Wird gesetzt, wenn die Kaufabwicklung automatisch nach Zeitraum X geschlossen wird.

ShippingService

Die ShippingService spiegeln die eBay Versandartenbezeichnung wieder.

Value Bezeichnung 
 DE_DeutschePostBrief Deutsche Post Brief
 DE_DHLPackchen DHL Päckchen
 DE_Paket Paketversand
 DE_Express  Expressversand
 DE_DHLPaket DHL Paket
 DE_DPBuecherWarensendung Deutsche Post Bücher-/Warensendung
 DE_HermesPaket Hermes Paket
 DE_IloxxTransport iloxx Transport
 DE_SonstigeDomestic Sonstige 1-2 Werktage
 DE_Einschreiben Einschreiben (inkl. aller Gebühren)
 DE_Nachname Nachnahme (inkl. aller Gebühren)
 DE_SpecialDelivery Sonderversand
 DE_SparversandAusDemAusland Sparversand aus dem Ausland
 DE_StandardversandAusDemAusland Standardversand aus dem Ausland
 DE_ExpressversandAusDemAusland Expressversand aus dem Ausland
 DE_DPDExpress DPD Express
 DE_UPSExpress UPS Express
 DE_GLSPaket GLS Paket
 DE_EbayHermesPaketShop2Shop eBay Hermes Paket Shop2Shop
 DE_eBayHermesPaketSperrgutShop2Shop eBay Hermes Paket Sperrgut Shop2Shop (Abgabe und Zustellung im Paketshop)
 DE_HermesPaketSperrgut Hermes Paket Sperrgut
 DE_DPDClassic DPD Classic
 DE_UPSStandard UPS Standard
 DE_DeutschePostBriefInternational Deutsche Post Brief
 DE_DHLPackchenInternational DHL Päckchen International
 DE_PaketInternational Standard Int'l Versand
 DE_ExpressInternational Express Int'l Versand
 DE_DHLPaketInternational DHL Paket International
 DE_IloxxTransportInternational iloxx Transport International
 DE_SonstigeInternational Economy Int'l Versand
 DE_HermesPaketInternational Hermes Paket International
 DE_DeutschePostBriefIntlEcon Deutsche Post Presse und Bücher Economy
 DE_DeutschePostBriefIntlPri Deutsche Post Presse und Bücher Priority
 PromotionalShippingMethod Versand zum Sonderpreis
 Other/NotSelected Versandart nicht spezifiziert

Diese Versandart wird gesetzt, wenn die Kaufabwicklung automatisiert nach Zeitraum X geschlossen wird. 

OrderStatus

Value Bedeutung Erläuterung 
 0  Active  Die Bestellung ist offen
 1  Inactive  Die Bestellung ist inaktiv
 2  Completeted  Die Bestellung ist abgeschlossen
 3  Cancelled  Die Bestellung ist storniert/abgebrochen
 4  Shipped  Die Bestellung ist versendet
 6  Authenticated  Die Bestellung ist authentifiziert
 7  InProcess  Die Bestellabwicklung wurde eingeleitet, aber noch nicht abgeschlossen
 8  Invalid  Die Bestellung existiert nicht mehr
 9  CustomerCode  eBay reservierter Wert
 11  CancelPending  Der Käufer hat den Bestellabbruch eingeleitet.

Navigation Properties

Mittels der Navigation Properties können assoziierte EntitySets zum EntitySet SalesOrders abgerufen werden.

Die unten aufgeführten Beispiele beziehen sich auf das Entity mit der Id 1.

Address

Abrufen der Rechnungsadresse


GET                     http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/Address

ShippingAdress

Abrufen der Lieferadresse


GET                     http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/ShippingAddress

SalesOrderItems

Abrufen der verkauften Artikel


GET                     http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/SalesOrderItems

Buyer

Abrufen des Käufernamen


GET                     http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/Buyer

Tags:
Erstellt von Thomas Hoffmann am 2012/08/16 15:09

Copyright 2004-2021 XWiki