Format und Inhalt - WS-Bestelldaten (DE)
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 |
|
| Fax |
|
| eMail-Adresse | |
BusinessPhone |
|
| Telefon geschäftlich |
MobilePhone |
|
| Telefon mobil |
BusinessFax |
|
| Fax geschäftlich |
DateOfBirth |
|
| 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 |
DeliveryAddressIndex |
| Integer-Wert | Eindeutiger interner Lieferadressenindex |
ExternalID |
|
| Externe ID der Lieferadresse, welche vom WWS vergeben werden kann. |
OneTime |
| yes | Einmalverwendung der Lieferadresse. |
|
|
| Steht dieser Parameter auf „yes“, dann wurde diese Adresse nicht in der Kundendatenbank gespeichert und darf vom WWS nicht in den Shop zurückrepliziert werden. |
WishListAddress |
| yes | Die Lieferadresse ist eine hinterlegte Wunschlistenadresse eines anderen Kunden |
WishListOwnerFirstName |
|
| Vorname des Wunschlistenbesitzers |
WishListOwnerLastName |
|
| Nachname des Wunschlistenbesitzers |
Sektion: DeliveryAddresses (mehrere Lieferadressen bei MultiDelivery)
Diese Sektion wird dann angezeigt, wenn die Funktion “Mehrere Lieferadressen auswählen (MultiDelivery/Split-Order)” im Shop aktiv ist.
Für jede Lieferadresse wird ein eigener Abschnitt <+DeliveryAddress> angelegt. Dieser enthält alle Standard-Parameter wie oben aufgelistet: Sektion DeliveryAddress
Zusätzlich wird der Parameter DeliveryAddressOrderIndex eingefügt und ein Index vom System vergeben. Mit diesem Index erfolgt die Verknüpfung der Bestellpositionen zu den einzelnen Lieferadressen in der Sektion OrderList > Item.
<DeliveryAddresses>
<+DeliveryAddress>
DeliveryAddressOrderIndex = 1
...
</+DeliveryAddress>
<+DeliveryAddress>
DeliveryAddressOrderIndex = 2
...
</+DeliveryAddress>
</DeliveryAddresses>
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
DeliveryAddressOrderIndex |
| Integer | Index vom System vergeben. Zuordnung von Bestellposition und Lieferadresse |
Sektion: DeliverySelections (flexible Zuordnung der Versandart bei MultiDelivererSelection)
Diese optionale Sektion wird angezeigt, wenn die Funktion MultiDelivererSelection aktiv ist. Dabei kann der Besteller für jede Warenkorbposition (MultiDelivery) bzw. für jede Lieferadresse einer aufgeteilten Position (Split-Order) eine eigene Versandart zuordnen.
Zu einigen Parametern werden gleichnamige Parameter mit dem Suffix „_DName“ und/oder „_DValue“ als zusätzliche Information ausgegeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
<+DeliverySelection> |
| -- | Für jede Warenkorbposition und gewählte Versandart wird eine eigene Untersektion angelegt. |
Deliverer |
| 510 | Name des Lieferdienstes. Die Namen sind im Shop frei vergebbar, z.B. UPS, DHL, ... |
DelivererType |
| 64 | Lieferantenart. Im Shop frei vergebbar |
DelivererID |
| 64 | LieferantenID. Im Shop frei vergebbar |
DeliverySelectionOrderIndex |
|
| eindeutiger vom System vergebener Index, der die gewählte Versandart mit der (Split-)Position verknüpft (Sektion OrderList-Item) |
<+DelivererAdditionalInfo> |
| -- | Untersektion für jede Zusatzinformation einer Versandart |
ID |
| 128 | ID aus der Shopkonfiguration |
Info |
|
| Info-Text aus der Shopkonfiguration |
</+DelivererAdditionalInfo> |
| -- | Ende der Untersektion |
<+DelivererAdditionalInput> |
| -- | Untersektion bei zusätzlichem Eingabefeld für eine Versandart |
ID |
| 128 | ID aus der Shopkonfiguration |
FieldDescr |
| 1024 | Beschreibung des Eingabefeldes aus der Shopkonfiguration |
Input |
| 128 | eingegebener Text des Käufers |
</+DelivererAdditionalInput> |
| -- | Ende der Untersektion |
IDCardNumber |
| 20 | Zustellung Eigenhändig Plus: Ausweisnummer |
IDCardType |
| Integer | Zustellung Eigenhändig Plus: Art des Ausweisdokuments (frei vergebbar) |
IDCardAuthority |
| 30 | Zustellung Eigenhändig Plus: Name der ausstellenden Behörde |
AmountDependentCost |
| float | warenwertabhängiger Versandkostenanteil |
PieceDependentCost |
| float | stückkostenabhängiger Versandkostenanteil |
WeigthDpendentCost |
| float | gewichtsabhängiger Versandkostenanteil |
ProductDependentCost |
| float | produktspezifischer Versandkostenanteil |
MinimumDeliveryCost |
| float | Mindestversandkosten |
MinimumDeliveryCostApplied |
| yes no | Mindestversandkosten verwendet? |
MerchantSpecificDeliveryCostApplied |
| yes no | händlerspezifische Versandkosten verwendet? |
DeliveryCostReduction |
| float | Betrag der Versandkostenreduktion |
DeliveryCostReductionApplied |
| yes no | Versandkostenreduktion verwendet? |
DeliveryUserCostDiscount |
| float | Betrag der kundenabhängigen Versandkostenreduktion |
DeliveryUserCostDiscountApplied |
| yes no | kundenabhängige Versandkostenreduktion verwendet? |
DynamicFreeDeliveryApplied |
| yes no | versandkostenfrei wegen dynamischer Auswertung FreeDelivery aus dem Warenkorb |
UserAccountFreeDeliveryApplied |
| yes no | versandkostenfrei wegen Definition im Kundenkonto |
TotalDeliveryCost |
| float | Gesamtbetrag für diese Versandauswahl |
Sektion: CustomerComment (Kommentar des Bestellers)
Dem Besteller wird ein mehrzeiliges Texteingabefeld mit maximal 1000 Zeichen angeboten. Diese Sektion ist optional.
<CustomerComment>
Text des Bestellers, wie von ihm eingegeben.
Mit beliebigen Zeilenwechseln.
</CustomerComment>
Sektion: OrderSpecialInput (Zusatzinformationen des Bestellers)
Ein weiteres, mehrzeiliges Texteingabefeld mit maximal 32000 Zeichen. Diese Sektion ist optional.
<OrderSpecialInput>
Beliebige Eingaben des Bestellers.
Beliebige Eingaben des Bestellers.
Beliebige Eingaben des Bestellers.
</OrderSpecialInput>
Sektion: Order (Globale Daten der Bestellung)
Diese Sektion ist stets vorhanden. Auch hier werden zu einigen Parametern gleichnamige Parameter mit dem Suffix „_DName“ und/oder „_DValue“ als zusätzliche Information ausgegeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Deliverer |
| 510 | Name des Lieferdienstes. Die Namen sind im Shop frei vergebbar, z.B. UPS, DHL, ... |
DelivererType |
| 64 | Lieferantenart. Im Shop frei vergebbar |
DelivererID |
| 64 | LieferantenID. Im Shop frei vergebbar |
<+DelivererAdditionalInfo> |
| -- | Untersektion für jede Zusatzinformation einer Versandart |
ID |
| 128 | ID aus der Shopkonfiguration |
Info |
|
| Info-Text aus der Shopkonfiguration |
</+DelivererAdditionalInfo> |
| -- | Ende der Untersektion |
<+DelivererAdditionalInput> |
| -- | Untersektion bei zusätzlichem Eingabefeld für eine Versandart (wenn MultiDelivererSelection deaktiv) |
ID |
| 128 | ID aus der Shopkonfiguration |
FieldDescr |
| 1024 | Beschreibung des Eingabefeldes aus der Shopkonfiguration |
Input |
| 128 | eingegebener Text des Käufers |
</+DelivererAdditionalInput> |
| -- | Ende der Untersektion |
IDCardNumber |
| 20 | Zustellung Eigenhändig Plus: Ausweisnummer |
IDCardType |
| Integer | Zustellung Eigenhändig Plus: Art des Ausweisdokuments (frei vergebbar) |
IDCardAuthority |
| 30 | Zustellung Eigenhändig Plus: Name der ausstellenden Behörde |
DeliveryDate |
| 10 | Wunsch-Liefertermin. Format: TT.MM.JJJJ |
ConditionsAcceptedDate |
| 10 | Datum wann der Käufer die AGBs akzeptiert hat im Format YYYY-MM-DD |
ConditionsAcceptedTime |
| 8 | Uhrzeit wann der Käufer die AGBs akzeptiert hat im Format HH:MM:SS |
TotalWeight |
| float | Gesamtgewicht der Bestellung |
TotalVolume |
| float | Gesamtvolumen der Bestellung |
PriceType | X | Gross Net | Werte: Gross, Net Artikelpreise im Shop sind Brutto- (Gross) oder Nettopreise (Net) |
Currency | X | 3 | Internationaler 3-stelliger Währungscode, z.B. „EUR“ |
CommunityMember |
| yes no | Nur wenn das CommunityInterface verwendet wird: Käufer hat sich als Community-Mitglied authentifiziert |
CommunityMemberShip |
| 255 | Nur wenn das CommunityInterface verwendet wird: Art der Mitgliedschaft |
CommunityUserID |
| 64 | Nur wenn das CommunityInterface verwendet wird: Benutzerkennung im Authorisierungssystem |
PaymentType |
| 64 | Technischer Name der Zahlungsart. Z.B. CreditCard, CashOnDelivery, DebitNote, Bill, Prepayment, etc. |
PaymentName |
| 255 | Sprachabhängiger Name der Zahlungsart, z.B. „Nachnahme“ |
PaymentCode |
| Integer | Zahlungsartencode: 1=Kreditkarte |
PayPalComputopPayID |
| 255 | Nur bei Online-Clearing mit PayPal über Computop. Die PayID von Computop. Siehe Computop Dokumentation. |
PayPalComputopTransactionID |
| 255 | Nur bei Online-Clearing mit PayPal über Computop. Die Transaktionsnummer im PayPal-System. Siehe Computop Dokumentation. |
OrderOption_Name-X (X=1..5) |
| 255 | Name der Bestelloption |
OrderOption_Price-X (X=1..5) |
| float | Kosten der Bestelloption |
OrderOption_VAT-X (X=1..5) |
| float | MwSt.-Satz der Bestelloption |
TS_ID |
| 32 | Trusted Shops ProduktID |
TS_ERPID |
| 255 | Eine Trusted Shops ProduktID, die vom WWS vergeben werden kann |
TS_Name |
| 255 | Trusted Shops Produkt Name |
TS_VAT |
| float | Der MwSt.-Satz des Trusted Shops Produktes |
TS_Cost |
| float | Die Kosten des Trusted Shops Produktes |
WSPartnerID |
| 128 | Die PartnerID des WEBSALE Affilinet Systems |
WSPartnerCode |
| 128 | Der eingegebene PartnerCode des WEBSALE Affilinet Systems |
UploadID |
| 8 | Die eindeutige UploadID einer Bestellung (bei Datei-Uploads) |
UploadLink |
| 4096 | Link zum Datenupload |
DownloadID |
| 8 | Die eindeutige DownloadID einer Bestellung (bei Datei- Downloads) |
DownloadLink |
| 4096 | Link zum Downloadmodul |
OfferID |
| 128 | Die eindeutige ID bei Bestellung eines Angebotes |
RefText |
| 50 | Der Referenztext zu einer Bestellung |
RefText2 |
| 50 | Der Zusatz-Referenztext zu einer Bestellung |
CostCenterEmailAddress |
| 64 | eMail-Adresse des Freigebers bei der Zahlungsart Kostenstelle |
WishListOrder |
| yes | Wird gesetzt, wenn mindestens eine Position der Bestellung von einer Wunschliste gekauft wurde |
AutoOrder |
| yes | Wird gesetzt, wenn die Bestellung durch den Bestellgenerator ausgelöst wurde |
AutoOrderTestMode |
| yes | Wird gesetzt wenn die Bestellung durch den Bestellgenerator im Testmodus ausgelöst wurde |
UserDiscountRate | X | float | Kundenrabatt in % |
UserDiscount | X | float | Wert des Kundenrabattes |
PaymentDiscountRate | X | float | Zahlungsartenrabatt in % |
PaymentDiscount | X | float | Wert des Zahlungsartenrabattes |
OrderDiscountRate | X | float | Warenwertrabatt in % |
OrderDiscount | X | float | Wert des Warenwertrabattes |
GroupDiscount | X | float | Wert des Gruppierungsrabattes |
ProductDiscount | X | float | Wert des direkten Produktrabattes |
PaymentCostDiscountRate |
| float | Zahlungskostenrabatt in % |
PaymentCostDiscount |
| float | Wert des Zahlungskostenrabattes |
DeliveryCostDiscountRate |
| float | Zustellkostenrabatt in % |
DeliveryCostDiscount |
| float | Wert des Zustellkostenrabattes |
OrderOption_VAT Index-X |
| Integer | Mehrwertsteuerindex der Bestelloption |
TS_VATIndex |
| Integer | Mehrwertsteuerindex des TrustedShop Produkts |
CashedBonusPointsVATRate |
| float | Mehrwertsteuersatz der eingelösten Bonuspunkte |
CashedBonusPointsVATIndex |
| Integer | Mehrwertsteuerindex der eingelösten Bonuspunkte |
CustomerSubventionVATRate |
| float | Mehrwertsteuersatz des Kundenzuschusses |
CustomerSubventionVATIndex |
| Integer | Mehrwertsteuerindex des Kundenzuschusses |
DeliveryVATIndex |
| Integer | Mehrwertsteuerindex der Lieferkosten |
DefaultVATIndex |
| Integer | Standard Mehrwertsteuerindex |
MainServiceVATIndex |
| Integer | Mehrwertsteuerindex der Hauptleistung |
PaymentCostVATRate |
| float | Mehrwertsteuersatz der Zahlungsartenkosten |
PaymentCostVATIndex |
| Integer | Mehrwertsteuerindex der Zahlungsartenkosten |
SurchargeVATRate |
| float | Mehrwertsteuersatz des Mindermengenzuschlags |
SurchargeVATIndex |
| Integer | Mehrwertsteuerindex des Mindermengenzuschlags |
GiftPackageVATRate |
| float | Mehrwertsteuersatz der Geschenkverpackung |
GiftPackageVATIndex |
| Integer | Mehrwertsteuerindex der Geschenkverpackung |
ClimateNeutralVATRate |
| float | Mehrwertsteuersatz der klimaneutralen Produktion |
ClimateNeutralVATIndex |
| Integer | Mehrwertsteuerindex der klimaneutralen Produktion |
BuyXPayYDiscount |
| float | Wert des Rabattes bei Aktionen BuyXPayY |
GlobalDiscount |
| float | Zusammengefasste, globale Rabatte aller Warenkorbpositionen |
TotalDiscount | X | float | Wert aller kumulierten Rabatte und Vergünstigungen |
OrderBonusPoints |
| Integer | Anzahl der gutgeschriebenen Bonuspunkte |
CashedBonusPoints |
| Integer | Anzahl der eingelösten Bonuspunkte |
CashedBonusPointsAmount |
| float | Betrag der eingelösten Bonuspunkte |
BonusProductPoints |
| Integer | Anzahl an verwendeten Bonuspunkten für Prämienprodukte |
DeliveryCost | X | float | Lieferkosten |
DeliveryCost[MerchantID] |
| float | Händlerspezifische Versandkosten. Die MerchantID kann beim Produkt konfiguriert werden |
DeliveryCostReduction |
| float | Rabatt auf Zahlungsartenkosten |
DeliveryVATRate | X | float | MwSt.-Satz der Lieferkosten |
TotalMultiDeliveryAddressUsageCost |
| float | Zusatzkosten für MultiDelivery |
TotalMultiDeliveryAddressUsageCostVATRate |
| float | MwSt.-Satz für MultiDelivery |
TotalMultiDeliveryAddressUsageCostVATIndex |
| integer | MwSt.-Index für MultiDelivery |
TotalSampleCopyCost |
| float | Gesamtkosten für Belegexemplare |
TotalSampleCopyVATRate |
| float | MwSt.-Satz für Belegexemplare |
TotalSampleCopyVATIndex |
| integer | MwSt.-Index für Belegexemplare |
BasketProductOptionCost |
| float | Zusatzkosten für freie Felder auf Split-Positionsebene (BasketProductOptions BPO) |
BasketProductOptionVATRate |
| float | Mehrwertsteuersatz für BPO |
BasketProductOptionVATIndex |
| integer | Mehrwertsteuerindex für BPO |
DefaultVATRate | X | float | Standard Mehrwertsteuersatz |
CustomerSubvention |
| float | Gewährter Kundenzuschuss |
CustomerSubventionRemainder |
| float | Verbleibender Kundenzuschuss für die nächste Bestellung |
PaymentCost |
| float | Zahlungskosten |
Surcharge |
| float | Mindermengenzuschlag |
ResellerSurcharge |
| float | Reseller-Zuschlag |
ClimateNeutral |
| float | Kosten der klimaneutralen Produktion |
W2PCost |
| float | Gesamtkosten der Web2Print Gestaltung |
W2PVAT |
| float | MwSt. Web2Print Kosten |
GiftPackage |
| float | Gesamtkosten aller Geschenkverpackungen |
GiftPackageVATRate |
| float | MwSt.-Satz der Geschenkverpackung |
PaymentInputSuffixX |
|
| Eingegebene Zusatzinformationen zur gewählten Zahlungsart |
SubTotal | X | float | Warenwert |
VAT |
| float | Gesamter Betrag der MwSt. (enthalten) |
VATDiscount |
| float | Gesamter Betrag der MwSt. (abgezogen) |
Total | X | float | Gesamtsumme, inkl. aller Rabatte, Gutscheine, Zuschläge, Abschläge und inkl. MwSt. |
AltCurrencyISO |
| 3 | Alternative Währungscode (ISO) |
AltCurrencyExchangeRate |
| float | Umrechnungskurs für alternative Währung |
PartialDelivery |
| partial | Wird nur ausgegeben, wenn Bestellung teillieferfähig UND der Käufer eine Auswahl getroffen hat |
VoucherNumber, |
|
| Bei Verwendung einzelner Gutscheine. Die Erklärung aller Parameter, die Gutscheine betreffen, befindet sich in einer eigenen Sektion: siehe (Multi-)Vouchers |
eMailSharingWithShippingProviderAllowed |
| yes/no | Erlaubnis zur Weitergabe der E-Mail an die Versanddienstleister. yes: wenn die Checkbox angehakt wurde |
eMailSharingWithShippingProviderData |
|
| eingegebene E-Mail oder die E-Mail der Rechnungsadresse, wenn Erlaubnis zur Weitergabe der E-Mail an die Versanddienstleister = yes |
Sektion: OrderList/Item (Produktdaten)
Diese Sektion ist stets vorhanden. Die Produktdaten werden in folgender Form übergeben.
<OrderList>
<Item>
Daten des 1. Produktes
</Item>
<Item>
Daten des 2. Produktes
</Item>
...
<Item>
Daten des N. Produktes
</Item>
</OrderList>
Es werden maximal 500 Positionen übergeben.
Produktdaten:
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
ID | X | 64 | Eindeutige Produktnummer. Abhängig von Varianten. |
Number |
| 32 | Produktnummer, ggf. mit Insert |
PositionNumber | X | Integer | Laufende Positionsnummer |
CustomizedPositionNumber |
|
| Shopspezifische, laufende Positionsnummer (falls konfiguriert) |
AltNumber1 |
|
| AltNumber1 des Produktes (falls konfiguriert) |
ProdIndex | X | 64 | Interner Index des Produktes. Unabhängig von Varianten. |
DepVarIndex | X | 64 | Abhängiger Variantenindex |
Insert | X | 16 | Werbemittelkennzeichen |
StoreID |
| 64 | Optionale Lagerartikelnummer |
SetParentID |
| 64 | ID eines Set-Oberartikels (siehe Anmerkungen) |
SetChildID |
| 64 | ID eines Set-Unterartikels (siehe Anmerkungen) |
SetHiddenChild |
| yes | Für den Käufer nicht sichtbarer Set-Unterartikel |
HiddenPosition |
| yes | Für den Käufer nicht sichtbarer Artikel |
VoucherProduct |
| yes | Produkt wurde durch einen Gutschein zugesteuert |
VoucherApplies |
| yes | Bei „yes“ wird der verwendete Gutschein auf die Position angewandt |
VoucherApplies-X |
| yes | Ersetzt bei “Mehrere Gutscheine einlösen (MultiVoucher)” den Parameter VoucherApplies. Das X steht für den Index eines verwendeten Gutscheins. |
MerchantID |
| 64 | Händler-ID |
MerchantName |
| 128 | Händler Name |
EmployeeID |
| 16 | Angestellten-ID |
Name | X | 128 | Produktname |
Name2 |
| 128 | Produktname 2 |
Quantity | X | float | Bestellmenge |
ExternalProductID |
| 128 | ID eines externen (unbekannten) Produktes |
InStock |
| float | (Teil-)Bestellmenge mit Lagerbestand |
OutOfStock |
| float | (Teil-)Bestellmenge ohne Lagerbestand |
StockAmount |
| float | aktueller Lagerbestand |
DisplayInStock |
| 255 | Lesbare Ausgabe: (Teil-)Bestellmenge mit Lagerbestand |
DisplayOutOfStock |
| 255 | Lesbare Ausgabe: (Teil-)Bestellmenge ohne Lagerbestand |
DisplayStockAmount |
| 128 | Lesbare Ausgabe: aktueller Lagerbestand |
UnitFactor |
| float | Faktor der Verpackungseinheit |
UnitCode |
| 64 | Code der Verpackungseinheit |
Weight |
| float | Gewicht pro Stück |
TotalWeight |
| float | Gesamtgewicht (Quantity x Weight) |
Volume |
| float | Volumen (ACHTUNG: Entspricht nicht Länge mal Breite mal Höhe!) |
TotalVolume |
| float | Gesamtvolumen (Quantity x Volume) |
Length |
| float | Länge |
Width |
| float | Breite |
Height |
| float | Höhe |
UploadID |
| 8 | UploadID der Position (PositionsID) |
Price | X | float | Basispreis des Produktes ohne Rabatte, Varianten, Staffelpreise, etc. Dieser Preis dient lediglich als Information. |
StaticAddPrice |
| float | Ein mengenunabhängiger Einmalpreis (z.B. der Preis einer Druckplatine) |
GiftPackage |
| float | Preis der Geschenkverpackung |
TotalGiftPackage |
| float | Gesamtpreis der Geschenkverpackung (Quantity x GiftPackage) |
AreaProductLength |
| float | Länge/Höhe eines Flächenproduktes. Die Genauigkeit (Anzahl Nachkommastellen) lässt sich im Shop konfigurieren. |
AreaProductWidth |
| float | Breite/Dicke eines Flächenproduktes. Die Genauigkeit (Anzahl Nachkommastellen) lässt sich im Shop konfigurieren. |
AreaProductBasePrice |
| float | Preis pro Flächeneinheit des Flächenprodukts |
AreaProductStaticAddPrice |
| float | Statischer Aufpreis des Flächenprodukts |
AreaProductCalculatedArea |
| float | Berechnete Fläche in Bezug auf die im Shop konfigurierten Einheit. Die Sektion kann bis zu 10 Einträge beinhalten.eiten. Beispiel: Einheit von Länge/Breite: cm Einheit der Fläche: qm
Beispiel: |
CommissionInfo |
| 255 | Vom Käufer eingegebene Kommissionierungsinformation |
ClimateNeutralAvailable |
| yes | Es wird "yes" übergeben, wenn das Produkt mit der Bestelloption "klimaneutrale Produktion" bestellt werden kann. (Dies bedeutet nicht automatisch, dass die Bestellung auch mit dieser Bestelloption aufgegeben wurde.) |
<ClimateNeutral> |
| -- | Beginn der Untersektion bei klimaneutraler Produktion pro Position |
Status |
| Failed OK | Failed: der Auftrag der klimaneutralen Produktion konnte nicht final an ClimatePartner übermittelt werden OK: klimaneutrale Produktion erfolgreich an ClimatePartner übermittelt |
OrderID |
| 64 | ID des Autrags bei ClimatePartner |
CertID |
| 64 | ZertifikatsID bei ClimatePartner |
ProjectName |
| 255 | Name des Klimaschutzprojekts bei ClimatePartner |
ProjectOffsetNo |
| 64 | ID des Klimaschutzprojekts bei ClimatePartner |
CreationDate |
| 64 | Erstellungsdatum des Auftrags bei ClimatePartner |
CertURL |
| 1027 | URL zum Zertifikat bei ClimatePartner |
LogoURL |
| 1027 | URL zum Logogenerator bei ClimatePartner |
VerifyURL |
| 1027 | URL zur Bestätigungsseite bei ClimatePartner |
Emissions |
| float | Menge der CO2-Emissionen |
VATRate |
| float | MwSt.-Rate |
VATIndex |
| Integer | MwSt.-Index |
Total |
| float | Gesamtbetrag klimaneutrale Produktion |
TotalPartClimatePartner |
| float | Teilbetrag Kosten bei ClimatePartner |
TotalPartCostAddition |
| float | Teilbetrag festgelegter Aufschlag im Shop |
</ClimateNeutral> |
|
| Ende der Untersektion bei klimaneutraler Produktion pro Position |
ISBN |
| 64 | ISBN-Nummer |
eBook |
| Integer | Zeigt an, ob das Produkt ein eBook ist: 1: Libreka eBook |
eBookDRM |
| 64 | DRM-Einstellung eBook |
eBookType |
| 64 | Typ eBook |
eBookDownloadRestriction |
| 1024 | Download-Restriktion eBook |
eBookDownloadLink |
| 4096 | Downloadlink eBook |
PrimeShopping |
| Integer | Kennzeichnung, dass dieses Produkt ein Prime-Paket bzw. eine Prime-Option darstellt: 1 Produkt ist ein Prime-Paket (Set-Oberprodukt) 2 Prime-Option: Sofort versandkostenfrei 3 Prime-Option: Sofort kein Mindestbestellwert 4 Prime-Option: Sofort Prime-Produkte dürfen bestellt werden 102 Prime-Option: Versandkostenfrei (ab dem 1. Folgekauf) 103 Prime-Option: Kein Mindestbestellwert (ab dem 1. Folgekauf) 104 Prime-Option: Prime-Produkte dürfen bestellt werden (ab dem 1. Folgekauf) 105 Prime-Option: Prime-Preise werden gewährt (ab dem 1. Folgekauf) |
PrimeShoppingDuration |
| Integer | Laufzeitdauer des Primepakets (in der angegebenen Einheit) |
PrimeShoppingDurationUnit |
| 1 | Einheit der Laufzeitdauer des Primepakets d: Tage |
PrimeShoppingBillCountries |
|
| Einschränkende, kommaseparierte Liste an 3-stelligen ISO- Codes der Länder, in denen das Prime-Paket verfügbar ist. |
PrimeShoppingPeriodOfNotice |
| Integer | Kündigungsfrist des Prime-Pakets zum Laufzeitende in Tagen |
PrimeProduct |
| yes | Bei "yes" handelt es sich um ein Produkt, welches exklusiv für Prime-Kunden verfügbar ist |
ProductionLocationIdentifier |
|
| Produktionsstandortkennung (countryofproduction) |
Timestamp |
|
| Unix-Timestamp des Zeitpunkts der letzten Änderung der Warenkorbposition (Info/Debug) |
<Variation> |
| -- | Beginn einer Variante. Diese Sektion kann mehrmals (je Variante einmal) vorkommen. |
ID |
| 64 | Teil-Artikelnummer bei normalen Varianten |
Name |
| 128 | Name der Variante, z.B. „Farbe“ |
Option |
| 128 | Option der Variante, z.B. „rot“ |
Price |
| float | Aufpreis bei normalen Varianten |
Index |
| Integer | Interner Index der Reihenfolge-Position |
</Variation> |
| -- | Ende einer Variante. |
<TextInputFields> |
| -- | Beginn der Texteingabefelder. Es werden maximal 10 Felder übergeben. |
Name-X |
| 128 | Name des Texteingabefeldes |
Field-X |
|
| Wert des Texteingabefeldes |
</TextInputFields> |
| -- | Ende der Texteingabefelder |
<Licenses> |
| -- | Beginn der Lizenzinformationen. |
Number-X |
| 128 | Lizenznummer |
</Licenses> |
| -- | Ende der Lizenzinformationen |
<OrderInfo> |
| 16192 | Zusatzinformationen zum Produkt. |
<SpecialInput> |
| 16192 | spezielle Eingaben beim Produkt |
<ExtraInput_X> |
|
| bis zu 20 Zusatzeingaben bei Produkten (kann hex-codiert übergeben werden) |
<AdditionalInput_X> |
|
| Zusätzliche Eingabefelder für Kunden auf der Warenkorbseite |
BonusProduct |
| yes no | Bei „yes“ handelt es sich um einen Prämienartikel. |
BonusProductPrice |
| Integer | Anzahl der eingelösten/benötigten Bonuspunkte |
BonusProductPriceTotal |
| Integer | Gesamtzahl der eingelösten/benötigten Bonuspunkte (Quantity x BonusProductPrice) |
DenyForRating |
| 3 | Bei "yes" wurde das Produkt aus dem Bewertungssystem ausgenommen |
DenyRateRemindEmail |
| 3 | Bei "yes" wurde die Erinnerungs-E-Mail nicht aktiviert |
GreetingProduct |
|
| Bei “yes” handelt es sich um ein Grußkarten-Produkt. |
InstantVoucherProduct |
| yes no | Bei „yes“ handelt es sich um einen Kaufgutschein, welcher mit der Bestellung sofort generiert wurde. |
<InstantVoucherProduct> |
| -- | Beginn Informationen eines Kaufgutscheinprodukts. Diese Sektion kommt nur bei Kaufgutscheinprodukten vor. Die Anzahl der Sektionen entspricht der Bestellmenge der Position. |
ChargeID |
| 128 | ChargenID des Gutscheins |
Number |
| 128 | Gutscheinnummer |
Amount |
| float | Betrag des Gutscheins |
PDFLinkPart |
| 4096 | Teil-Link (Aufrufparameter) zum Download dieses Gutscheins als PDF |
Checksum |
|
| Prüfsumme |
</InstantVoucherProduct> |
| -- | Ende Informationen eines Kaufgutscheinprodukts |
VATIndex | X | Integer | MwSt.-Index |
VATRate | X | float | MwSt.-Satz |
Sum | X | float | Zwischensumme. Dient nur zur Information. |
DiscountFactor |
| float | Rabattfaktor |
TotalDiscount | X | float | Gesamtrabatt der einzelnen Position |
TotalDiscountRate |
| float | In diesem Feld werden die einzelnen Rabattsätze der Position kumuliert übergeben. (Sozusagen der Rabattsatz zum schon vorhandenen absoluten Wert TotalDiscount) |
ProductDiscount | X | float | absoluter, direkter Produktrabatt |
ProductDiscountRate |
| float | Produktrabattsatz, kumulierte Rabattsätze aus folgenden einzelnen Rabatten:
|
VoucherDiscount |
| float | Gutscheinrabatt auf Positionsebene. |
VoucherDiscount-X |
| float | Bei “Mehrere Gutscheine einlösen (MultiVoucher)” wird der Rabatt eines Gutscheins ausgegeben. Das X steht für den Index eines verwendeten Gutscheins. |
VoucherRate |
| float | prozentualer Gutscheinrabatt auf Positionsebene |
VoucherRate-X |
| float | Ersetzt bei “Mehrere Gutscheine einlösen (MultiVoucher)” den Parameter VoucherRate. Das X steht für den Index eines verwendeten Gutscheins. |
UserDiscount |
| float | berechneter Kundenrabatt für dieses Produkt |
UserDiscountRate |
| float | Kundenrabattsatz für dieses Produkt |
OrgPriceDiscount |
| float | Produktrabatt aufgrund des OrgPrice |
OrgPriceDiscountRate |
| float | Rabattsatz des Produktrabatts aufgrund des OrgPrice |
ProductGroupDiscount |
| float | Gewährter Gruppierungsrabatt der Position |
ProductGroupDiscountRate |
| float | Gruppierungsrabattsatz der Position |
ProductGroupDiscountShown |
| global | Zeigt an, ob der Gruppierungsrabatt global oder pro Position abgezogen wurde |
ParticularOrderDiscount |
| float | Teil-Rabattsumme, mit der die Position an der global ausgewiesenen Rabattsumme beteiligt ist. |
ParticularOrderDiscountRate |
| float | Teil-Rabattsatz |
ParticularUserDiscount |
| float | Teil-Rabattsumme, mit der die Position an der global ausgewiesenen Rabattsumme beteiligt ist. |
ParticularUserDiscountRate |
| float | Teil-Rabattsatz |
ParticularPaymentDiscount |
| float | Teil-Rabattsumme, mit der die Position an der global ausgewiesenen Rabattsumme beteiligt ist. |
ParticularPaymentDiscountRate |
| float | Teil-Rabattsatz |
Event |
| HappyHour | Bei „yes“ handelt es sich um einen HappyHour-Artikel |
WishList |
| yes | Artikel ist von einer Wunschliste |
WishListUserIndex |
| Integer | Eindeutiger UserIndex des Wunschlistenbesitzers |
WishListOwner |
|
| konfigurierter Text, ggf. mit Vor- und Nachnamen des Wunschlistenbesitzers |
DownloadProduct |
| yes | Downloadartikel |
GiftProduct |
| yes | Bei „yes“ handelt es sich um ein Geschenkprodukt |
GiftProductSubTotal |
|
| Benötigter Warenwert des Geschenkprodukts pro Stück |
DEEE |
| yes | Position ist DEEE-pflichtig |
DEEEPrice |
| float | DEEE-Kosten pro Stück |
DEEETotal |
| float | DEEE-Kosten der Position |
PriceWithoutDEEE |
| float | Preis pro Stück ohne DEEE-Kosten |
TotalWithoutDEEE |
| float | Finaler Gesamtpreis ohne DEEE-Kosten |
ForceW2PFlag |
| yes | Web2Print Gestaltung wurde für diesen Artikel gewählt (Flag ForceW2PFlag im Bestellgenerator gesetzt) |
W2P |
| yes | Web2Print Gestaltung wurde für diesen Artikel gewählt |
W2PCost |
| float | Web2Print Kosten |
W2PVAT |
| float | MwSt. der Web2Print Kosten |
W2PDocID |
| 128 | DocID des externen Web2Print Systems |
W2PThumbnailURL |
|
| URL zum Vorschaubild des externen Web2Print Systems |
BuyXPayYID |
|
| ID der Aktion BuyXPayY |
BuyXPayYDescription |
|
| Kurzbeschreibung der Aktion BuyXPayY |
BuyXPayYAffectedQty |
| Integer | Betroffene Menge rabattierte Anzahl der Positionen bei Aktion BuyXPayY |
MultiDeliveryAddressUsageCost |
| float | zusätzliche Gesamtkosten bei MultiDelivery |
DeliveryAddressOrderIndex |
| Integer | eindeutiger vom System vergebener Index, der auf die Lieferadresse (Sektion DeliveryAddress) referenziert. |
<DeliverySplit> |
| -- | Untersektion bei MultiDelivery |
<+Entry> |
| -- | eine eigene Untersektion für jede Lieferadresse bei MultiDelivery |
DeliveryAddressOrderIndex |
| Integer | eindeutiger vom System vergebener Index, der auf die Lieferadresse (Sektion DeliveryAddress) oder die Rechnungsadresse referenziert |
Quantity |
| Integer | Anzahl der Exemplare, die an eine Adresse geliefert werden |
SampleCopy |
| yes | nur wenn Belegexemplare bestellt wurden |
SampleCopyQuantity |
| Integer | Anzahl der Belegexemplare |
SampleCopyCost |
| float | Kosten für Belegexemplare |
DeliverySelectionOrderIndex |
|
| eindeutiger vom System vergebener Index, der auf die gewählte Versandart referenziert (Sektion <+DeliverySelection>) |
</+Entry> |
| -- | Ende der Untersektion für eine Lieferadresse (MultiDelivery) |
</DeliverySplit> |
| -- | Ende der Untersektion bei MultiDelivery |
Total | X | float | Dies ist der finale Gesamtpreis des Produktes inkl. aller Rabatte, Staffelpreise, Zusatzkosten, Aufschläge etc. und inkl. der Bestellmenge. Wenn Sie den finalen Stückpreis benötigen, dann lesen Sie bitte den Parameter SingleTotal |
SingleTotal | X | float | Dies ist der finale Stückpreis des Produktes inkl. aller Rabatte, Staffelpreise, Zusatzkosten, Aufschläge etc. |
SingleTotal2 |
| float | Dies ist der finale Stückpreis des Produktes inkl. aller Rabatte, Staffelpreise, Zusatzkosten, Aufschläge etc. mit bis zu 9 Nachkommastellen (wenn in shop.config definiert) |
CustomizedBasketPositionOrderData01-ContentHexCoded |
|
| Hex-kodierter Inhalt, der durch die Funktion "CustomizedBasketPositionOrderData (CBPOD)" auf bis zu 5 Templates dynamisch generiert wurde. |
<BasketProductOption> |
|
| Beginn der Untersektion bei freie Felder auf Split-Posiotionsebene (BasketProductOptions BPO) Beachten Sie: |
BasketProductOptionID |
|
| ID der BasketProductOption aus der Shopkonfiguration |
<Inputs> |
|
| Untersektion für alle freien Felder |
<Input> |
|
| Untersektion für jedes freie Feld |
ID |
|
| ID des freien Feldes aus der Shopkonfiguration |
Value |
|
| bei Input-Feld: Eingabe des Kunden bei aktivierter Checkbox: “on“ |
Costs |
| float | Betrag der zusätzlichen Kosten für dieses freie Feld |
</Input> |
|
| Ende der Untersektion für ein freies Feld |
</Inputs> |
|
| Ende der Untersektion aller Felder |
<Costs> |
|
| Untersektion für die zusätzliche Kostenberechnung für freie Felder (BPO) |
<Cost> |
|
| Untersektion für jede konfigurierte Kostenberechnung |
ID |
|
| ID der Kostenberechnung aus der Shopkonfiguration |
Name |
|
| Name der Kostenberechnung aus der Shopkonfiguration |
Costs |
| float | Betrag der zusätzlichen Kosten |
Valid |
| yes | wenn die Kostenberechnung erfolgt ist |
</Cost> |
|
| Ende der Untersektion für die Kostenberechnung für BPO |
</Costs> |
|
| Ende der Untersektion der zusätzlichen Kosten für BPO |
</BasketProductOption> |
|
| Ende der Untersektion bei BasketProductOptions BPO |
Anmerkungen zu Set-Artikeln:
Hat ein Artikel einen Wert für "SetParentID" dann ist er ein Set-Oberartikel. Hat ein Artikel einen Wert für "SetChildID" dann ist er ein Set-Unterartikel.
Ober-und Unterartikel bekommen eine gleiche ID zugewiesen. Dadurch entsteht eine eindeutige Zuordnung zwischen einem Set-Oberartikel und ein oder mehreren dazugehörigen Set-Unterartikeln.
Beispiel: Set mit 3 Unterartikeln:
<OrderList>
<Item>
ID = 12345
SetParentID = 12345-1 (Set-Oberartikel)
</Item>
<Item>
ID = 112233
SetChildID = 12345-1 (Set-Unterartikel)
</Item>
<Item>
ID = 121212
SetChildID = 12345-1 (Set-Unterartikel)
</Item>
<Item>
ID = 222333
SetChildID = 12345-1 (Set-Unterartikel)
</Item>
</OrderList>
Sektion: Vouchers (Gutscheine)
Diese Sektion ist nur bei der Funktion “Mehrere Gutscheine einlösen (MultiVoucher)“ als eigenständige Hauptsektion in den Bestelldaten vorhanden.
Die gleichen Parameter zur einfachen Verwendung eines einzelnen Gutscheins befinden sich ansonsten innerhalb der Sektion <Order>.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
<+Voucher> |
|
| Nur bei “Mehrere Gutscheine einlösen (MultiVoucher)”: Für jeden Gutschein wird eine Untersektion angelegt |
Index |
|
| Nur bei “Mehrere Gutscheine einlösen (MultiVoucher)”: Jeder Gutschein wird automatisch mit einem Index beginnend mit 1 nummeriert. |
VoucherNumber |
| 19 | Die Nummer des eingelösten Gutscheins |
VoucherRest |
| float | Der Restbetrag des eingelösten Gutscheins |
VoucherRest_DName |
|
| (sprachabhängiger) angezeigter Name des Restbetrags |
VoucherRest_DValue |
|
| im Shop angezeigter Wert des Restbetrags |
VoucherChargeID |
| 64 | Die Chargen-ID des eingelösten Gutscheins |
VoucherChargeCreator |
| 128 | Vorname und Nachname des Chargen-Erstellers, der die Charge im OSB angelegt hat |
VoucherChargeLabel |
| 128 | Chargen-Label, das im OSB per Dropdown-Liste ausgewählt werden kann |
VoucherAmount |
| float | Der eingelöste Betrag eines Gutscheins. Wurde z.B. ein Gutschein im Wert von 100€ eingelöst, obwohl der Rechnungsbetrag sich nur auf 25€ belief, so würde hier „25.00“ stehen. |
VoucherAmount_DName |
|
| Name aus der Shopkonfiguration z. B. “Gutschein” |
VoucherAmount_DValue |
|
| Der negative Betrag des Gutscheins mit Währungsangabe |
VoucherPositionAmount |
| float | Summe der auf Positionsebene bestimmten Gutscheinbeträge |
VoucherVATRate |
| float | Mehrwertsteuersatz des Gutscheins |
VoucherVATIndex |
| Integer | Mehrwertsteuerindex des Gutscheins |
VoucherVATProportional |
|
|
|
<VoucherVATRatios> |
|
|
|
<VoucherVATRatios>.VATRateRatio-X |
|
|
|
VoucherType |
| absolute | Art des Gutscheins: absolut oder prozentual |
VoucherRate |
| float | prozentualer Gutscheinwert (z.B. 5.00 für 5% Gutschein) |
VoucherSetWarranties |
|
| Berechtigungscodes des Gutscheins |
VoucherMaxSetChildSum |
|
|
|
SpecialFeaturesAdditionalProductFieldsFilter |
| yes | Der Gutschein ist abhängig von Produktdatenfelder (yes) |
SpecialFeaturesAdditionalProductFieldsFilter_SetBehavior |
| asUnit/single | Set-Unterprodukte werden als Einheit betrachtet oder einzeln geprüft |
SpecialFeaturesAdditionalProductFieldsFilter_fieldname_X |
| 128 | technischer Feldname des zu prüfenden Produktdatenfeldes (X: Nummer des Filters) |
SpecialFeaturesAdditionalProductFieldsFilter_valuelist_X |
| 1024 | kommaseparierte Liste mit Werten, die im Produktdatenfeld enthalten sein müssen (X: Nummer des Filter) |
SpecialFeaturesInventoryState |
|
|
|
SpecialFeaturesInventoryState_SetBehavior |
|
|
|
SpecialFeaturesInventoryState_valueList |
|
|
|
Sektion: CreditPass (Bonitätsprüfung via CreditPass)
Diese Sektion ist optional und wird nur dann angezeigt, wenn der Besteller via CreditPass geprüft wurde. Die Antwortparameter werden in der Dokumentation von CreditPass näher erläutert. Bitte wenden Sie sich hierzu an CreditPass.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Result | X | Positive Negative Alarm | Die möglichen Werte sind „Positive“: Autorisierung erfolgt „Negative“: keine Autorisierung, keine Aussage möglich oder Verbindungsfehler „Alarm“: Autorisierung erfolgt unter Vorbehalt. Manuelle Prüfung erforderlich bevor die Sendung erfolgt. |
AnswerCode | X |
| Der Antwortcode von CreditPass. 0: autorisiert (Result=Positive) 1: nicht autorisiert (Result=Negative) 2: Autorisiert unter Vorbehalt. Der Shopbetreiber muss eine manuelle Prüfung durchführen (Result=Alarm) -1: Keine Aussage möglich/Fehler/Keine Verbindung zu CreditPass (Result=Negative) |
TA_ID | X |
| Die eindeutige Transaktionsnummer von CreditPass. (Siehe Dokumentation von CreditPass) |
AUTHORISATION_ID | X |
| Siehe Dokumentation von CreditPass |
AnswerText | X |
| Hinweistext zum Antwortcode. |
AnswerDetails | X |
| Antwortdetails bei bestimmten Matrizen. |
Bitte beachten Sie:
Unsichere Zahlungsarten werden vom Shop nur dann angeboten, wenn der AnswerCode „0“ oder „2“ ist. Bei allen anderen Werten oder Zuständen werden nur noch die Zahlungsarten angeboten, die im Shop als sicher definiert wurden. Dies gilt auch dann, wenn z.B. keine Verbindung zu CreditPass aufgebaut werden konnte oder ein Problem bzgl. der Kommunikation zwischen WEBSALE und CreditPass besteht.
Autorisierung unter Vorbehalt (Result=Alarm):
Ist der AnswerCode „2“ (Result=Alarm), dann wurde der Besteller in einer Sanktionsliste gefunden. Die Bestellung darf dann nicht ungeprüft versendet werden. Weitere Details hierzu, werden in den Parametern „AnswerText“ und „AnswerDetails“ übergeben, sofern diese von CreditPass geliefert werden. Weitere Informationen hierzu, entnehmen Sie bitte der Dokumentation von CreditPass.
Sektion: TaxIDOnlineCheck (Onlineüberprüfung ausländischer UstIDs)
Diese Sektion ist optional und wird nur dann angezeigt, wenn die Online-Überprüfung von ausländischen SteuerIDs aktiviert ist.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Status | X | checked unchecked | Die möglichen Werte sind |
[Parameter] |
| [Wert] | Es werden alle von der BZSt-Schnittstelle zurückgelieferten Parameter/Wert-Paare übergeben |
Bitte beachten Sie:
Welche Parameter und entsprechende Werte in der Sektion ausgegeben werden, hängt von der BZSt- Schnittstelle ab.
Die Überprüfung wird einmal pro Bestellung durchgeführt. Eine negative Prüfung hat keine Auswirkung auf das Shopverhalten!
Sektion: CreditCard (Kreditkartendaten)
Diese Sektion ist optional und wird nur bei der Zahlungsart Kreditkarte übergeben. Weiter optional sind
Number
ExpireDate
CVCode
und werden nur dann übergeben, wenn dies explizit im Shop freigeschaltet wurde und damit das WWS berechtigt ist, diese Daten zu speichern (PCI-zertifiziert ist).
Ausnahme:
Computop-Pseudokartendaten. Das WWS darf diese Daten auch ohne PCI-Zertifizierung speichern.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Type | X | 255 | Der im Shop frei vergebbare Name des Kartentyps „VISA“, „Mastercard“, etc. |
Holder | X | 128 | Karteninhaber |
CardIndex |
| Integer | Der eindeutige Kartenindex bei Verwendung von multiplen Kreditkartendaten im Kundenstamm |
OneTime |
| yes no | Nur bei multiplen Kreditkartendaten. Einmalverwendung der Kreditkartendaten. Steht dieser Parameter auf „yes“, dann wurden diese Daten nicht in der Kundendatenbank gespeichert und darf vom WWS nicht in den Shop zurückrepliziert werden. |
Number | X | 19 | Kreditkartennummer |
ExpireDate | X | 7 | Verfallsdatum der Karte im Format MM-JJJJ |
ComputopPayID |
| 255 | Nur bei Online-Clearing mit Computop. Die PayID von Computop. Siehe Computop Dokumentation. |
ComputopMatch |
| 255 | Nur bei Online-Clearing mit Computop. Parameter Match von Computop. Siehe Computop Dokumentation. |
SaferpayID |
| 255 | Nur bei Online-Clearing mit Saferpay. Die SaferpayID. Siehe Saferpay Dokumentation. |
SaferpayToken |
| 255 | Nur bei Online-Clearing mit Saferpay. Das SaferpayToken. Siehe Saferpay Dokumentation. |
TelecashTDate |
| 255 | Nur bei Online-Clearing mit Telecash. Siehe Telecash Dokumentation. |
TelecashOrderID |
| 64 | Nur bei Online-Clearing mit Telecash. Siehe Telecash Dokumentation. |
TelecashHostedDataID |
| 64 | Nur bei Online-Clearing mit Telecash. Siehe Telecash Dokumentation. |
WireCardPaymentState |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardAmount |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardCurrency |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardPaymentType |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardFinancialInstitution |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardLanguage |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardOrderNumber |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardFingerPrint |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardAnonymousPan |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardAuthenticated |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardExpiry |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardCardHolder |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardMaskedPan |
| 64 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardGatewayReferenceNumber |
| 255 | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WireCardAutoDeposit |
| yes no | Nur bei Online-Clearing mit Wirecard. Siehe Wirecard Dokumentation. |
WSCardType |
| Integer | Interner Kartentyp von WEBSALE |
WSCapture |
| auto manual | auto: Betrag wurde angewiesen |
PostFinanceBrand |
| 64 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinanceCardNo |
| 64 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinanceCN |
| 64 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinanceAmount |
| 32 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinanceCurrency |
| 32 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinancePayID |
| 128 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinancePayIDSub |
| 128 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinancePM |
| 64 | Nur bei Online-Clearing mit PostFinance. |
PostFinanceSCOCategory |
| 32 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinanceScoring |
| 32 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinanceStatus |
| 32 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
PostFinanceTRXDate |
| 32 | Nur bei Online-Clearing mit PostFinance. Siehe PostFinance Dokumentation. |
OgonePayID |
| 64 | Nur bei Online-Clearing mit Ogone. Siehe Ogone Dokumentation. |
OgoneStatus |
| 16 | Nur bei Online-Clearing mit Ogone. Siehe Ogone Dokumentation. |
OgoneNCStatus |
| 16 | Nur bei Online-Clearing mit Ogone. Siehe Ogone Dokumentation. |
OgoneNCError |
| 16 | Nur bei Online-Clearing mit Ogone. Siehe Ogone Dokumentation. |
PaymetricAuthCode |
| 64 | Nur bei Online-Clearing mit Paymetric Authorisierungscode von Paymetric (XiPay) |
PaymetricOperation |
| 64 | Nur bei Online-Clearing mit Paymetric SALE oder AUTHORIZATION |
PaymetricECIFlag |
| 2 | Nur bei Online-Clearing mit Paymetric ECI-Flag von Paymetric (DiEComm) |
PaymetricCAVV |
| 64 | Nur bei Online-Clearing mit Paymetric CAVV-Code von Paymetric (DiEComm) |
PaymetricPayNetTransID |
| 64 | Nur bei Online-Clearing mit Paymetric XiPayNetTransID von Paymetric (DiEComm) |
PaymetricInterceptCCToken |
| 255 | Nur bei Online-Clearing mit Paymetric Pseudokreditkartennummer (tokenized, XiIntercept) |
PaymetricInterceptCCName |
| 64 | Nur bei Online-Clearing mit Paymetric Kreditkartenname (XiIntercept) |
PaymetricInterceptLookupTransID |
| 255 | Nur bei Online-Clearing mit Paymetric cmpi_lookup: TransactionID (XiIntercept) |
PaymetricInterceptLookupEnrolled |
| 16 | Nur bei Online-Clearing mit Paymetric cmpi_lookup: Enrolled (XiIntercept) |
PaymetricInterceptLookupOrderID |
| 255 | Nur bei Online-Clearing mit Paymetric cmpi_lookup: OrderID (XiIntercept) |
PaymetricInterceptLookupECIFlag |
| 16 | Nur bei Online-Clearing mit Paymetric cmpi_lookup: ECIFlag (XiIntercept) |
PaymetricInterceptAuthenticate |
| 3 | Nur bei Online-Clearing mit Paymetric „yes“ oder „no“: cmpi_authenticate vorhanden (XiIntercept) |
PaymetricInterceptAuthenticateECI Flag |
| 16 | Nur bei Online-Clearing mit Paymetric cmpi_authenticate: ECIFlag (XiIntercept) |
PaymetricInterceptAuthenticatePAR eStatus |
| 16 | Nur bei Online-Clearing mit Paymetric cmpi_authenticate: PAReStatus (XiIntercept) |
PaymetricInterceptAuthenticateSignatureVerification |
| 16 | Nur bei Online-Clearing mit Paymetric cmpi_authenticate: SignatureVerification (XiIntercept) |
PaymetricInterceptAuthenticateXID |
| 255 | Nur bei Online-Clearing mit Paymetric cmpi_authenticate: XID (XiIntercept) |
PaymetricInterceptAuthenticateCAVV |
| 255 | Nur bei Online-Clearing mit Paymetric cmpi_authenticate: Cavv (XiIntercept) |
PaymetricCardType |
| 64 | Nur bei Online-Clearing mit Paymetric CardType von Paymetric (XiPay) |
PaymetricCardNumber |
| 64 | Nur bei Online-Clearing mit Paymetric CardNumber von Paymetric (XiPay) |
PaymetricCardExpirationDate |
| 64 | Nur bei Online-Clearing mit Paymetric ExpirationDate von Paymetric (XiPay) |
PaymetricCardHolderName |
| 64 | Nur bei Online-Clearing mit Paymetric CardHolder von Paymetric (XiPay) |
PaymetricAmount |
| 64 | Nur bei Online-Clearing mit Paymetric Amount von Paymetric (XiPay) |
PaymetricCurrencyKey |
| 64 | Nur bei Online-Clearing mit Paymetric CurrencyKey von Paymetric (XiPay) |
PaymetricAuthorizationDate |
| 64 | Nur bei Online-Clearing mit Paymetric AuthorizationDate von Paymetric (XiPay) |
PaymetricAuthorizationTime |
| 64 | Nur bei Online-Clearing mit Paymetric AuthorizationTime von Paymetric (XiPay) |
PaymetricTransactionID |
| 64 | Nur bei Online-Clearing mit Paymetric TransactionID von Paymetric (XiPay) |
PaymetricStatusCode |
| 64 | Nur bei Online-Clearing mit Paymetric StatusCode von Paymetric (XiPay) |
PaymetricMessage |
| 64 | Nur bei Online-Clearing mit Paymetric Message von Paymetric (XiPay) |
PaymetricAVSCode |
| 64 | Nur bei Online-Clearing mit Paymetric AVSCode von Paymetric (XiPay) |
Sektion: DebitNote (Lastschrift)
Diese Sektion ist optional und wird nur bei einem Offline-Lastschriftverfahren übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Owner |
| 255 | Kontoinhaber |
Bank | X | 255 | Name der Bank |
BankRoutingNumber | X* | 32 | BLZ |
AccountNumber | X* | 32 | Kontonummer |
IBAN | X* | 32 | IBAN |
BIC |
| 11 | BIC |
SEPALastDirectMandate |
| 128 | Verwendete Mandatsnummer |
SEPADirectMandateSent |
| Integer | 0: Mandat wurde nicht per eMail versendet |
BankIndex |
| Integer | Ein eindeutiger Index bei multiplen Bankdaten |
ExternalID |
| 255 | Externe ID bei multiplen Bankdaten, welche vom WWS vergeben werden kann. |
OneTime |
| yes | Nur bei multiplen Bankdaten. Einmalverwendung der Bankdaten. Steht dieser Parameter auf „yes“, dann wurde diese Bankverbindung nicht in der Kundendatenbank gespeichert und darf vom WWS nicht in den Shop zurückrepliziert werden. |
ComputopPayID |
| 255 | Nur bei Online-Clearing mit Computop. |
* wurde die Bestellung im SEPA-Modus aufgegeben, ist nur das Feld IBAN Pflichtfeld. Ansonsten sind die Felder BankRoutingNumber und AccountNumber Pflichtfelder.
Sektion: DIRECTebanking (Sofortüberweisung)
Diese Sektion ist optional und wird nur bei der Zahlungsart „Sofortüberweisung“ übergeben. Karteninhaber, Kontonummer, BLZ etc. sind die Daten, die der Besteller bei Sofortüberweisung eingegeben hat.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Transaction | X | 255 | Die eindeutige TransaktionsID von Sofortüberweisung |
Holder | X | 128 | Karteninhaber |
AccountNumber | X | 128 | Kontonummer |
BankCode | X | 128 | BLZ |
BankName | X | 128 | Name der Bank |
BIC |
| 128 | BIC |
IBAN |
| 128 | IBAN |
Sektion: iDEAL (iDEAL via Computop)
Diese Sektion ist optional und wird nur bei der Zahlungsart „iDEAL“ in Verbindung mit Computop übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
ComputopPayID | X | 255 | Die Computop PayID |
ComputopXID | X | 128 | Siehe Dokumentation von Computop |
AccountOwner | X | 128 | Siehe Dokumentation von Computop |
AccountNumber | X | 128 | Siehe Dokumentation von Computop |
AccountIBAN | X | 128 | Siehe Dokumentation von Computop |
AccountBank | X | 128 | Siehe Dokumentation von Computop |
IBAN | X | 128 | Siehe Dokumentation von Computop |
BIC | X | 128 | Siehe Dokumentation von Computop |
Sektion: iDEAL (iDEAL via Wirecard)
Diese Sektion ist optional und wird nur bei der Zahlungsart „iDEAL“ in Verbindung mit Wirecard übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
WireCardPaymentState |
| 64 | Siehe Dokumentation von Wirecard |
WireCardAmount |
| 64 | Siehe Dokumentation von Wirecard |
WireCardCurrency |
| 3 | Siehe Dokumentation von Wirecard |
WireCardPaymentType |
| 64 | Siehe Dokumentation von Wirecard |
WireCardFinancialInstitution |
| 64 | Siehe Dokumentation von Wirecard |
WireCardLanguage |
| 3 | Siehe Dokumentation von Wirecard |
WireCardOrderNumber |
| 64 | Siehe Dokumentation von Wirecard |
WireCardFingerPrint |
| 64 | Siehe Dokumentation von Wirecard |
WireCardIDEALConsumerName |
| 255 | Siehe Dokumentation von Wirecard |
WireCardIDEALConsumerCity |
| 255 | Siehe Dokumentation von Wirecard |
WireCardIDEALConsumerAccountNumber |
| 255 | Siehe Dokumentation von Wirecard |
WireCardGatewayReferenceNumber |
| 255 | Siehe Dokumentation von Wirecard |
Sektion: DebitCard (DebitCard via Wirecard)
Diese Sektion ist optional und wird nur bei der Zahlungsart „DebitCard“ in Verbindung mit Wirecard übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
WireCardPaymentState |
| 64 | Siehe Dokumentation von Wirecard |
WireCardAmount |
| 64 | Siehe Dokumentation von Wirecard |
WireCardCurrency |
| 3 | Siehe Dokumentation von Wirecard |
WireCardPaymentType |
| 64 | Siehe Dokumentation von Wirecard |
WireCardFinancialInstitution |
| 64 | Siehe Dokumentation von Wirecard |
WireCardLanguage |
| 3 | Siehe Dokumentation von Wirecard |
WireCardOrderNumber |
| 64 | Siehe Dokumentation von Wirecard |
WireCardFingerPrint |
| 64 | Siehe Dokumentation von Wirecard |
WireCardAnonymousPan |
| 64 | Siehe Dokumentation von Wirecard |
WireCardAuthenticated |
| 64 | Siehe Dokumentation von Wirecard |
WireCardExpiry |
| 64 | Siehe Dokumentation von Wirecard |
WireCardCardHolder |
| 64 | Siehe Dokumentation von Wirecard |
WireCardMaskedPan |
| 64 | Siehe Dokumentation von Wirecard |
WireCardGatewayReferenceNumber |
| 255 | Siehe Dokumentation von Wirecard |
WireCardAutoDeposit |
| yes no | Siehe Dokumentation von Wirecard |
Sektion: DotPay
Diese Sektion ist optional und wird nur bei der Zahlungsart „DotPay“ übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
ID | X | 128 | Eindeutige TransaktionsID. Siehe Dokumentation von DotPay. |
Status |
| 128 | Siehe Dokumentation von DotPay |
TID |
| 128 | Siehe Dokumentation von DotPay |
Amount |
| Integer | Siehe Dokumentation von DotPay |
| 128 | Siehe Dokumentation von DotPay | |
Service |
| 128 | Siehe Dokumentation von DotPay |
Code |
| 128 | Siehe Dokumentation von DotPay |
Username |
| 128 | Siehe Dokumentation von DotPay |
Password |
| 128 | Siehe Dokumentation von DotPay |
Tstatus |
| 128 | Siehe Dokumentation von DotPay |
Description |
| 128 | Siehe Dokumentation von DotPay |
MD5 |
| 128 | Siehe Dokumentation von DotPay |
PInfo |
| 128 | Siehe Dokumentation von DotPay |
PEmail |
| 128 | Siehe Dokumentation von DotPay |
TDate |
| 128 | Siehe Dokumentation von DotPay |
Sektion: DirectDebitPayEX
Diese Sektion ist optional und wird nur bei der Zahlungsart „DirectDebitPayEX“ übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
TransactionRef |
| 255 | Siehe Dokumentation von PayEX. |
TransactionNumber |
| 255 | Siehe Dokumentation von PayEX |
Sektion: ClickAndBuy
Diese Sektion ist optional und wird nur bei der Zahlungsart „ClickAndBuy“ übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
ComputopPayID | X | 255 | Die Computop PayID |
CRN |
| 64 | Die TeilnehmerID des Käufers bei ClickAndBuy |
Sektion: PostFinance
Diese Sektion ist optional und wird nur bei der Zahlungsart „PostFinance“ übergeben.
Parameter | Bemerkung |
---|---|
ComputopPayID | Vom Paygate vergebene ID für die Zahlung; z. B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request. |
ComputopXID | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden. |
ComputopPaymentPurpose | Eindeutige ID, welche von PPRO generiert und im eigenen Abrechnungsfile von PostFinance bereitgestellt wird. Diese ID sollte auf Händlerseite zum Abgleich offener Positionen verwendet werden. Die RefNr. kann für diesen Zweck bei dieser Zahlungsmethode nicht verwendet werden. |
ComputopPaymentGuarantee | FULL: Zahlungsgarantie |
Sektion: Bill
Diese Sektion ist optional und wird nur bei der Zahlungsart „Rechnung“ in Verbindung mit CompuTop und Klarna übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
CTopPayID | X | 255 | Die Computop PayID |
CTopRNo |
| 64 | Die Computop/Klarna Reservierungsnummer |
Sektion: Installment
Diese Sektion ist optional und wird nur bei der Zahlungsart „Finanzierung“ in Verbindung mit CompuTop und Klarna übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
CTopPayID | X | 255 | Die Computop PayID |
CTopRNo |
| 64 | Die Computop/Klarna Reservierungsnummer |
Clearing |
|
| EasyCredit (falls verwendet) |
WebshopID |
| 128 | Die EasyCredit WebshopID |
Vorgangskennung |
| 1024 | Die EasyCredit Vorgangskennung |
EasyCreditJSONResponseObjectHexCoded |
|
| Response von EasyCredit hexkodiert |
Sektion: PayPalDirect
Diese Sektion ist optional und wird nur bei der Zahlungsart „PayPal“ in Verbindung mit der Direktanbindung an PayPal übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Token | X | 128 | Siehe Dokumentation von PayPal |
PayerID | X | 128 | Siehe Dokumentation von PayPal |
TransactionID | X | 128 | Siehe Dokumentation von PayPal |
OrderTime | X | 64 | Siehe Dokumentation von PayPal |
PaymentType |
| 64 | Siehe Dokumentation von PayPal |
SettleAmt |
| 64 | Siehe Dokumentation von PayPal |
FeeAmt |
| 64 | Siehe Dokumentation von PayPal |
Amt |
| 64 | Siehe Dokumentation von PayPal |
Currency |
| 32 | Siehe Dokumentation von PayPal |
PaymentStatus |
| 64 | Siehe Dokumentation von PayPal |
PaymentPendingReason |
| 64 | Siehe Dokumentation von PayPal |
PaymentRequestID |
| 64 | Siehe Dokumentation von PayPal |
ProtectionEligibility |
| 32 | Siehe Dokumentation von PayPal |
ProtectionEgilibilityType |
| 32 | Siehe Dokumentation von PayPal |
PayPalAPIUser |
| 128 | Der für den PayPal Zugriff verwendete API-Username |
PayPalMerchantEmail |
| 128 | Die Email-Adresse vom PayPal-Konto des Händlers |
PayPalPaymentAction |
| 16 | Verwendete PaymentAction bei PayPal. Mögliche Werte sind |
ExpressCheckoutUsed |
| yes | Käufer hat den ExpressCheckout benutzt |
<ExpressCheckoutDetails> |
|
| In dieser Sektion werden alle von PayPal in der Methode „GetCheckoutDetails“ zurückgegebenen Parameter-Wert-Paare übergeben. |
Sektion: PayPalCheckout
Diese Sektion ist optional und wird nur bei den Zahlungsarten übergeben, die über „PayPal Checkout“ integriert sind.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
TransactionID |
|
|
|
PaymentID |
|
|
|
MerchantID |
|
|
|
PaymentMode |
|
| PayUponInvoice (Kauf auf Rechnung über RatePay) … |
PayPalPaymentAction |
|
| CAPTURE |
OrderDetailsJSONResponseObjectHexCoded |
|
|
|
PPCExpressUsed |
| yes | Käufer hat den PayPal Express Checkout benutzt |
VaultUsed |
| yes | Käufer hat mit gespeichertem PayPal-Konto bezahlt |
VaultCustomerID |
|
| Von PayPal generierte Customer-ID |
VaultID |
|
| Von PayPal generierte Vault-ID |
Sektion: ClimateNeutral
Diese Sektion ist optional und wird nur übergeben, wenn der Käufer klimaneutrale Produktion für den gesamten Warenkorb gewählt hat. Werden Klimaschutzzertifikate für jede Warenkorbposition einzeln angeboten, werden folgende Parameter in die Sektion OrderList > Item (siehe oben) geschrieben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
Status | X | Failed OK | Failed: der Auftrag der klimaneutralen Produktion konnte nicht final an ClimatePartner übermittelt werden OK: klimaneutrale Produktion erfolgreich an ClimatePartner übermittelt |
OrderID | X | 64 | ID des Autrags bei ClimatePartner |
CertID | X | 64 | ZertifikatsID bei ClimatePartner |
ProjectName | X | 255 | Name des Klimaschutzprojekts bei ClimatePartner |
ProjectOffsetNo | X | 64 | ID des Klimaschutzprojekts bei ClimatePartner |
CreationDate | X | 64 | Erstellungsdatum des Auftrags bei ClimatePartner |
CertURL | X | 1027 | URL zum Zertifikat bei ClimatePartner |
LogoURL | X | 1027 | URL zum Logogenerator bei ClimatePartner |
VerifyURL | X | 1027 | URL zur Bestätigungsseite bei ClimatePartner |
Emissions | X | float | Menge der CO2-Emissionen |
VATRate | X | float | MwSt.-Rate |
VATIndex | X | Integer | MwSt.-Index |
Total | X | float | Gesamtbetrag klimaneutrale Produktion |
TotalPartClimatePartner | X | float | Teilbetrag Kosten bei ClimatePartner |
TotalPartCostAddition | X | float | Teilbetrag festgelegter Aufschlag im Shop |
Sektion: PaymentRuleInput
Diese Sektion ist optional und wird nur übergeben, wenn der Käufer zusätzliche Angaben zu der verwendeten Zahlungsart gemacht hat. Die Sektion kann bis zu 10 Einträge beinhalten.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
<ID> |
| 128 | technischer Wert der Listbox bzw. Eingabe des Käufers. Die ID wird in der Konfiguration der entsprechenden Angabe zur Zahlungsart festgelegt (Konfigurationsdatei shop.config) |
Sektion: ABTests
Diese Sektion ist optional und wird nur übergeben wenn mindestens ein AB-Test aktiv war. Die Sektion kann bis zu 10 Untersektionen <+Test> beinhalten.
<ABTests>
<+Test>
Daten des 1. AB-Tests
</+Test>
<+Test>
Daten des 2. AB-Tests
</+Test>
...
<+Test>
Daten des n-ten AB-Tests
</+Test>
</ABTests>
Daten eines AB-Tests:
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
ID |
| 64 | Technische ID des AB-Tests wie im OSB konfiguriert |
CaseGroup |
|
| Wert zwischen A und J |
Die Sektion kann bis zu 10 Einträge beinhalten.
Sektion: KlarnaCheckout
Diese Sektion ist optional und wird nur bei der Zahlungsart Klarna Checkout übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
ID | X | 128 | Kundenkennung für die Klarna Checkout-Bestellung |
Reference | X | 128 | Endverbraucherfreundliche Referenz |
Reservation | X | 128 | Reservierungsnummer zur Verwendung in der XML-RPC-API |
<CustomerAddress> | X |
| Rechnungsadresse, wie oben beschrieben Sektion CustomerAddress |
<DeliveryAddress> |
|
| Lieferadresse, wie oben beschrieben Sektion DeliveryAddress |
Die Sektionen <CustomerAddress> und <DeliveryAddress> haben die gleichen Parameter-Namen. Alle Parameter sind optional.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
FirstName |
| 128 | Vorname |
LastName |
| 128 | Nachname |
CareOf |
| 128 | Flag “Care of” |
Street1 |
| 255 | Straße und Hausnummer |
ZIP |
| 64 | PLZ |
City |
| 128 | Ort |
CountryISO |
| 3 | 3-Zeichen Ländercode nach ISO 3166 |
| 128 | Email-Adresse | |
Phone |
| 64 | Telefonnummer |
Sektion: Klarna
Diese Sektion ist optional und wird nur bei der Zahlungsart Klarna (Direktanbindung) übergeben.
Parameter | Muss- Feld | Max. Länge <>255 Zeichen | Bemerkung |
---|---|---|---|
ClientToken | X | 128 |
|
AuthorizationToken | X | 128 |
|
KlarnaSessionID | X | 128 |
|
OrderID | X |
|
|
PaymentMethod | X |
|
|
KlarnaExpressCheckoutUsed |
|
| Wenn der Käufer den Express Checkout-Button klickt, werden die Adress-Daten von Klarna in folgender Unter-Sektion im JSON-Format gesendet. |
<ExpressCheckoutDetails> |
|
| Unter-Sektion nur bei Klarna Express Checkout |
JSONAddressData |
|
| Rechnungs- und/oder Lieferadress-Daten von Klarna im JSON-Format |
</ExpressCheckoutDetails> |
|
|
|
Sektion: Paymorrow
Diese Sektion ist optional und wird nur bei der Zahlungsart Paymorrow übergeben.
In dieser Sektion werden alle Parameter aus der XML-Antwort der Methode authorizeByReference von Paymorrow übergeben. Die XML-Antwort von Paymorrow wird vorher in das Bestelldatenformat konvertiert.
Hinweis: Sollte bei der Konvertierung ein Fehler auftreten, wird die XML-Antwort 1:1 in der Untersektion PaymorrowRawRespone übergeben.
Beispiel XML-Antwort von Paymorrow:
Konvertierung in Bestelldatenformat:
Sektion: PrimeShopping
Diese Sektion ist optional und wird nur übergeben, wenn der Käufer angemeldet war und in seinem Kundenkonto mindestens ein Prime-Paket existiert.
Diese Sektion kann beliebig viele Untersektionen <+Package> beinhalten in welchen jeweils die Daten eines erworbenen Prime-Pakets übergeben werden:
Parameter | Muss-Feld | Max. Länge | Bemerkung |
---|---|---|---|
ProdIndex | X | 64 | Produktindex des Prime-Pakets (Produktindex des Set-Oberprodukts) |
ValidFrom | X | 8 | Zeitstempel YYYYMMDD, Prime-Paket gültig seit |
ValidUntil | X | 8 | Zeitstempel YYYYMMDD, Prime-Paket gültig bis |
Canceled | X | yes | Bei "yes" wurde das Prime-Paket via Kundenkonto gekündigt |
ProdOrderInfoPart |
|
| Die ersten 255 Zeichen des Felds OrderInfo des Prime-Produkts (falls zum Zeitpunkt der Bestellung gesetzt) |
PeriodOfNotice | X | Integer | Kündigungsfrist zum Laufzeitende in Tagen |
Sektion: Billie
Diese Sektion ist optional und wird nur bei der Zahlungsart Billie übergeben.
Parameters | Muss-Feld | Max. Länge | Bemerkung |
---|---|---|---|
BillieSessionID | X | 128 | Session-ID von Billie |
WidgetResponseHexCoded | X | 4048 | Hex-kodierte Antwort vom Billie-Widget |
SessionConfirmResponseHexCoded | X | 4048 | Hex-kodierte Antwort von "Checkout Session Confirm" |