/
Format and content - WS-Bestelldaten (EN)

Format and content - WS-Bestelldaten (EN)

General

This documentation describes the format and content of order data that can be retrieved from a shop.

Transfer of order data

The order data described below is transferred via SOAP. The transfer is described in the separate documentation

Übertragung - Trigger: REST, SOAP & Co

Description of sections and parameters

The formats described in this documentation can be extended by new parameters and sections at any time. Programs that parse these formats must therefore be written in such a way that they ignore unknown sections and parameters and do not assume a specific sequence of sections and parameters.

Section: Header (General Information)

This section is always present.

Parameter

Required field

Max. Length

<>255

Characters

Comment

Parameter

Required field

Max. Length

<>255

Characters

Comment

FormatID

X

32

Identifier of the data format

VersionNumber

X

1

Version number of the data format

Generator

X

32

Identifier of the generating program

Copyright(c)

X

 

Copyright of WEBSALE for this data format

Remark

X

 

Unchanged value

Remark

X

 

Unchangeable value

Section: ID (header data of an order)

This section is always present.

Parameter

Required field

Max. Length

<>255

Characters

Comment

Parameter

Required field

Max. Length

<>255

Characters

Comment

MallID

X

 

The MallID of a shop. All production shops are located in the "websale" mall. 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.

SubShopID

X

 

A unique ID of your subshop. Each shop has at least 1 subshop.

DataSubShopID

 

 

A unique ID of your data subshop if the product data of another subshop was used

ShopLanguage

X

3

3 characters ISO code 3166 of the country, e.g. DEU for Germany

Referer

 

128

Call reference, where WEBSALE was called from

Subreferer

 

128

Sub call reference, where WEBSALE was called from

OrderNumber

X

16

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

SessionID

X

32

The unique SessionID used in the shop.

Test

 

3

If the shop was in test mode when the order was placed, the parameter is passed with the value "yes"

Charset

X

64

Configured character set of the shop

gclid

 

64

The GoogleClickID passed when calling the shop

ExpressCheckout

 

yes

Set if the buyer ordered via ExpressCheckout

ExpressCheckout Type

 

16

Will be passed only if the buyer has ordered via an ExpressCheckout. Provider of the ExpressCheckout. Possible values: "PayPal” “PayPalCheckout“

ShopConfig

 

 

If the shop was used with an alternative shop configuration at the time of the order, the parameter is passed with the file name of the alternative shop configuration as the value.

IPv4

 

 

IPv4 address used when submitting the order (can also be from the payment clearer)

IPv6

 

 

IPv6 address used when submitting the order (can also be from the payment clearer)

FirstCall IPv4

 

 

IPv4 address used during FirstCall

FirstCall-IPv6

 

 

IPv6 address at FirstCall

FirstCall-IPAdressTimestamp

 

 

Timestamp at FirstCall

Section: PromotionAgreement (advertising agreement)

This section is optional if the buyer has given or refused consent for promotion.

Parameters

Required field

Max. Length

<>255

Characters

Comment

Parameters

Required field

Max. Length

<>255

Characters

Comment

AddressSharingState

 

Integer number

Status of address sharing consent:
0: No information available
1: Rejection by phone
2: Consent by phone
3: Rejection in the shop system
4: Consent in the shop system

AddressSharingLastChangeIP

 

15

IP address of the last status change in the shop

AddressSharingLastChangeDate

 

12

Date of last status change in format DD.MM.YYYY

AddressSharingLastChangeTime

 

8

Time of the last status change in the format HH:MM:SS

TeleMarketingState

 

Integer number

Telemarketing consent status:
0: No information available
1: Telephone rejection
2: Telephone consent
3: Rejection in the shop system
4: Consent in the shop system

TeleMarketingLastChangeIP

 

15

IP address of the last status change in the shop

TeleMarketingLastChangeDate

 

12

Date of the last status change in the format DD.MM.YYYY

TeleMarketingLastChangeTime

 

8

Time of the last status change in the format HH:MM:SS

Section: CustomerAddress (Billing Address)

This section is always present.

However, all billing address parameters are optional.

For most parameters, parameters with the same name are output with the suffix "_DName" (name of the input field, language-dependent on the subshop), which serve as additional information. Likewise, for some parameters, parameters with the same name are output with the suffix "_DValue" (value of the input field displayed in the shop), which also serve as additional information.

Example:

Country = DEU (technical, language-independent value)
Country_DName = Country (language-dependent name of the input field)
Country_DValue = Germany (language-dependent display for the orderer)

An address data field whose value is deleted is normally not transferred to the order data from the next order on.

The value of a field can be explicitly marked as deleted and transferred on the shop template. In the order data of the next order, the value is then written with the suffix "_deleted" and the value "yes".

Example

Country_deleted = yes

Parameter

Required field

Max. Length

<>255 characters

Comment

Parameter

Required field

Max. Length

<>255 characters

Comment

Number

 

 

Customer number

Company

 

 

Company name

Salutation

 

 

Language dependent salutation e.g. "Mrs.".

SalutationCode

 

 

A language-independent salutation code that can be freely set in the shop. See file “salutation.dat”

CompleteSalutation

 

 

Complete, language dependent salutation e.g. "Dear Dr. Meier".

FirstName

 

 

First name

LastName

 

 

LastName

Title

 

 

Language dependent title e.g. "Professor”

TitleCode

 

 

A language-independent title code that can be freely set in the shop. See file “title.dat”

Street1

 

 

Street and house number

Street2

 

 

Separate house number, if not included in Street1

ZIP

 

 

ZIP CODE

City

 

 

City

State

 

 

State

CountryISO

 

3

3-character country code according to ISO 3166 e.g. DEU for Germany

Phone

 

 

Telephone

Fax

 

 

Fax

E-mail

 

127

E-mail address

BusinessPhone

 

 

Business phone

MobilePhone

 

 

Mobile phone

BusinessFax

 

 

Fax business

DateOfBirth

 

10

Date of birth in the format DD.MM.YYYY e.g. "19.10.1968".

PostOfficeBox

 

 

P.O. Box

Suffix1..50

 

 

In the shop freely definable fields, which are stored in the customer database.

Department

 

 

Department

CostCenter

 

 

CostCenter

UserType

 

 

Customer type

PostOfficeBoxZIP

 

 

ZIP code of the post office box

TaxID

 

 

Sales tax ID

UserDefList-1
UserDefList-2
UserDefList-3

 

 

In the shop freely definable list fields, which are not stored in the customer database.

UserIndex

 

Integer number

Internal customer index of the shop customer database

EmailVerification

 

verified unverified undef

Status of email verification

SuperUserID

 

64

SuperUserID, if the order was placed by a "SuperUser" for another customer

InfoScoreResult

 

Positive Negative

Only in case of Infoscore credit inquiry. Possible values are "Positive" in case of positive (=no rejection) check or "Negative" in case of negative (=explicit rejection) check or connection problem.

eScoreClass

 

 

For Infoscore credit inquiry only. The eScoreClass value.

InformaScore

 

 

Only for Infoscore creditworthiness request. The InformaScore value.

InfoScoreFeatures

 

 

Only for Infoscore credit query. Additional information from InfoScore.