Übersicht Bestelldaten - WEBSALE Dokumentation

Diese Übersicht zeigt, welche Parameter eine Standard-Bestellung erzeugt und an das angeschlossene Warenwirtschaftssystem übergibt. Dieselben Daten sehen Sie im Online-Servicebereich im Dienst “Bestellungen” unter “Details” und dort “Download der Bestelldaten”. Die Bestelldaten sind in Sektionen gegliedert. Drei davon sind immer vorhanden, die übrigen entstehen nur, wenn der Käufer die zugehörige Funktion genutzt hat.

Sektion	Inhalt	Immer vorhanden
`ID`	Kopfdaten der Bestellung	ja
`CustomerAddress`	Rechnungsadresse	ja
`DeliveryAddress`	abweichende Lieferadresse	nein
`CustomerComment`	Kommentar des Bestellers	nein
`OrderSpecialInput`	zusätzlicher Freitext des Bestellers	nein
`Order`	globale Daten der Bestellung	ja
`OrderList` mit `Item`	die bestellten Produkte	ja

Welche Parameter tatsächlich entstehen, hängt vom Funktionsumfang Ihres Shops ab. Diese Seite zeigt den Standardfall.

Zusätzliche Parameter mit `_DName` und `_DValue`

Zu einigen Parametern gibt WEBSALE V8s zwei weitere Parameter mit demselben Namen und einem Suffix aus:

Suffix	Inhalt
`_DName`	der im Shop angezeigte Name des Eingabefeldes, abhängig von der Sprache des Subshops
`_DValue`	der im Shop angezeigte Wert

Diese beiden dienen als Zusatzinformation. Der Parameter ohne Suffix enthält den technischen Wert, der Parameter mit _DValue das, was der Käufer gesehen hat. Bei Deliverer steht im Hauptparameter beispielsweise die interne Kennung des Lieferdienstes, in Deliverer_DValue dessen Anzeigename. Für die Anzeige einer Bestellung greift WEBSALE selbst auf die _DValue-Fassung zurück, etwa bei Deliverer, DeliveryCost, VAT und Total. Wenn Sie Bestelldaten für Menschen aufbereiten, ist das meist die passendere Wahl.

Sektion `ID`

Kopfdaten einer Bestellung.

Parameter	Pflicht	Bemerkung
`ShopID`	ja	eindeutige Kennung Ihres Shops
`SubShopID`	ja	eindeutige Kennung des Subshops. Jeder Shop hat mindestens einen
`Referer`		Aufruf-Referenz, woher WEBSALE aufgerufen wurde
`Subreferer`		Sub-Aufruf-Referenz
`OrderNumber`	ja	eindeutige Auftragsnummer, geeignet zur Referenzierung
`Date`	ja	Datum der Bestellung im Format `TT.MM.JJ`, beispielsweise `29.01.10`
`Time`	ja	Uhrzeit im Format `HH:MM:SS`, beispielsweise `19:02:59`
`SessionID`	ja	die im Shop verwendete eindeutige Sitzungskennung
`ExpressCheckout`		die Bestellung lief über Express Checkout
`ExpressCheckoutType`		über welchen Dienst, beispielsweise PayPal oder Klarna

Sektion `CustomerAddress`

Die Rechnungsadresse. Die Sektion ist immer vorhanden, alle Parameter darin sind jedoch optional.

Parameter	Bemerkung
`Number`	Kundennummer
`Salutation`	sprachabhängige Anrede, beispielsweise “Frau”
`CompleteSalutation`	komplette länderabhängige Anrede, beispielsweise “Sehr geehrter Herr Dr. Meier”
`Company`	Firmenname
`Department`	Abteilung
`Title`	sprachabhängiger Titel, beispielsweise “Professor”
`FirstName`	Vorname
`LastName`	Nachname
`Street1`	Straße und Hausnummer
`Street2`	separate Hausnummer, wenn sie nicht in `Street1` steht
`ZIP`	Postleitzahl
`City`	Ort
`State`	Bundesland
`Country`	dreistelliger Ländercode nach ISO 3166, beispielsweise `DEU`
`Phone`	Telefon
`BusinessPhone`	Telefon geschäftlich
`MobilePhone`	Telefon mobil
`Fax`	Fax
`BusinessFax`	Fax geschäftlich
`E-Mail`	E-Mail-Adresse
`E-Mail2`	zweite E-Mail-Adresse, beispielsweise für den Rechnungsversand
`DateOfBirth`	Geburtsdatum im Format `TT.MM.JJJJ`
`IP-Address`	IP-Adresse, von der aus der Shop aufgerufen wurde
`IP-AddressTimestamp`	Zeitpunkt der IP-Bestimmung im Format `JJJJ-MM-TT / HH:MM:SS`
`PostOfficeBox`	Postfach
`SuperUserID`	gesetzt, wenn die Bestellung von einem SuperUser für einen anderen Kunden ausgeführt wurde
`TaxID`	Umsatzsteuer-Identifikationsnummer
`UserDef-1` bis `UserDef-3`	frei definierbare Felder, die nicht in der Kundendatenbank gespeichert werden
`Suffix1` bis `Suffix50`	frei definierbare Felder, die in der Kundendatenbank gespeichert werden
`BonusPointsAccountBalance`	nur beim Bonuspunktesystem. Der Punktestand
`PaymentAccountCredit`	nur bei der Zahlungsart Kundenkonto. Der Kontostand
`ExpressCheckoutAddressUsed`	`yes`, wenn die Adresse aus dem Express Checkout stammt

