Format und Inhalt - WS-Adressdatenänderungen (DE)

Allgemeines

Diese Dokumentation beschreibt das Format und den Inhalt von Adressdatenänderungen, welche von einem Shop abgeholt werden können.

Normalerweise reicht es aus, wenn die Adressdaten eines Kunden zusammen mit den Bestelldaten übertragen werden.

Diese Doku ist für Sie relevant, wenn Sie zusätzlich auch Adressdatenänderungen abholen wollen, die der Kunde im Shop vorgenommen hat ohne eine Bestellung aufzugeben.

Eine Adressdatenänderung wird übermittelt, wenn

  • sich ein Kunde neu im Shop anmeldet. In diesem Fall kann der übermittelte Datensatz unvollständig oder sogar leer sein, wenn die Änderung abgefragt wird, bevor der Kunde seine Daten im Shop vollständig ausgefüllt hat.

  • ein Kunde seine Daten im Kundenkonto (nicht im Bestellprozess) ändert.

  • ein Kundendatensatz über den Import angelegt wird. In diesem Fall dient die Adressdatenänderung dazu, dem importierenden System den UserIndex des angelegten Datensatzes zu übermitteln.

Eine Adressdatenänderung wird nicht übermittelt, wenn

  • ein Kundendatensatz über den Newsletter angelegt wird.

  • ein bereits vorhandener Kundendatensatz über den Import verändert wird.

  • ein Kundendatensatz im Online-Servicebereich angelegt oder verändert wird.

Durch entsprechende Konfiguration durch die WEBSALE Systemadministration ist es möglich, dass eine Adressdatenänderung ohne Kundennummer nicht zum ERP-System exportiert wird (Stichwort UserDataChangeSkipDataWithoutCustomerNumber). Kontaktieren Sie diesbezüglich Ihren WEBSALE-Ansprechpartner.

Transfer der Adressdatenänderungen

Die nachfolgend beschriebenen Adressdaten 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)

Formate der Adressdatenänderungen

Der grundsätzliche Aufbau der Dateien mit den Adressdatenänderungen entspricht dem Aufbau der Datei mit den Bestelldaten, so wie er in der Dokumentation “WS-Bestelldaten“ beschrieben ist:

Format und Inhalt - WS-Bestelldaten (DE)

Folgende Unterschiede gibt es zwischen Adressdatenänderungen und Bestelldaten:

  • Die Abschnitte "Order" und "OrderList" fehlen, da sie Daten enthalten, die nur bei Bestellungen vorliegen.

  • Es gibt einen zusätzlichen Abschnitt "AccountData" mit den Feldern "UserIndex", "CustomerID", "Email", "EmailVerification" und "SubShop".

  • In den Abschnitten mit Adressdaten (CustomerAddress, DeliveryAddress, CreditCard, DebitNote, AccountData) gibt es die zusätzlichen Parameter "changed" und "deleted", die jeweils den Wert "yes" haben, wenn sich Daten in diesem Abschnitt geändert haben bzw. wenn der komplette Datensatz gelöscht wurde.
    Fehlen die Parameter oder haben sie den Wert "no", so sind die Daten unverändert bzw. sie wurden nicht gelöscht.

  • Bei den Bestelldaten wird nur die jeweils benutzte Lieferadresse, Bankverbindung usw. geliefert, bei Adressdatenänderungen alle Lieferadressen, Bankverbindungen, usw.

  • Es werden keine lesbaren, sprachabhängigen Parameter mit den Präfixen „_Dname“ und „_Dvalue“ übergeben.

Beschreibung der Sektionen und Parameter

Sektion: Header (Allgemeine Informationen)

Diese Sektion ist stets vorhanden und analog zu der Sektion der Bestelldaten aufgebaut. Zusätzlich wird folgender Parameter in den Bestelldaten übergeben.

Parameter

Pflichtfeld

Max. Länge <>255 Zeichen

Bemerkung

Parameter

Pflichtfeld

Max. Länge <>255 Zeichen

Bemerkung

Content-Type

x

32

Der Wert ist immer "Customer Data". Dies dient zur Erkennung, dass dies eine Adressdatenänderung ist

Sektion: ID (Kopfdaten einer Bestellung)

Diese Sektion ist stets vorhanden. Es werden nur folgende Parameter unterstützt:

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

Parameter

Pflicht-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.

OrderNumber

x

32

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

Sektion: AccountData (Kundenkontendaten)

Diese Sektion ist stets vorhanden.

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

changed

x

yes
no

Zeigt an, ob die Kundenkontendaten geändert wurden.

deleted

x

yes
no

Zeigt an, ob das Kundenkonto durch den Kunden gelöscht wurde.

UserIndex

x

Integer-Zahl

Interner Kundenindex der Shop-Kundendatenbank

CustomerID

x

 

Kundennummer

Email

x

 

E-Mailadresse

EmailVerification

x

verified
unverified
undef

Zeigt an, ob die E-Mailadresse bestätigt ist.

SubShop

 

12

Hauptsubshop

RegistrationCode

 

128

Registrierungscode/"Freischaltcode" (der Shop kann so eingerichtet werden, dass sich nur Kunden registrieren können, die einen Freischaltcode kennen)

Sektion: PromotionAgreement (Werbungszustimmung)

Diese Sektion ist optional, falls der Käufer seine Zustimmung zur Werbung gegeben oder abgelehnt hat, und analog zu der Sektion der Bestelldaten aufgebaut.

Format und Inhalt - WS-Bestelldaten (DE) | Sektion: PromotionAgreement (Werbungszustimmung)

Sektion: CustomerAddress (Rechnungsadresse)

Diese Sektion ist stets vorhanden. Folgende Parameter werden in den Bestelldaten zusätzlich übergeben.

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

changed

x

yes
no

Zeigt an, ob die Rechnungsadresse geändert wurde.

deleted

x

yes
no

Zeigt an, ob die Rechnungsadresse durch den Kunden gelöscht wurde.

Sektion: DeliveryAddress (optionale, abweichende Lieferadresse)

Alle Parameter der abweichenden Lieferadresse sind optional. Diese Sektion ist nur bei einer abweichenden Lieferadresse vorhanden. Folgende Parameter werden in den Bestelldaten zusätzlich übergeben.

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

changed

x

yes
no

Zeigt an, ob die Lieferadresse geändert wurde.

deleted

x

yes
no

Zeigt an, ob die Lieferadresse durch den Kunden gelöscht wurde.

Sektion: CreditCard (Kreditkartendaten)

Diese Sektion wird nur bei einer Kreditkartenzahlung übergeben. Folgende Parameter werden in den Bestelldaten zusätzlich übergeben.

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

changed

x

yes
no

Zeigt an, ob die Kreditkartendaten geändert wurden.

deleted

x

yes
no

Zeigt an, ob die Kreditkartendaten durch den Kunden gelöscht wurden.

Sektion: DebitNote (Bankdaten)

Diese Sektion wird nur bei einer Lastschriftzahlung übergeben. Folgende Parameter werden in den Bestelldaten zusätzlich übergeben.

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

Parameter

Pflicht-feld

Max. Länge <>255 Zeichen

Bemerkung

changed

x

yes
no

Zeigt an, ob die Bankdaten geändert wurden.

deleted

x

yes
no

Zeigt an, ob die Bankdaten durch den Kunden gelöscht wurden.