SalesOrders

Zuletzt geändert von Thomas Hoffmann am 2016/09/29 13:17

Kommentare (0) · Anhänge (0) · Historie

Inhalt

Beschreibung
Properties
Details zu Plattformen
OrderStatus
Navigation Properties

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
Id	Int64	-	Nein	Damit wird ein Entity in diesem EntitySet identifiziert.
*TotalPrice*	Decimal	-	Nein	Enthält den Warenwert in der Account-/Shopwährung. In der aktuellen Version erfolgt keine Umrechnung in die Account-/Shopwährung des Nutzers.
*CurrencyCode*	String	-	Nein	Enthä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.
*OriginalTotalPrice*	Decimal	-	Nein	Enthält den Warenwert in der Währung der Verkaufsplattform.
*OriginalCurrencyCode*	String	-	Nein	Enthält das Währungskürzel der Verkaufsplattform.
*ItemCount*	Int32	-	Nein	Enthält die Anzahl von verkauften Artikel.
*TotalAmount*	Int32	-	Nein	Enthält die Gesamtanzahl der verkauften Artikel.
*PlatformName*	String	-	Nein	Enthält den Namen der Verkaufsplattform. In der aktuellen Version wird nur eBay unterstützt.
*BuyerId*	Int64	-	Nein	Enthält die Id des Entities aus dem EntitySet Buyers.
*AddressId*	Int64	-	Nein	Enthält die Id des Entities aus dem EntitySet Addresses. Diese Id entspricht immer der Rechnungsadresse im EntitySet Addresses.
*ShippingAddressId*	Int64	-	Nein	Enthält die Id des Entities aus dem EntitySet Addresses. Diese Id entspricht immer der Lieferadresse im EntitySet Addresses.
*CheckoutStatus*	Int32	-	Nein	Enthält den Status der Kaufabwicklung. 0 = Kaufabwicklung nicht abgeschlossen 1 = Kaufabwicklung abgeschlossen
*CheckoutCompletionDate*	DateTime	-	Nein	Enthält das Datum + Uhrzeit des Abschlusses der Kaufabwicklung.
*PaymentStatus*	String	-	Nein	Gibt den Status der Verkaufsplattform der Zahlung an Weitere Informationen zu den Werten finden Sie hier.
*PaymentOption*	String	-	Nein	Enthält die gewählte Zahlart vom Käufer. Weitere Informationen zu den Werten finden Sie hier.
*ShippingService*	String	-	Nein	Enthält die gewählte Versandart vom Käufer.
*BuyerCheckoutMessage*	String	-	Nein	Enthält den Kundenkommentar.
*MailStatus*	Int16	-	Nein	Reserviert für zukünftige Funktionalität.
*ShippingStatus*	Int32	-	Nein	Enthält den Versandstatus. Der Versandstatus resultiert aus den Versandstatus der einzelnen Artikel. 0 = Nicht versendet 1 = Teillieferung 2 = Versendet
*Marker*	String	-	-	Reserviert für zukünftige Funktionalität.
*ShippingServiceCost*	Decimal	-	Nein	Enthält der Versandkosten der gewählten Versandart.
*PaymentTransactionId*	String	-	Nein	Enthält die TransaktionId von Drittanbieter Zahlarten (z.B. Paypal, Moneybookers).
*MarkedAsShipped*	Boolean	-	Nein	Gibt an, ob der Verkauf versendet ist.
*MarkedAsPayed*	Boolean	-	Nein	Gibt an, ob der Verkauf bezahlt ist.
*ForeignOrderId*	String	Pflicht	Ja	Mit 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.
*PaidAmount*	Decimal	Optional	Ja	Enthä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.
*PaidDate*	DateTime	-	Nein	Enthält das Zahldatum. Das Zahldatum wird vom System automatisch gesetzt.
*ModificationDate*	DateTime	-	Nein	Enthält das Änderungsdatum Bei Änderungen vom Nutzer wird das Datum automatisch aktualisiert
*CollectablesOrder*	Boolean	-	Nein	Interner Identifikator
*PlatformOrderId*	String	-	Nein	Enthält die OrderId der Verkaufsplattform.
*EbayModificationDate*	DateTime	-	Nein	Enthält das Änderungsdatum Bei Änderungen seitens eBay wird das Datum automatisch aktualisiert
*BuyerPackageEnclosure*	String	-	Nein	Enthä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.
*OrderStatus*	String	-	Nein	Enthält den Status (Aktiv, Abgeschlossen etc) der Bestellung Weitere Informationen zu den Werten finden Sie hier.
*MonetaryPaymentStatus*	Integer	-	Nein	Der 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

eBay

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:

Value	Erläuterung
*None*	Noch kein Status vorhanden
*Complete*	Zahlung abgeschlossen eBay kennt keine Teilzahlung. Das heisst, wird ein Zahlungeingang an eBay übermittelt, so ist die Bestellung bei eBay bezahlt.
*Incomplete*	Zahlung noch nicht abgeschlossen
*NoPaymentFailure*	Kein Fehler bei der Zahlung aufgetreten. Gibt aber nicht an, ob die Zahlung erfolgreich gebucht wurde.
*Pending*	Zahlung wurde eingeleitet, aber ist noch nicht final abgeschlossen. Dieser PaymentStatus kann bei Zahlungen mit Paypal auftreten.
*PaymentInProcess*	Zahlung ist in Bearbeitung Dieser PaymentStatus kann bei Zahlungen mit Paypal auftreten.
*PayPalPaymentInProcess*	Zahlung 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