Die Felder UserDefList-1 bis UserDefList-3 können in Bestelldaten älterer Shops auftauchen. Benutzerdefinierte UserDefList-Auswahllisten sind veraltet und werden nicht mehr unterstützt.

Wegweiser: Auswahllisten der Adressdaten

Sektion `DeliveryAddress`

Die abweichende Lieferadresse. Diese Sektion entsteht nur, wenn der Käufer eine angegeben hat. Die Parameter entsprechen denen der Rechnungsadresse, mit drei Unterschieden: Es gibt keine Number, keine E-Mail2 und keine der kundenkontobezogenen Angaben wie TaxID oder SuperUserID. Dafür kommt ein Parameter hinzu:

Parameter	Bemerkung
`OneTime`	nur bei multiplen Lieferadressen. Steht hier `yes`, wurde die Adresse nicht in der Kundendatenbank gespeichert und darf vom Warenwirtschaftssystem nicht in den Shop zurückrepliziert werden

OneTime ist der Parameter, bei dem eine falsche Behandlung am teuersten wird. Repliziert Ihr Warenwirtschaftssystem eine Einmaladresse zurück, landet sie dauerhaft im Kundenkonto, obwohl der Käufer sie nur für diese eine Bestellung angegeben hat.

Bei multiplen Lieferadressen fasst eine übergeordnete Sektion DeliveryAddresses die einzelnen DeliveryAddress-Sektionen zusammen.

Sektion `CustomerComment`

Ein optionaler Kommentar des Bestellers. Die Sektion enthält keine Parameter, sondern den Text so, wie der Käufer ihn eingegeben hat, mit beliebigen Zeilenwechseln.

<CustomerComment>
   Text des Bestellers, wie
   von ihm eingegeben.
   Mit beliebigen Zeilenwechseln.
</CustomerComment>

Sektion `OrderSpecialInput`

Ein weiterer mehrzeiliger Freitext, den der Besteller optional angeben kann. Aufbau wie bei CustomerComment.

<OrderSpecialInput>
   Beliebige Eingaben des Bestellers.
   Beliebige Eingaben des Bestellers.
   Beliebige Eingaben des Bestellers.
</OrderSpecialInput>

Sektion `Order`

Globale Daten der Bestellung.

Versand und Rahmendaten

Parameter	Pflicht	Bemerkung
`Deliverer`		Name des Lieferdienstes, im Shop frei vergeben
`DeliveryDate`		Wunsch-Liefertermin im Format `TT.MM.JJJJ`
`TotalWeight`		Gesamtgewicht der Bestellung
`WeightUnit`		Einheit für das Gewicht, beispielsweise `kg`
`TotalVolume`		Gesamtvolumen
`VolumeUnit`		Einheit für das Volumen
`PriceType`	ja	`Gross` für Bruttopreise, `Net` für Nettopreise
`Currency`	ja	dreistelliger Währungscode, beispielsweise `EUR`
`TaxFree`	ja	`yes`, wenn der Besteller von der Mehrwertsteuer befreit ist, sonst `no`

Zahlung

Parameter	Bemerkung
`PaymentType`	technischer Name der Zahlungsart, beispielsweise `CreditCard`, `CashOnDelivery`, `DebitNote`, `Bill`, `Prepayment`
`PaymentName`	sprachabhängiger Name, beispielsweise “Nachnahme”
`PaymentCode`	der Zahlungsarten-Code
`CostCenterNumber`	Nummer der Kostenstelle, nur bei der Zahlungsart Kostenstelle
`CostCenterEmailAddress`	E-Mail-Adresse des Freigebers, nur bei der Zahlungsart Kostenstelle

Materialien: Zahlungsarten-Codes

Gutscheine und Bonuspunkte

