Format and content - WS-Adressdatenänderungen (EN)
General
This documentation describes the format and content of address data changes, which can be fetched from a shop.
Normally it is sufficient to transfer the address data of a customer together with the order data.
This documentation is relevant for you if you also want to pick up address data changes that the customer has made in the shop without placing an order.
An address data change is transmitted when
A customer registers in the shop for the first time. In this case, the transmitted record may be incomplete or even empty, namely if the change is requested before the customer has completely filled in his data in the shop.
A customer changes his data in the customer account (not in the ordering process).
A customer record is created via import. In this case, the address data change serves to transmit the UserIndex of the created data record to the importing system.
An address data change is not transmitted if
A customer data record is created via the newsletter.
An already existing customer data record is changed via the import
A customer data record is created or changed in the OSB.
By appropriate configuration by the WEBSALE system administration it is possible that an address data change without customer number is not exported to the ERP system (parameter UserDataChangeSkipDataWithoutCustomerNumber). Please contact your WEBSALE contact person in this regard.
Transfer of address data changes
The address data described below is transferred via SOAP. The transfer is described in the separate documentation "SOAP-from-Shop (EN)".
If SOAP cannot be implemented on your system, you can alternatively export order data with the WEBSALE-OrderManager (WSOM) (see separate documentation "WS-OrderManager: Export data (EN)")
Formats of address data changes
The basic structure of the files with the address data changes corresponds to the structure of the file with the order data, as it is described in the documentation "Format and content - WS-Bestelldaten (EN)" documentation.
The following differences exist between address data changes and order data:
The "Order" and "OrderList" sections are missing because they contain data that is only available for orders.
There is an additional section "AccountData" with the fields "UserIndex", "CustomerID", "Email", "EmailVerification" and "SubShop".
In the sections with address data (CustomerAddress, DeliveryAddress, CreditCard, DebitNote, AccountData) there are the additional parameters "changed" and "deleted", which each have the value "yes" if data in this section has changed or if the complete record has been deleted.
If the parameters are missing or have the value "no", the data are unchanged or they were not deleted.In case of order data only the used delivery address, bank details, etc. are delivered, in case of address data changes all delivery addresses, bank details, etc. are delivered.
No readable, language-dependent parameters with the prefixes "_Dname" and "_Dvalue" are passed.
Description of sections and parameters
Section: Header (General information)
This section is always present and is structured analogously to the section of the order data. In addition, the following parameter is passed:
Parameter | Required field | Max. Length <>255 characters | Comment |
---|---|---|---|
Content-Type | X | 32 | The value is always "Customer Data". This is used to recognize that this is an address data change |
Section: ID (header data of an order)
This section is always present. Only the following parameters are supported:
Parameter | Required field | Max. Length <>255 characters | Comment |
---|---|---|---|
MallID | X | Â | The MallID of a shop. All production shops are located in the mall "websale". Test shops are located in the "test" mall and partner shops are located in the "partner" mall. |
ShopID | X | Â | A unique ID of your shop. |
OrderNumber | X | 32 | Unique order number. Can be used for unique referencing. |
Date | X | 8 | Date of the order in the format DD.MM.YY e.g. 29.01.10 |
Time | X | 8 | Time of the order in the format HH:MM:SS e.g. 19:02:59 |
Section: AccountData (customer account data)
This section is always present.
Parameter | Required field | Max. Length <>255 characters | Comment |
---|---|---|---|
changed | x | yes | Indicates if the customer account data has been changed |
deleted | x | yes | Indicates if the customer account has been deleted by the customer |
UserIndex | x | Integer number | Internal customer index of the shop customer database |
CustomerID | x | Â | Customer number |
x | Â | Email address | |
EmailVerification | x | verified | Shows if the email address is verified |
SubShop | Â | 12 | Main subshop |
RegistrationCode | Â | 128 | Registration code/"unlock code" (the shop can be set up so that only customers who know an unlock code can register) |
Section: PromotionAgreement (advertising agreement)
This section is optional in case the buyer has given or refused his consent to the promotion, and is structured analogously to the section of the order data.
Section: CustomerAddress (Billing Address)
This section is always present. The following parameters are also transferred in the order data.
Parameter | Required field | Max. Length <>255 characters | Comment |
---|---|---|---|
changed | x | yes | Indicates if the address has been changed |
deleted | x | yes | Indicates if the address has been deleted by the customer |
Section: DeliveryAddress (optional, different delivery address)
All parameters of the different delivery address are optional. This section is available only in case of a different delivery address. The following parameters are also transferred in the order data.
Parameter | Required field | Max. Length <>255 characters | Comment |
---|---|---|---|
changed | x | yes | Indicates if the address has been changed |
deleted | x | yes | Indicates if the address has been deleted by the customer |
Section: CreditCard (credit card data)
This section is transferred only in case of credit card payment. The following parameters are also transferred in the order data.
Parameter | Required field | Max. Length <>255 characters | Comment |
---|---|---|---|
changed | x | yes | Indicates if the credit card data has been changed |
deleted | x | yes | Indicates whether the credit card data has been deleted by the customer |
Section: DebitNote (bank data)
This section is transferred only in case of direct debit payment. The following parameters are also transferred in the order data.
Parameter | Required field | Max. Length <>255 characters | Comment |
---|---|---|---|
changed | x | yes | Indicates if the credit card data has been changed |
deleted | x | yes | Indicates whether the credit card data has been deleted by the customer |