Format und Inhalt - WS-Bestelldaten (DE)
- René Meyer
- Rainer Biedermann (Deactivated)
- Manfred Hackl
Allgemeines
Diese Dokumentation beschreibt das Format und den Inhalt von Bestelldaten, welche von einem Shop abgeholt werden können.
Transfer der Bestelldaten
Die nachfolgend beschriebenen Bestelldaten werden via SOAP übertragen. Das Anstoßen der Übertragung wird in der separaten Dokumentation „SOAP-from-Shop“ beschrieben:
SOAP-from-Shop (empfohlen)
Wenn auf Ihrem System kein SOAP implementiert werden kann, können Sie alternativ auch mit dem WS-OrderManager (WSOM) Bestelldaten exportieren. Siehe separate Dokumentation:
WSOM-from-Shop (Vorgängerversion - nicht mehr empfohlen)
Beschreibung der Sektionen und Parameter
Die in dieser Dokumentation beschriebenen Formate können jederzeit um neue Parameter und Sektionen erweitert werden. Programme, die diese Formate parsen, müssen deshalb so geschrieben werden, dass sie unbekannte Sektionen und Parameter ignorieren und nicht von einer bestimmten Reihenfolge der Sektionen und Parameter ausgehen.
Sektion: Header (Allgemeine Informationen)
Diese Sektion ist stets vorhanden.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
|---|---|---|---|
FormatID | X | 32 | Kennung des Datenformats |
VersionNumber | X | 1 | Versionsnummer des Datenformats |
Generator | X | 32 | Kennung des erzeugenden Programms |
Copyright(c) | X |
| Copyright von WEBSALE für dieses Datenformat |
Remark | X |
| Unveränderlicher Wert |
Remark | X |
| Unveränderlicher Wert |
Sektion: ID (Kopfdaten einer Bestellung)
Diese Sektion ist stets vorhanden.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
|---|---|---|---|
MallID | X |
| Die MallID eines Shops. Alle Produktivshops befinden sich in der Mall „websale“. Testshops befinden sich in der Mall „test“ und Partnershops in der Mall „partner“ |
ShopID | X |
| Eine eindeutige ID Ihres Shops. |
SubShopID | X |
| Eine eindeutige ID Ihres Subshops. Jeder Shop besitzt mindestens 1 Subshop. |
DataSubShopID |
|
| Eine eindeutige ID Ihres Datensubshops falls die Produktdaten eines anderen Subshops verwendet wurden |
ShopLanguage | X | 3 | 3 Zeichen ISO Code 3166 des Landes, z.B. DEU für Deutschland |
Referer |
| 128 | Aufruf-Referenz, woher WEBSALE aufgerufen wurde |
Subreferer |
| 128 | Sub-Aufruf-Referenz, woher WEBSALE aufgerufen wurde |
OrderNumber | X | 16 | Eindeutige Auftragsnummer. Kann zur eindeutigen Referenzierung verwendet werden. |
Date | X | 8 | Datum der Bestellung im Format TT.MM.YY z.B. 29.01.10 |
Time | X | 8 | Uhrzeit der Bestellung im Format HH:MM:SS z.B. 19:02:59 |
SessionID | X | 32 | Die im Shop verwendete, eindeutige SessionID. |
Test |
| 3 | Wenn der Shop sich zum Zeitpunkt der Bestellung im Testmodus befunden hat, wird der Parameter mit dem Wert „yes“ übergeben |
Charset | X | 64 | Konfigurierter Zeichensatz des Shops |
gclid |
| 64 | Die beim Aufruf des Shops übergebene GoogleClickID |
ExpressCheckout |
| yes | Wird gesetzt, wenn der Käufer über einen ExpressCheckout bestellt hat |
ExpressCheckout Type |
| 16 | Wird nur übergeben, wenn der Käufer über einen ExpressCheckout bestellt hat. Anbieter des ExpressCheckouts. Mögliche Werte: „PayPal“ |
ShopConfig |
|
| Wenn der Shop zum Zeitpunkt der Bestellung mit einer alternativen Shopkonfiguration verwendet wurde, wird der Parameter mit dem Dateinamen der alternativen Shopkonfiguration als Wert übergeben. |
IPv4 |
|
| Beim Absenden der Bestellung verwendete IPv4-Adresse (kann auch vom Payment-Clearer sein) |
IPv6 |
|
| Beim Absenden der Bestellung verwendete IPv6-Adresse (kann auch vom Payment-Clearer sein) |
FirstCall-IPv4 |
|
| IPv4-Adresse beim FirstCall |
FirstCall-IPv6 |
|
| IPv6-Adresse beim FirstCall |
FirstCall-IPAdressTimestamp |
|
| Timestamp beim FirstCall |
Sektion: PromotionAgreement (Werbungszustimmung)
Diese Sektion ist optional, falls der Käufer seine Zustimmung zur Werbung gegeben oder abgelehnt hat.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
|---|---|---|---|
AddressSharingState |
| Integer-Zahl | Status der Zustimmung zur Adressweitergabe: |
AddressSharingLastChangeIP |
| 15 | IP-Adresse des letzten Statuswechsels im Shop |
AddressSharingLastChangeDate |
| 12 | Datum des letzten Statuswechsels im Format DD.MM.YYYY |
AddressSharingLastChangeTime |
| 8 | Uhrzeit des letzten Statuswechsels im Format HH:MM:SS |
TeleMarketingState |
| Integer-Zahl | Status der Zustimmung zur Telefonwerbung: |
TeleMarketingLastChangeIP |
| 15 | IP-Adresse des letzten Statuswechsels im Shop |
TeleMarketingLastChangeDate |
| 12 | Datum des letzten Statuswechsels im Format DD.MM.YYYY |
TeleMarketingLastChangeTime |
| 8 | Uhrzeit des letzten Statuswechsels im Format HH:MM:SS |
Sektion: CustomerAddress (Rechnungsadresse)
Diese Sektion ist stets vorhanden.
Alle Parameter der Rechnungsadresse sind jedoch optional.
Zu den meisten Parametern werden gleichnamige Parameter mit dem Suffix „_DName“ (Name des Eingabefeldes, sprachabhängig vom Subshop) ausgegeben, die als zusätzliche Information dienen. Ebenso werden zu einigen Parametern gleichnamige Parameter mit dem Suffix „_DValue“ (im Shop angezeigter Wert des Eingabefeldes) ausgegeben, die ebenfalls als zusätzliche Information dienen.
Beispiel:
Country = DEU (technischer, sprachunabhängiger Wert) Country_DName = Land (sprachabhängiger Name des Eingabefeldes) Country_DValue = Deutschland (sprachabhängige Anzeige für den Besteller)
Ein Adressdatenfeld, dessen Wert gelöscht wird, wird normalerweise ab der nächsten Bestellung nicht mehr in die Bestelldaten übergeben.
Der Wert eines Feldes kann auf dem Shop-Template explizit als gelöscht markiert und übergeben werden. In den Bestelldaten der nächsten Bestellung wird der Wert dann mit dem Suffix „_deleted“ und dem Wert „yes“ geschrieben.
Beispiel:
Country_deleted = yes
Parameter | Muss-Feld | Max. Länge <>255 Zeichen | Bemerkung |
|---|---|---|---|
Number |
|
| Kundennummer |
Company |
|
| Firmenname |
Salutation |
|
| Sprachabhängige Anrede z.B. „Frau“ |
SalutationCode |
|
| Ein im Shop frei einstellbarer, sprachunabhängiger Anredecode. Siehe Datei "salutation.dat" |
CompleteSalutation |
|
| Komplette, länderabhängige Anrede z.B. „Sehr geehrter Herr Dr. Meier“ |
FirstName |
|
| Vorname |
LastName |
|
| Nachname |
Title |
|
| Sprachabhängiger Titel z.B. „Professor“ |
TitleCode |
|
| Ein im Shop frei einstellbarer, sprachunabhängiger Titelcode. Siehe Datei "title.dat" |
Street1 |
|
| Straße und Hausnummer |
Street2 |
|
| Separate Hausnummer, wenn diese nicht in Street1 aufgenommen wird |
ZIP |
|
| PLZ |
City |
|
| Ort |
State |
|
| Bundesland |
CountryISO |
| 3 | 3-Zeichen Ländercode nach ISO 3166 z.B. DEU für Deutschland |
Phone |
|
| Telefon |
Fax |
|
| Fax |
| 127 | E-Mail-Adresse | |
BusinessPhone |
|
| Telefon geschäftlich |
MobilePhone |
|
| Telefon mobil |
BusinessFax |
|
| Fax geschäftlich |
DateOfBirth |
| 10 | Geburtsdatum im Format TT.MM.JJJJ z.B. „19.10.1968“ |
PostOfficeBox |
|
| Postfach |
Suffix1..50 |
|
| Im Shop frei definierbare Felder, die in der Kundendatenbank gespeichert werden. |
Department |
|
| Abteilung |
CostCenter |
|
| Kostenstelle |
UserType |
|
| Kundenart |
PostOfficeBoxZIP |
|
| PLZ des Postfachs |
TaxID |
|
| Umsatzsteuer-ID |
UserDefList-1 |
|
| Im Shop frei definierbare Listen-Felder, die nicht in der Kundendatenbank gespeichert werden. |
UserIndex |
| Integer-Zahl | Interner Kundenindex der Shop-Kundendatenbank |
EmailVerification |
| verified unverified undef | Status der E-Mail-Verifizierung |
SuperUserID |
| 64 | SuperUserID, falls die Bestellung von einem „SuperUser“ für einen anderen Kunden ausgeführt wurde |
InfoScoreResult |
| Positive Negative | Nur bei Infoscore-Bonitätsanfrage. Die möglichen Werte sind „Positive“ bei positiver (=keine Ablehnung) Prüfung oder „Negative“ bei negativer (=explizite Ablehnung) Prüfung oder bei einem Verbindungsproblem. |
eScoreClass |
|
| Nur bei Infoscore-Bonitätsanfrage. Der eScoreClass-Wert. |
InformaScore |
|
| Nur bei Infoscore-Bonitätsanfrage. Der InformaScore-Wert. |
InfoScoreFeatures |
|
| Nur bei Infoscore-Bonitätsabfrage. Zusatzinformationen von InfoScore. |
InfoScoreBIG |
| yes/no | Yes: Es wird die aktuelle Schnittstelle InfoScoreBIG (Stand Nov. 2016) benutzt. No: Es wird die eScore-Schnittstelle von Infoscore benutzt |
BonusPointsAccountBalance |
|
| Nur bei Bonuspunktesystem. Der Bonuspunktestand. |
PaymentAccountCredit |
|
| Nur falls die Zahlungsart „Kundenkonto“ verwendet wurde. Der Kontostand. |
IP-Address |
| IP-Adresse | IP-Adresse von der aus der Shop aufgerufen wurde |
IP- AddressTimestamp |
| Datum | Datum/Uhrzeit zu der die IP-Adresse bestimmt wurde im Format JJJJ-MM-TT / HH:MM:SS |
AddressIndex |
| Integer-Zahl | Eindeutiger, interner Rechnungsadressindex |
ExternalID |
|
| Externe ID der Rechnungsadresse, welche vom WWS vergeben werden kann. |
RegistrationCode |
|
| Registrierungs-Code für Neukunden |
ExpressCheckoutAddressUsed |
| yes | Hier wird „yes“ übergeben wenn der Käufer per Expresscheckout bestellt hat und die Adressdaten nicht in WEBSALE V8 eingegeben wurden. In diesem Fall müssen als Rechnungsadresse entweder die Adressdaten in den spezifischen Daten des Anbieters verwendet oder beim Anbieter direkt abgefragt werden (PayPal, Amazon, PayDirekt, etc...). In diesem Fall werden die meisten Felder der Rechnungsadresse nicht übergeben. |
AccountType |
| CustomerAccount GuestAccount | Für angemeldete Kunden wird CustomerAccount übergeben, für nicht angemeldete Kunden (Gastbestellung) wird GuestAccount übergeben. |
Sektion: DeliveryAddress (optionale, abweichende Lieferadresse)
Alle Parameter der von der Rechnungsadresse abweichenden Lieferadresse sind optional.
Diese Sektion ist nur bei einer abweichenden Lieferadresse vorhanden.
Zu den meisten Parametern werden gleichnamige Parameter mit dem Suffix „_DName“ (Name des Eingabefeldes, sprachabhängig vom Subshop) ausgegeben, die als zusätzliche Information dienen. Zu einigen Parametern werden gleichnamige Parameter mit dem Suffix „_DValue“ ausgegeben, die ebenfalls als zusätzliche Information dienen.
Beispiel:
Country = DEU (technischer, sprachunabhängiger Wert) Country_DName = Land (sprachabhängiger Name des Eingabefeldes) Country_DValue = Deutschland (sprachabhängige Anzeige für den Besteller)
Ein Adressdatenfeld, dessen Wert gelöscht wird, wird normalerweise ab der nächsten Bestellung nicht mehr in die Bestelldaten übergeben.
Der Wert eines Feldes kann auf dem Shop-Template explizit als gelöscht markiert und übergeben werden. In den Bestelldaten der nächsten Bestellung wird der Wert dann mit dem Suffix „_deleted“ und dem Wert „yes“ geschrieben.
Beispiel:
Country_deleted = yes
Parameter | Muss-Feld | Max. Länge <>255 Zeichen | Bemerkung |
|---|---|---|---|
Company |
|
| Firmenname |
Salutation |
|
| Sprachabhängige Anrede z.B. „Frau“ |
SalutationCode |
|
| Ein im Shop frei einstellbarer Anredecode. Siehe Datei "salutation.dat" |
FirstName |
|
| Vorname |
LastName |
|
| Nachname |
Title |
|
| Sprachabhängiger Titel z.B. „Professor“ |
TitleCode |
|
| Ein im Shop frei einstellbarer Titelcode. Siehe Datei "title.dat" |
Street1 |
|
| Straße und Hausnummer |
Street2 |
|
| Separate Hausnummer, wenn diese nicht in Street1 aufgenommen wird |
ZIP |
|
| PLZ |
City |
|
| Ort |
State |
|
| Bundesland |
CountryISO |
| 3 | 3-Zeichen Ländercode nach ISO 3166 z.B. DEU für Deutschland |
Phone |
|
| Telefon |
Fax |
|
|
© 2025 WEBSALE AG | Impressum | Datenschutz