Parameter	Bemerkung
`VoucherNumber`	Nummer des eingelösten Gutscheins
`VoucherRest`	Restbetrag des Gutscheins
`VoucherChargeID`	Chargen-ID des Gutscheins
`VoucherAmount`	tatsächlich eingelöster Betrag. Bei einem Gutschein über 100 Euro und einem Rechnungsbetrag von 25 Euro steht hier `25.00`
`OrderBonusPoints`	Anzahl der gutgeschriebenen Bonuspunkte
`CashedBonusPoints`	Anzahl der eingelösten Bonuspunkte
`CashedBonusPointsAmount`	Betrag der eingelösten Bonuspunkte

Rabatte

Parameter	Pflicht	Bemerkung
`UserDiscountRate`	ja	Kundenrabatt in Prozent
`UserDiscount`	ja	Wert des Kundenrabatts
`PaymentDiscountRate`	ja	Zahlungsartenrabatt in Prozent
`PaymentDiscount`	ja	Wert des Zahlungsartenrabatts
`OrderDiscountRate`	ja	Warenwertrabatt in Prozent
`OrderDiscount`	ja	Wert des Warenwertrabatts
`GroupDiscount`	ja	Wert des Produktgruppenrabatts
`ProductDiscount`	ja	Wert des direkten Produktrabatts
`PaymentCostDiscountRate`		Zahlungskostenrabatt in Prozent
`PaymentCostDiscount`		Wert des Zahlungskostenrabatts
`DeliveryCostDiscountRate`		Versandkostenrabatt in Prozent
`DeliveryCostDiscount`		Wert des Versandkostenrabatts
`TotalDiscount`	ja	Wert aller kumulierten Rabatte

Kosten und Summen

Parameter	Pflicht	Bemerkung
`DeliveryCost`	ja	Lieferkosten
`DeliveryVATRate`	ja	Mehrwertsteuersatz der Lieferkosten
`PaymentCost`	ja	Zahlungskosten
`Surcharge`		Mindermengenzuschlag
`ResellerSurcharge`		Reseller-Zuschlag
`GiftPackage`		Gesamtkosten aller Geschenkverpackungen
`GiftPackageVATRate`		Mehrwertsteuersatz der Geschenkverpackung
`CustomerSubvention`		gewährter Kundenzuschuss
`CustomerSubventionRemainder`		verbleibender Kundenzuschuss für die nächste Bestellung
`SubTotal`	ja	Warenwert
`VAT`	ja	gesamter Mehrwertsteuerbetrag
`Total`	ja	Gesamtsumme einschließlich aller Rabatte, Gutscheine, Zuschläge und Abschläge

Weitere Angaben

Parameter	Bemerkung
`OrderOption_Name-1` bis `-5`	Name der Bestelloption
`OrderOption_Price-1` bis `-5`	Kosten der Bestelloption
`OrderOption_VAT-1` bis `-5`	Mehrwertsteuersatz der Bestelloption
`TS_Name`	Name des Trusted-Shops-Produkts
`TS_VAT`	Mehrwertsteuersatz des Trusted-Shops-Produkts
`TS_COST`	Kosten des Trusted-Shops-Produkts
`UploadID`	eindeutige Upload-Kennung der Bestellung, bei Datei-Uploads
`DownloadID`	eindeutige Download-Kennung, bei Datei-Downloads
`OfferID`	eindeutige Kennung bei der Bestellung eines Angebots
`RefText` und `RefText2`	Referenztexte zur Bestellung

Sektion `OrderList` mit `Item`

Die Liste der bestellten Produkte. Je Produkt entsteht eine Item-Sektion.

<OrderList>
   <Item>
      Daten des 1. Produktes
   </Item>
   <Item>
      Daten des 2. Produktes
   </Item>
   ...
</OrderList>

Identifikation

Parameter	Pflicht	Bemerkung
`ID`		eindeutige Produktnummer, abhängig von den gewählten Varianten
`PositionNumber`		laufende Positionsnummer
`ProdIndex`	ja	interner Index des Produkts, unabhängig von Varianten
`DepVarIndex`		Index der abhängigen Variante
`Insert`		Werbemittelkennzeichen
`SetParentID`		Kennung eines Set-Oberprodukts
`SetChildID`		Kennung eines Set-Unterprodukts
`MerchantID`		Händler-Kennung
`MerchantName`		Händlername
`EmployeeID`		Angestellten-Kennung
`ExternalProductID`		Kennung eines externen, dem Shop unbekannten Produkts
`Name`	ja	Produktname

Menge, Gewicht und Maße

Parameter	Pflicht	Bemerkung
`Quantity`	ja	Bestellmenge
`UnitFactor`		Faktor der Verpackungseinheit
`Weight`		Gewicht pro Stück
`TotalWeight`		Gesamtgewicht, also `Quantity` mal `Weight`
`Volume`		Volumen
`TotalVolume`		Gesamtvolumen
`AreaProductLength`		Länge oder Höhe eines Flächenprodukts
`AreaProductWidth`		Breite oder Dicke eines Flächenprodukts
`AreaProductCalculatedArea`		berechnete Fläche in der im Shop konfigurierten Einheit

Bei einem Flächenprodukt mit 50 Zentimetern Länge und 150 Zentimetern Breite steht in AreaProductCalculatedArea beispielsweise 0.75, wenn die Fläche in Quadratmetern geführt wird. Wie viele Nachkommastellen Länge und Breite haben, stellen Sie im Shop ein.

Preise und Rabatte je Position

Parameter	Pflicht	Bemerkung
`Price`	ja	Basispreis ohne Rabatte, Varianten und Staffelpreise. Reine Information
`StaticAddPrice`		mengenunabhängiger Einmalpreis, beispielsweise für eine Druckvorlage
`GiftPackage`		Preis der Geschenkverpackung
`TotalGiftPackage`		Gesamtpreis der Geschenkverpackung
`VAT`	ja	absoluter Mehrwertsteuerbetrag
`Sum`	ja	Zwischensumme. Reine Information
`DiscountFactor`		Rabattfaktor
`ProductDiscount`	ja	absoluter direkter Produktrabatt
`UserDiscount`		berechneter Kundenrabatt für dieses Produkt
`ParticularOrderDiscount`		Anteil dieser Position am global ausgewiesenen Warenwertrabatt
`ParticularUserDiscount`		Anteil dieser Position am global ausgewiesenen Kundenrabatt
`ParticularPaymentDiscount`		Anteil dieser Position am global ausgewiesenen Zahlungsartenrabatt
`TotalDiscount`	ja	Gesamtrabatt der Position
`Total`	ja	finaler Gesamtpreis einschließlich aller Rabatte, Staffelpreise, Zusatzkosten und der Bestellmenge

Price und Sum sind ausdrücklich als Information gekennzeichnet. Für die Verbuchung ist Total der maßgebliche Wert, weil nur dort alle Rabatte, Aufschläge und die Menge enthalten sind.

Unterabschnitte je Position

Abschnitt	Inhalt
`<Variation>`	eine gewählte Variante. Kann je Position mehrfach vorkommen
`<TextInputFields>`	die Texteingabefelder der Position, maximal zehn
`<OrderInfo>`	interne Informationen zum Produkt, die unverändert zurückgegeben werden
`<InstantVoucherProduct>`	Angaben zu einem Kaufgutschein

Innerhalb von <Variation>:

Parameter	Bemerkung
`ID`	Teil-Produktnummer bei normalen Varianten
`Name`	Name der Variante, beispielsweise “Farbe”
`Option`	gewählte Option, beispielsweise “rot”
`Price`	Aufpreis bei normalen Varianten
`Index`	interner Index der Reihenfolge-Position

Innerhalb von <TextInputFields>:

Parameter	Bemerkung
`Name-1` bis `Name-10`	Name des Texteingabefeldes
`Field-1` bis `Field-10`	Wert des Texteingabefeldes

Innerhalb von <InstantVoucherProduct>:

Parameter	Bemerkung
`ChargeID`	Chargen-ID des Kaufgutscheins
`Number`	Gutscheinnummer
`Amount`	Betrag
`PDFLinkPart`	Link zum Download des Kaufgutscheins als PDF

Besondere Produktarten

Parameter	Bemerkung
`BonusProduct`	`yes` kennzeichnet ein Prämienprodukt
`BonusProductPrice`	Anzahl der dafür eingelösten Bonuspunkte
`BonusProductPriceTotal`	Gesamtzahl der eingelösten Bonuspunkte
`InstantVoucherProduct`	`yes` kennzeichnet einen Kaufgutschein
`UploadID`	Upload-Kennung dieser Position

​Zusätzliche Parameter mit _DName und _DValue

​Sektion ID

​Sektion CustomerAddress

​Sektion DeliveryAddress

​Sektion CustomerComment

​Sektion OrderSpecialInput

​Sektion Order

​Versand und Rahmendaten

​Zahlung

​Gutscheine und Bonuspunkte

​Rabatte

​Kosten und Summen

​Weitere Angaben

​Sektion OrderList mit Item

​Identifikation

​Menge, Gewicht und Maße

​Preise und Rabatte je Position

​Unterabschnitte je Position

​Besondere Produktarten

Zusätzliche Parameter mit `_DName` und `_DValue`

Sektion `ID`

Sektion `CustomerAddress`

Sektion `DeliveryAddress`

Sektion `CustomerComment`

Sektion `OrderSpecialInput`

Sektion `Order`

Versand und Rahmendaten

Zahlung

Gutscheine und Bonuspunkte

Rabatte

Kosten und Summen

Weitere Angaben

Sektion `OrderList` mit `Item`

Identifikation

Menge, Gewicht und Maße

Preise und Rabatte je Position

Unterabschnitte je Position

Besondere Produktarten