Abfrage von Aufträgen |
<request method="fetchOrders" version="1.0.0"> <filter> <mandator_id filter_method="=" filter_value="1"/> <order_number filter_method="=" filter_value="1000000"/> <!-- <order_ids filter_method="IN"> <filter_values> <filter_value>855350</filter_value> <filter_value>855351</filter_value> </filter_values> </order_ids> <order_date from_date="2012-01-01T00:00:00+01:00" to_date="2012-07-31T00:00:00+02:00" allow_null="false"/> <created_at from_date="2012-01-01T00:00:00+01:00" allow_null="true"/> <last_changed to_date="2012-07-31T00:00:00+02:00" /> <export_date from_date="2012-01-01T00:00:00+01:00" to_date="2012-12-31T00:00:00+01:00" allow_null="false"/> <external_order_number_1 filter_method="=" filter_value="ord_99100" allow_null="true"/> <external_order_number_2 filter_method="=" filter_value="ord_99101"/> <marketplace_order_id_1 filter_method="=" filter_value="726234-42" /> <marketplace_order_id_2 filter_method="=" filter_value="Order_4711" /> <payment_method_id filter_method="=" filter_value="7" allow_null="false"/> <order_status_id filter_method="=" filter_value="120"/> <account_id filter_method="=" filter_value="88" /> <email_address filter_method="=" filter_value="address@example.com"/> <customer_ids filter_method="IN"> <filter_values> <filter_value>350205</filter_value> <filter_value>350206</filter_value> </filter_values> </customer_ids> <customer_numbers filter_method="IN"> <filter_values> <filter_value>2612</filter_value> <filter_value>4711</filter_value> </filter_values> </customer_numbers> <complete_status filter_method="=" filter_value="2"/> <invoice_number_filter filter_method="=" filter_value="123456798" /> <order_tags filter_method="IN"> <filter_values> <filter_value>ISPU</filter_value> </filter_values> </order_tags> --> </filter> <use_modification_context_filter>false</use_modification_context_filter> <orders_per_page>20</orders_per_page> <page>1</page> </request> |
Name |
Beschreibung |
Anz. |
Typ |
Sonstiges |
request |
Root-Element der Anfrage |
1 |
Element |
|
method |
Attribut von request. Name der Webservice-Methode. |
1 |
string |
Fester Wert: „fetchOrders“ |
version |
Attribut von request. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
filter |
Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt. |
1..N |
Element |
|
order_ids |
Schränkt die Ergebnismenge der Abfrage auf die angegebenen Auftrags-IDs ein. |
0..1 |
Element |
|
filter_method |
Attribut von order_ids. Legt das Verhalten des order_ids-Filters fest. |
1 |
string |
Fester Wert: "IN" |
filter_values |
Element von order_ids. Fasst ein oder mehrere Auftrags-IDs zusammen. |
1 |
Element |
|
filter_value |
Element von filter_values. Legt die Auftrags-ID fest nach der gefiltert werden soll. Es kann auch gleichzeitig nach mehreren IDs gefiltert werden. Dafür müssen mehrere filter_value Elemente angegeben werden. |
1..N |
Integer |
|
mandator_id |
Schränkt die Ergebnismenge der Abfrage auf Aufträge eines bestimmten Mandanten ein. |
1 |
Element |
|
filter_method |
Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest. |
1 |
integer |
|
order_date |
Schränkt die Ergebnismenge der Abfrage nach dem Auftragsdatum ein. |
0..1 |
Element |
|
from_date |
Attribut von order_date. Selektiert alle Aufträge ab einschließlich des angegebenen Datums. |
0..1 |
dateTime |
|
to_date |
Attribut von order_date. Selektiert alle Aufträge bis einschließlich des angegebenen Datums. |
0..1 |
dateTime |
|
allow_null |
Attribut von order_date. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. |
0..1 |
boolean |
|
last_changed |
Schränkt die Ergebnismenge der Abfrage nach dem letzten Änderungsdatum der Auftragsdatensätze ein. |
0..1 |
Element |
|
from_date |
Attribut von last_changed. Selektiert alle Aufträge die ab einschließlich des angegebenen Datums geändert wurden. |
0..1 |
dateTime |
|
to_date |
Attribut von last_changed. Selektiert alle Aufträge die bis einschließlich des angegebenen Datums geändert wurden. |
0..1 |
dateTime |
|
allow_null |
Attribut von last_changed_at. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. |
0..1 |
boolean |
|
created_at |
Schränkt die Ergebnismenge der Abfrage nach dem Erstellungsdatum der Auftragsdatensätze ein. |
0..1 |
Element |
|
from_date |
Attribut von created_at. Selektiert alle Aufträge die ab einschließlich des angegebenen Datums erstellt wurden. |
0..1 |
dateTime |
|
to_date |
Attribut von created_at. Selektiert alle Aufträge die bis einschließlich des angegebenen Datums erstellt wurden. |
0..1 |
dateTime |
|
allow_null |
Attribut von created_at. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. |
0..1 |
boolean |
|
export_date |
Schränkt die Ergebnismenge der Abfrage nach dem Exportdatum der Auftragsdatensätze ein. |
0..1 |
Element |
|
from_date |
Attribut von export_date. Selektiert alle Aufträge die ab einschließlich des angegebenen Datums erstellt wurden. |
0..1 |
dateTime |
|
to_date |
Attribut von export_date. Selektiert alle Aufträge die bis einschließlich des angegebenen Datums erstellt wurden. |
0..1 |
dateTime |
|
allow_null |
Attribut von export_date. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. |
0..1 |
boolean |
|
filter_method |
Attribut von export_date. Wird verwendet um die Ergebnismenge ausschließlich nach NULL/NOT NULL-Werten einzuschränken |
0..1 |
string |
Feste Werte: „IS“ | „IS NOT“ |
filter_value |
Attribut von export_date. Wird verwendet um die Ergebnismenge ausschließlich nach NULL/NOT NULL-Werten einzuschränken |
0..1 |
string |
Fester Wert: „NULL“ |
order_number |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit der gegebenen Auftragsnummer ein. |
1 |
Element |
|
filter_method |
Attribut von order_number. Legt das Verhalten des Auftragsnummer-Filters fest. |
1 |
string |
|
filter_value |
Attribut von order_number. Legt den Filterwert des Auftragsnummer-Filters fest. |
1 |
integer |
|
order_number_prefix |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit dem angegebenen Auftragsnummern-Präfix ein. |
0..1 |
Element |
|
filter_method |
Attribut von order_number_prefix. Legt das Verhalten des Auftragsnummern-Präfix-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von order_number_prefix. Legt den Filterwert des Auftragsnummern-Präfix-Filters fest. |
1 |
string |
|
external_order_number_1 |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit der gegebenen externen Auftragsnummer ein. |
0..1 |
string |
Länge: 0 - 100 Zeichen |
filter_method |
Attribut von external_order_number_1. Legt das Verhalten des Auftragsnummer-Filters fest. |
1 |
string |
Feste Werte: „=“, „like“, „IS“, „IS NOT“ |
filter_value |
Attribut von external_order_number_1. Legt den Filterwert des Auftragsnummer-Filters fest. |
1 |
integer |
Falls filter_ method = „IS“ oder „IS NOT“: „NULL“ |
allow_null |
Attribut von external_order_number_1. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. Standardwert ist "false". |
0..1 |
boolean |
Falls filter_method = "=" oder "like". |
external_order_number_2 |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit der gegebenen externen Auftragsnummer ein. |
0..1 |
string |
Länge: 0 - 100 Zeichen |
filter_method |
Attribut von external_order_number_2. Legt das Verhalten des Auftragsnummer-Filters fest. |
1 |
string |
Feste Werte: „=“, „like“, „IS“, „IS NOT“ |
filter_value |
Attribut von external_order_number_2. Legt den Filterwert des Auftragsnummer-Filters fest. |
1 |
integer |
Falls filter_ method = „IS“ oder „IS NOT“: „NULL“ |
allow_null |
Attribut von external_order_number_2. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. Standardwert ist "false". |
0..1 |
boolean |
Falls filter_method = "=" oder "like". |
marketplace_order_id_1 |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit der gegebenen Marktplatz-Auftragsnummer ein. |
0..1 |
Element |
|
filter_method |
Attribut von marketplace_order_id_1. Legt das Verhalten des Auftragsnummern-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von marketplace_order_id_1. Legt den Filterwert des Auftragsnummern-Filters fest. |
1 |
string |
|
allow_null |
Attribut von marketplace_order_id_1. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. Standardwert ist "false". |
0..1 |
boolean |
Falls filter_method = "=" oder "like". |
marketplace_order_id_2 |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit der gegebenen zweiten Marktplatz-Auftragsnummer ein. |
0..1 |
Element |
|
filter_method |
Attribut von marketplace_order_id_2. Legt das Verhalten des Auftragsnummern-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von marketplace_order_id_2. Legt den Filterwert des Auftragsnummern-Filters fest. |
1 |
string |
|
allow_null |
Attribut von marketplace_order_id_2. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. Standardwert ist "false". |
0..1 |
boolean |
Falls filter_method = "=" oder "like". |
subchannel_id |
Schränkt die Ergebnismenge der Abfrage auf Aufträge einen bestimmten Verkaufskanal ein. |
0..1 |
Element |
|
filter_method |
Attribut von subchannel_id. Legt das Verhalten des Verkaufskanal-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von subchannel_id. Legt den Filterwert des Verkaufskanal-Filters fest. |
1 |
integer |
Siehe Wertetabelle. |
payment_method_id |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit der gegebenen Zahlungsart ein. |
0..1 |
string |
Länge: 0 - 100 Zeichen |
filter_method |
Attribut von payment_method_id. Legt das Verhalten des Zahlungsart-Filters fest. |
1 |
string |
Feste Werte: „=“, „like“, „IS“, „IS NOT“ |
filter_value |
Attribut von payment_method_id. Legt den Filterwert des Zahlungsart -Filters fest. |
1 |
integer |
Falls filter_ method = „IS“ oder „IS NOT“:„NULL“ sonst beliebig. |
allow_null |
Attribut von payment_method_id. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden. Standardwert ist "false". |
0..1 |
boolean |
Falls filter_ method = "=" oder "like". |
order_status_id |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit dem gegebenen Auftragsstatus ein. Siehe Hinweis. |
0..1 |
Element |
|
filter_method |
Attribut von order_status_id. Legt das Verhalten des Orderstatusfilters fest. |
1 |
string |
Feste Werte: „=“ |
filter_value |
Attribut von order_status_id. Legt den Filterwert des Orderstatusfilters fest. |
1 |
integer |
|
account_id |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit dem gegebenen Account ein. |
0..1 |
Element |
|
filter_method |
Attribut von account_id. Legt das Verhalten des Account-Filters fest. |
1 |
string |
Feste Werte: „=“ |
filter_value |
Attribut von account_id. Legt den Filterwert des Account-Filters fest. |
1 |
integer |
|
email_address |
Schränkt die Ergebnismenge auf die angegebene Rechnungs-E-Mail-Adresse ein. |
0..1 |
Element |
|
filter_method |
Attribut von email_address. Legt das Verhalten des E-Mail-Filters fest. |
1 |
string |
Feste Werte: „=“, „like“ |
filter_value |
Attribut von email_adress. Legt den Filterwert des E-Mail-Filters fest. |
1 |
string |
|
customer_ids |
Schränkt die Ergebnismenge der Abfrage auf die angegebenen Kunden-IDs ein. |
0..1 |
Element |
|
filter_method |
Attribut von customer_ids. Legt das Verhalten des customer_ids-Filters fest. |
1 |
string |
Fester Wert: "IN" |
filter_values |
Element von customer_ids. Fasst ein oder mehrere Kunden-IDs zusammen. |
1 |
Element |
|
filter_value |
Element von filter_values. Legt die Kunden-ID fest nach der gefiltert werden soll. Es kann auch gleichzeitig nach mehreren IDs gefiltert werden. Dafür müssen mehrere filter_value Elemente angegeben werden. |
1..N |
integer |
|
customer_numbers |
Schränkt die Ergebnismenge der Abfrage auf die angegebenen Kunden-Nummern ein. Muss in Kombination mit dem Filter mandator_id verwendet werden. |
0..1 |
Element |
|
filter_method |
Attribut von customer_numbers. Legt das Verhalten des customer_numbers-Filters fest. |
1 |
string |
Fester Wert: "IN" |
filter_values |
Element von customer_numbers. Fasst ein oder mehrere Kunden-IDs zusammen. |
1 |
Element |
|
filter_value |
Element von filter_values. Legt die Kunden-Nummer fest nach der gefiltert werden soll. Es kann auch gleichzeitig nach mehreren Nummern gefiltert werden. Dafür müssen mehrere filter_value Elemente angegeben werden. |
1..N |
integer |
|
complete_status |
Filtert die Aufträge nach dem Checkout-Status. |
0..1 |
Element |
|
filter_method |
Attribut von complete_status. Legt das Verhalten des Complete-Status-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von complete_status. Legt den Filterwert des CompleteStatus-Filters fest. Zusätzliche Informationen zu den einzelnen Werten befinden sich in den Hinweisen. |
1 |
integer |
Feste Werte: 1 (=vollständig) 2 (=schwebend) 3 (=unvollständig) |
invoice_number_filter |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit der gegebenen Rechnungsnummer ein. |
0..1 |
Element |
|
filter_method |
Attribut von invoice_number_filter. Legt das Verhalten des Rechnungsnummern-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von invoice_number_filter. Legt den Filterwert des Rechnungsnummern-Filters fest. |
1 |
integer |
|
order_tags |
Schränkt die Ergebnismenge der Abfrage auf Aufträge mit den angegebenen Auftragskennzeichen ein. |
0..1 |
Element |
|
filter_method |
Attribut von order_tags. Legt das Verhalten des order_tags-Filters fest. |
1 |
string |
Werte: "IN" | "NOT IN" |
filter_values |
Element von order_tags. Fasst ein oder mehrere order_tags zusammen. |
1 |
Element |
|
filter_value |
Element von filter_values. Legt das Auftragskennzeichen fest nach dem gefiltert werden soll. Es kann gleichzeitig nach mehreren Auftragskennzeichen gefiltert werden. Dafür müssen mehrere filter_value Elemente angegeben werden. Wichtig: Werden mehrere Auftragskennzeichen angegeben, dann erfolgt die Filterung UND-Verknüpft. Filtert man auf Auftragskennzeichen "A" und "B", dann werden alle Aufträge zurückgegeben die beide Kennzeichen zugewiesen haben. Aufträge die nur eines der Kennzeichen haben, werden nicht ausgegeben. Aufträge die zusätzlich zu "A" und "B" noch weitere Kennzeichen haben, werden ausgegeben. |
1..N |
string |
|
Aktiv (Standardeinstellung): Es werden nur Aufträge selektiert, die zuletzt von Speed4Trade CONNECT (Marktplatzaktualisierung oder Benutzer) geändert wurden. Alle anderen, die durch die Webservice-API von Speed4Trade CONNECT geändert wurden, werden ignoriert.
Inaktiv: Es werden alle Aufträge selektiert, unabhängig davon, durch wen sie zuletzt geändert wurden. |
0..1 |
boolean |
||
orders_per_page |
Anzahl der Aufträge, die pro Seite zurückgegeben werden sollen. |
0..1 |
integer |
Muss zusammen mit „page“ genutzt werden. |
page |
Die Seitennummer, von der die Aufträge zurückgegeben werden sollen. Wird „orders_per_page“ und „page“ weggelassen, so werden alle Aufträge zurückgegeben. |
0..1 |
integer |
Muss zusammen mit „orders_per_ page“ genutzt werden. |
<response method="fetchOrders" version="1.0.0"> <report return_code="0" /> <total_number_of_pages>2</total_number_of_pages> <total_number_of_entries>30</total_number_of_entries> <order> <order_id>3066</order_id> <mandator_id>1</mandator_id> <order_number>66</order_number> <external_order_number_1>ext_ord_no_1</external_order_number_1> <external_order_number_2>ext_ord_no_2</external_order_number_2> <marketplace_order_id>123456789</marketplace_order_id> <marketplace_order_id_2>123456789</marketplace_order_id_2> <order_date>2011-04-06T15:42:00.000+02:00</order_date> <created_at>2011-04-06T15:42:00.000+02:00</created_at> <last_changed_at>2011-04-06T15:42:00.000+02:00</last_changed_at> <shipping_charge>5.0000</shipping_charge> <cash_on_delivery_charge>3.0000</cash_on_delivery_charge> <payment_method_charge>2.0000</payment_method_charge> <weight_in_gram>5000.0000</weight_in_gram> <coupon_amount>20.00</coupon_amount> <rebate>2.00</rebate> <shipping_provider>143</shipping_provider> <shipping_provider_identifier>DHL</shipping_provider_identifier> <dispatch_type> <dispatch_type_id>1</dispatch_type_id> <identifier>Standard</identifier> <external_id>ext-Standard</external_id> </dispatch_type> <price_type> <price_type_id>1</price_type_id> <price_type_identifier>gross</price_type_identifier> </price_type> <currency_code_iso>EUR</currency_code_iso> <note>Wichtiger Auftrag. Bitte sorgfälltig bearbeiten.</note> <order_notices> <order_notice> <order_notice_id>1469773</order_notice_id> <created_at>2012-03-07T10:25:15.907+01:00</created_at> <created_by>Administrator</created_by> <last_changed_at>2012-03-07T10:25:15.907+01:00</last_changed_at> <last_changed_by>Administrator</last_changed_by> <text>Bitte Paket erst in 4 Wochen versenden. Ich bin im Urlaub.</text> <notice_type>20</notice_type> </order_notice> </order_notices> <sub_channel> <sub_channel_id>4100</sub_channel_id> <sub_channel_identifier>Telefonverkauf</sub_channel_identifier> </sub_channel> <account> <account_id>2649</account_id> <account_identifier>Musteraccount</account_identifier> </account> <order_status> <order_status_id>120</order_status_id> <order_status_identifier>outstanding payment</order_status_identifier> </order_status> <payment_method> <payment_method_id>2</payment_method_id> <payment_method_identifier>credit card</payment_method_identifier> </payment_method> <hold_reason_id>132</hold_reason_id> <hold_reason>Artikel derzeit nicht vorrätig.</hold_reason> <customer_type> <customer_type_id>2</customer_type_id> <customer_type_identifier>business</customer_type_identifier> </customer_type> <customer_language_code_iso>de</customer_language_code_iso> <customer> <customer_id>3064</customer_id> <customer_number>5037</customer_number> <external_customer_id_1>ext_cust_no1</external_customer_id_1> <external_customer_id_2>ext_cust_no2</external_customer_id_2> <specific_customer_data> <ebay_customer_data> <ebay_user_name>ebay_testuser</ebay_user_name> </ebay_customer_data> </specific_customer_data> </customer> <master_customer> <customer_id>1000</customer_id> <customer_number>1001</customer_number> <external_customer_id_1>cust_1000</external_customer_id_1> <external_customer_id_2>cust2_1000</external_customer_id_2> </master_customer> <invoice_address> <address_id>3064</address_id> <salutation> <salutation_id>1</salutation_id> <salutation_identifier>mr</salutation_identifier> </salutation> <firm>Speed4Trade GmbH</firm> <title>Dr.</title> <first_name>Max</first_name> <last_name>Mustermann</last_name> <street>Beim Flugplatz</street> <house_number>8</house_number> <street_addition>1. Stock</street_addition> <postal_code>92655</postal_code> <city>Grafenwöhr</city> <country_code_iso>DE</country_code_iso> <phone_number>09641 45 49 0</phone_number> </invoice_address> <shipping_address> <address_id>3064</address_id> <salutation> <salutation_id>1</salutation_id> <salutation_identifier>mr</salutation_identifier> </salutation> <firm>Speed4Trade GmbH</firm> <title>Dr.</title> <first_name>Max</first_name> <last_name>Mustermann</last_name> <street>Beim Flugplatz</street> <house_number>8</house_number> <street_addition>1.Stock</street_addition> <postal_code>92655</postal_code> <city>Grafenwöhr</city> <country_code_iso>DE</country_code_iso> <phone_number>09641 45 49 0</phone_number> </shipping_address> <email_address>contact@speed4trade.com</email_address> <created_by>Administrator</created_by> <depositor>Speed4Trade GmbH</depositor> <bank_account_number>101 540</bank_account_number> <bank_code>753 600 11</bank_code> <bank_name>Raiffeisenbank Weiden e.G.</bank_name> <swift_code>GENODEF1WEO</swift_code> <iban_code>DE20753600110000101540</iban_code> <branch_id>123</branch_id> <transaction_id_1></transaction_id_1> <transaction_id_2></transaction_id_2> <ip_address></ip_address> <tax_id>DE243653785</tax_id> <payment_status> <payment_status_id>1</payment_status_id> <payment_status_identifier>unpaid</payment_status_identifier> </payment_status> <export_date>2010-06-21T19:00:00</export_date> <marketplace_actualisation_deactivated_at>2010-06-21T19:00:00</marketplace_actualisation_deactivated_at> <complete_status>1</complete_status> <order_items> <order_item> <order_item_id>3067</order_item_id> <order_item_identifier>Demoartikel Poloshirt/ L / Weiß</order_item_identifier> <order_item_position>1</order_item_position> <order_date>2011-04-06T15:42:00.000+02:00</order_date> <reference_number>100</reference_number> <external_offer_number>off_100</external_offer_number> <channel_item_number>bay_100</channel_item_number> <item_id>61</item_id> <internal_item_number>s4t_05-001</internal_item_number> <quantity>1</quantity> <canceled_quantity>0</canceled_quantity> <price>14.9500</price> <tax_rate>19.0000</tax_rate> <note>Empfindliche Ware. Bitte vorsichtig behandeln.</note> <type>0</type> <coupon_percent>15.00</coupon_percent> <discount_value>4.95</discount_value> <piece>1.00</piece> <expected_delivery_date>2011-04-06T00:00:00.000+02:00</expected_delivery_date> <item_set> <set_item> <set_item_id>57</set_item_id> <internal_item_number>s4t_02</internal_item_number> <position>0</position> <amount>1</amount> <packaging_unit>2</packaging_unit> </set_item> </item_set> <initial_order> <order_id>123456</order_id> <mandator_id>1</mandator_id> <order_number_prefix>EBY</order_number_prefix> <order_number>1234</order_number> <external_order_number_1>ext_123</external_order_number_1> <external_order_number_2>ext2_123</external_order_number_2> <marketplace_order_id>123-4567-890</marketplace_order_id> </initial_order> <additional_order_item_data> <keyvalueitem> <key>Zusatzinfo-Schlüssel</key> <value>Zusatzinfo-Wert</value> </keyvalueitem> </additional_order_item_data> <specific_order_item_data> <!-- [SPECIFIC_ORDER_ITEM_DATA] Plattformspezifische Daten --> </specific_order_item_data> <tax_collected_by_marketplace>true</tax_collected_by_marketplace> <tax_collected_by_marketplace_amount>2.3900</tax_collected_by_marketplace_amount> </order_item> </order_items> <specific_order_data> <!-- [SPECIFIC_ORDER_DATA] Plattformspezifische Daten --> </specific_order_data> <packets> <packet> <shipping_provider> <shipping_provider_id>143</shipping_provider_id> <shipping_provider_name>DHL</shipping_provider_name> <external_id>PV</external_id> </shipping_provider> <shipping_date>2011-04-06T00:00:00.000+02:00</shipping_date> <arrival_date>2011-04-11T00:00:00.000+02:00</arrival_date> <estimated_arrival_date>2011-04-11T00:00:00.000+02:00</estimated_arrival_date> <tracking_number>1</tracking_number> <return_number>132654</return_number> <dispatch_type> <dispatch_type_id>68</dispatch_type_id> <identifier>Sperrgut</identifier> <external_id>SPERR</external_id> </dispatch_type> <fulfillment_center_id>CGN1</fulfillment_center_id> <packet_content> <content> <order_item_id>3067</order_item_id> <amount>1</amount> <item_identifier>Collegeblock</item_identifier> <internal_item_number>s4t_05-001</internal_item_number> <multi_packet>false</multi_packet> </content> </packet_content> </packet> </packets> <dispatch_handling> <dispatch_handling_id>2</dispatch_handling_id> <identifier>Externer Dienstleister</identifier> </dispatch_handling> <ready_for_collection_date>2011-04-11T00:00:00.000+02:00</ready_for_collection_date> <order_tags> <order_tag> <tag_id>1</tag_id> <tag_identifier>PRIORITY</tag_identifier> </order_tag> </order_tags> <additional_order_data> <keyvalueitem> <key>Sonderwunsch</key> <value>Überbreite</value> </keyvalueitem> </additional_order_data> <invoice_number>9842</invoice_number> <purchase_order_number>Kundeneigene_Bestellnummer-2903</purchase_order_number> <payment_instructions> <payment_instruction> <payment_instruction_id>77</payment_instruction_id> <order_id>3066</order_id> <external_id>external_payment_instruction_id 1234</external_id> <recipient>Firma XY</recipient> <iban>DE12300101100123123123</iban> <bic>G3NODEF1WXO</bic> <bank_name>Spardort-Bank</bank_name> <payment_reason>Verwendungszweck</payment_reason> <note_to_buyer>Hinweis an den Käufer</note_to_buyer> <url>www.speed4trade.com</url> <transaction_number>Transaktionsnummer 123 XYZ</transaction_number> <receipt_printing>false</receipt_printing> <read_only>false</read_only> <amount>24.9500</amount> <currency_code_iso>EUR</currency_code_iso> <due_date>2017-01-11T00:00:00.000+01:00</due_date> <sepa_mandate_url>https://www.speed4trade.com</sepa_mandate_url> <sepa_mandate_reference>L10013DE59R10E1R98VC00D2DX</sepa_mandate_reference> </payment_instruction> </payment_instructions> <marketplace_user_name>testuser_buyer</marketplace_user_name> <anonymizations> <anonymization> <date>2021-05-06T15:22:54.000+02:00</date> <configuration>Anonymization Config Identifier</configuration> </anonymization> </anonymizations> </order> </response> |
Name |
Beschreibung |
Anz. |
Typ |
sonstiges |
response |
Root-Element der Antwort |
1 |
Element |
|
method |
Attribut von response. Name der Webservice-Methode. |
1 |
string |
Fester Wert: „fetchOrders“ |
version |
Attribut von response. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
report |
Information über die ausgeführte Operation. |
1 |
Element |
|
return_code |
Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind. |
1 |
integer |
|
total_number_of_pages |
Gibt an, wie viele Seiten es insgesamt gibt. |
1 |
integer |
|
total_number_of_entries |
Gibt an, wie viele Aufträge es insgesamt sind. |
1 |
integer |
|
error_description |
Fehlerbeschreibung falls bei der Durchführung der Operation Fehler aufgetreten sind. |
0..1 |
string |
|
order |
Wrapper-Element, das die Daten eines Auftrags zusammenfasst |
0..N |
Element |
|
order_id |
ID des Auftrags |
1 |
integer |
|
mandator_id |
ID des Mandanten dem dieser Auftrag zugeordnet ist. |
1 |
integer |
|
order_number_prefix |
Auftragsnummern Präfix |
0..1 |
string |
|
order_number |
Auftragsnummer |
1 |
integer |
|
external_order_number_1 |
Externe Auftragsnummer 1 |
0..1 |
string |
Länge: 0-100 Zeichen |
external_order_number_2 |
Externe Auftragsnummer 2 |
0..1 |
string |
Länge: 0-100 Zeichen |
marketplace_order_id |
Marktplatzauftragsnummer |
0..1 |
string |
Länge: 0-100 Zeichen |
marketplace_order_id_2 |
Marktplatzauftragsnummer 2 |
0..1 |
string |
Länge: 0-100 Zeichen |
order_date |
Auftragsdatum |
1 |
dateTime |
|
created_at |
Erstelldatum |
1 |
dateTime |
|
last_changed |
Änderungsdatum |
1 |
dateTime |
|
shipping_charge |
Versandkosten |
0..1 |
decimal |
|
cash_on_delivery_charge |
Nachnahmekosten |
0..1 |
decimal |
|
payment_method_charge |
Gebühren für die Bezahlart. |
0..1 |
decimal |
|
weight_in_gram |
Gewicht in Gramm |
0..1 |
decimal |
|
coupon_amount |
Gutscheinwert als absoluter Betrag |
0..1 |
decimal |
|
rebate |
Rabattwert des Auftrags |
0..1 |
decimal |
|
shipping_provider |
ID des Versanddienstleisters |
0..1 |
integer |
|
dispatch_type |
Wrapper-Element, das die Versandart darstellt |
0..1 |
Element |
|
dispatch_type_id |
ID der Versandart |
1 |
integer |
|
identifier |
Bezeichnung der Versandart |
1 |
string |
|
external_id |
externe ID |
1 |
string |
|
price_type |
Wrapper-Element, das die Art des Preises festlegt. |
1 |
Element |
|
price_type_id |
Element von price_type. ID des Preistyps |
1 |
integer |
Feste Werte: 0 (= Nettopreis) 1 (= Bruttopreis) |
price_type_identifier |
Element von price_type. Bezeichner des Preistyps. |
1 |
string |
Feste Werte: „net“ (=Netto) | „gross“ (=Brutto) |
currency_code_iso |
Währung |
0..1 |
string |
ISO CODE z.B. „EUR“ |
note |
Bemerkung |
0..1 |
string |
deprecated siehe Hinweise |
order_notices |
Wrapper-Element, das die Auftragsbemerkungen zusammenfasst. |
0..1 |
Element |
|
order_notice |
Wrapper-Element, das eine Auftragsbemerkung darstellt. |
1..N |
Element |
|
order_notice_id |
ID der Bemerkung |
1 |
integer |
|
created_at |
Erstelldatum der Bemerkung |
1 |
dateTime |
|
created_by |
Benutzername |
1 |
string |
|
last_changed_at |
Änderungsdatum der Bemerkung |
1 |
dateTime |
|
last_changed_by |
Benutzername |
1 |
string |
|
text |
Bemerkungstext |
1 |
string |
|
notice_type |
Typ der Bemerkung. |
1 |
integer |
Feste Werte: 10 (=intern) 20 (=extern) |
sub_channel |
Wrapper-Element, das Informationen über den Subchannel enthält. |
0..1 |
Element |
|
sub_channel_id |
Element von sub_channel. ID des Sub-Channels. |
1 |
integer |
|
sub_channel_identifier |
Element von sub_channel. Bezeichner des Sub-Channels. |
1 |
string |
Länge: 0-50 Zeichen |
account |
Wrapper-Element, das Informationen über den Account enthält. |
0..1 |
Element |
|
account_id |
Element von account. ID des Accounts. |
1 |
integer |
|
account_identifier |
Element von account. Bezeichner des Accounts. |
1 |
string |
Länge: 0-50 Zeichen |
order_status |
Wrapper-Element, das Informationen über den Auftragsstatus enthält. |
0..1 |
Element |
|
order_status_id |
Element von order_status. ID des Auftragsstatus. |
1 |
integer |
Feste Werte
|
order_status_identifier |
Element von order_status. Bezeichner des Auftragsstatus. |
1 |
string |
Feste Werte
|
payment_method |
Wrapper-Element, das Informationen über die Zahlungsart enthält |
0..1 |
Element |
|
payment_method_id |
Element von payment_method. ID der Zahlungsart. |
1 |
integer |
FesteWerte
|
payment_method_identifier |
Element von payment_method. Bezeichner der Zahlungsart |
1 |
string |
Feste Werte
|
hold_reason_id |
ID eines Rückstellungsgrundes zur vorübergehenden Unterbrechung des Auftragsworkflows. |
0..1 |
integer |
|
hold_reason |
Beschreibung des Rückstellungsgrundes zur vorübergehenden Unterbrechung des Auftragsworkflows. |
0..1 |
string |
|
customer_type |
Wrapper-Element, das den Kundentyp enthält. |
0..1 |
Element |
|
customer_type_id |
Element von customer_type. ID des Kundentyps. |
1 |
integer |
Zulässige Werte: 1 = Privatkunde 2 = Geschäftskunde |
customer_type_identifier |
Element von customer_type. Bezeichner des Kundentyps. |
1 |
string |
Zulässige Werte: „business“| „private“ |
customer_language_code_iso |
Sprache des Kunden |
0..1 |
string |
Sprachcode ISO 639-1 ALPHA-2 (z.B. „de“) |
customer |
Wrapper-Element, das die Daten des Kunden zusammenfasst. |
1 |
Element |
|
customer_id |
Element von customer. ID des Kunden |
1 |
integer |
|
customer_number |
Element von customer. Kundenummer. |
0..1 |
integer |
|
external_customer_id_1 |
Element von customer. Externe ID des Kunden. |
string |
||
external_customer_id_2 |
Element von customer. Externe ID des Kunden. |
string |
||
specific_customer_data |
Wrapper-Element, das alle pluginspezifischen Daten zusammenfast |
0..1 |
Element |
Deprecated. Wird zukünftig in marketplace_user_name ausgegeben. Siehe Hinweise. |
ebay_customer_data |
Wrapper-Element, das alle eBay-Kundendaten zusammenfast |
0..1 |
Element |
|
ebay_user_name |
Der eBay-Benutzername |
0..1 |
string |
|
master_customer |
Wrapper-Element, das die Daten des Kunden zusammenfasst. |
1 |
Element |
|
customer_id |
Element von customer. ID des Kunden |
1 |
integer |
|
customer_number |
Element von customer. Kundenummer. |
0..1 |
integer |
|
external_customer_id_1 |
Element von customer. Externe ID des Kunden. |
string |
||
external_customer_id_2 |
Element von customer. Externe ID des Kunden. |
string |
||
invoice_address |
Wrapper-Element, das die Daten der Rechnungsadresse zusammenfasst. |
1 |
Element |
Für eine Detail-Beschreibung der Inhalte siehe Feldliste Adresse |
shipping_address |
Wrapper-Element, das die Daten der Lieferadresse zusammenfasst. |
1 |
Element |
Für eine Detail-Beschreibung der Inhalte siehe Feldliste Adresse |
email_address |
Email-Adresse zur Rechnungs-Adresse. |
0..1 |
string |
Länge: 0-100 Zeichen |
created_by |
Benutzer der Auftrag angelegt hat |
0..1 |
string |
|
depositor |
Kontoinhaber |
0..1 |
string |
Länge: 0 – 150 Zeichen Deprecated |
bank_account_number |
Kontonummer |
0..1 |
string |
Länge: 0 – 20 Zeichen Deprecated |
bank_code |
Bankleitzahl |
0..1 |
string |
Länge: 0 – 20 Zeichen Deprecated |
bank_name |
Name der Bank |
0..1 |
string |
Länge: 0 – 150 Zeichen Deprecated |
swift_code |
SWIFT-Code |
0..1 |
string |
Länge: 0 – 20 Zeichen Deprecated |
iban_code |
IBAN-Code |
0..1 |
string |
Länge: 0 – 40 Zeichen Deprecated |
branch_id |
ID der Filiale |
0..1 |
integer |
|
desired_delivery_date |
Wunschdatum der Lieferung |
0..1 |
dateTime |
|
transaction_id_1 |
Transaktionsnummer zur Identifikation der Zahlung falls vorhanden. |
0..1 |
string |
Länge: 0-50 Zeichen |
transaction_id_2 |
Transaktionsnummer zur Identifikation der Zahlung falls vorhanden. |
0..1 |
string |
Länge: 0-50 Zeichen |
ip_address |
IP-Adresse zum Auftrag |
string |
Länge: 0-50 Zeichen |
|
tax_id |
Umsatzsteuer-Ident-Nr. |
0..1 |
string |
Länge: 0-50 Zeichen |
payment_status |
Wrapper-Element, welches Informationen über den Bezahlstatus des Auftrags zusammenfasst. |
1 |
Element |
|
payment_status_id |
ID des Bezahlstatus |
1 |
integer |
Feste Werte: 1 (= offen) 2 (= unter-bezahlt) 3 (= bezahlt) 4 (= über-bezahlt) |
payment_status_identifier |
Bezeichner des Bezahlstatus |
1 |
string |
Feste Werte: „unpaid“ | „underpaid“ | „paid“ | „overpaid“ |
export_date |
Exportdatum des Auftrags |
0..1 |
dateTime |
|
marketplace_actualisation_deactivated_at |
Ist dieses Datum gesetzt, so kann der Auftrag von den Verkaufskanälen nicht mehr geändert werden. |
0..1 |
dateTime |
|
complete_status |
Gibt an in welchem Beendet-Status der Auftrag gerade ist. Zusätzliche Informationen zu den einzelnen Werten befinden sich in den Hinweisen. |
1 |
integer |
Feste Werte: 1 (=vollständig) 2 (=schwebend) 3 (=unvollständig) |
order_items |
Wrapper-Element für die Auftragspositionen, die dem Auftrag zugeordnet sind. |
1 |
Element |
|
order_item |
Wrapper Element, das die Daten einer Auftragsposition zusammenfasst. |
0..N |
Element |
|
order_item_id |
ID der Auftragsposition |
1 |
integer |
|
order_item_identifier |
Bezeichner der Auftragsposition. Dieses Feld kann, je nach Marktplatz, bei mehreren Positionen wiederholt auftreten. Siehe dazu die Hinweise. |
1 |
string |
Länge: 0-200 Zeichen |
order_item_position |
Platzierung der Auftragsposition innerhalb des Auftrags. |
1 |
integer |
|
order_date |
Bestelldatum des Artikels je Position |
1 |
dateTime |
|
reference_number |
Referenznummer des Artikels der dieser Position zugeordnet ist |
0..1 |
string |
|
external_offer_number |
Externe Artikelnummer des Artikels |
0..1 |
string |
|
channel_item_number |
Channel-Artikelnummer des Artikels |
0..1 |
integer |
|
item_id |
ID des Artikels der dieser Position zugeordnet ist. Dieses Feld kann, je nach Marktplatz, bei mehreren Positionen wiederholt auftreten. Siehe dazu die Hinweise. |
0..1 |
integer |
|
internal_item_number |
Interne Artikelnummer des Artikels der dieser Position zugeordnet ist. Dieses Feld kann, je nach Marktplatz, bei mehreren Positionen wiederholt auftreten. Siehe dazu die Hinweise. |
0..1 |
string |
Länge: 0-50 Zeichen |
quantity |
Menge des Artikels. |
1 |
integer |
|
canceled_quantity |
Stornomenge des Artikels |
0..1 |
integer |
|
price |
Preis für einen einzelnen (!) Artikel |
1 |
decimal |
|
purchase_price |
Einkaufspreis für einen einzelnen (!) Artikel |
0..1 |
decimal |
|
tax_rate |
Steuersatz für die Auftragsposition |
1 |
decimal |
|
note |
Bemerkung |
1 |
string |
|
type |
Typ der Auftragsposition 0 = Normale Auftragsposition 1 = Position ist ein Gutschein mit festem Wert 2 = Position ist ein Gutschein mit prozentualem Wert 3 = Serviceleistung (z.B. [Falls Angeboten] Geschenkverpackung bei Amazon) 4 = Retourenposition (Werden für die Erstellung von Stornorechnungen benötigt) |
1 |
integer |
Feste Werte: („0“ | „1“ | „2“ | „3“ | „4“) |
coupon_percent |
Gutscheinwert in Prozent |
0..1 |
decimal |
|
discount_value |
Rabattwert für einen einzelnen (!) Artikel |
0..1 |
decimal |
Keine Prozentangabe |
piece |
Verpackungseinheitswert |
0..1 |
decimal |
|
expected_delivery_date |
Voraussichtliches Lieferdatum |
0..1 |
dateTime |
|
serial_number |
Seriennummer des Artikels |
0..1 |
string |
|
cancel_date |
Storno-Datum |
0..1 |
dateTime |
|
item_set |
Wrapper-Element, das die Artikelsets dieses Artikels zusammenfasst. |
0..1 |
Element |
|
set_item |
Wrapper-Element, das die Daten des Artikelsets zusammenfasst. |
0..N |
Element |
|
set_item_id |
ID des Setartikels |
1 |
integer |
|
internal_item_number |
Interne Artikel-Nummer des Setartikels |
0..1 |
string |
|
position |
Position des Setartikels. Wird zum sortieren verwendet. |
0..1 |
integer |
|
amount |
Menge des Setartikels im Set |
0..1 |
integer |
|
packaging_unit |
Verpackungseinheit des Setartikels |
1 |
integer |
Ist im Artikel keine Information zur Verpackungseinheit enthalten, wird "0" ausgegeben. |
initial_order |
Wrapper-Element, das die Daten des Auftrags aus dem dieser Auftrags hervorgegangen ist zusammenfasst. |
0..1 |
Element |
|
order_id |
ID des Auftrags |
1 |
integer |
|
mandator_id |
ID des Mandanten dem dieser Auftrag zugeordnet ist. |
1 |
integer |
|
order_number_prefix |
Auftragsnummern Präfix |
0..1 |
string |
|
order_number |
Auftragsnummer |
1 |
integer |
|
external_order_number_1 |
Externe Auftragsnummer 1 |
0..1 |
string |
|
external_order_number_2 |
Externe Auftragsnummer 2 |
0..1 |
string |
|
marketplace_order_id |
Marktplatzauftragsnummer |
0..1 |
string |
|
additional_order_item_data |
Wrapper-Element für die zusätzlichen Auftragspositionsinformationen. Diese werden von Speed4Trade CONNECT nicht verwertet und können als weitere Daten vom Shop an das ERP-System übergeben werden. |
0..1 |
Element |
|
keyvalueitem |
Wrapper-Element, das die Informationen einer zusätzlichen Auftragspositionsinformation enthält. |
1..N |
Element |
|
key |
Schlüssel der Information. |
1 |
string |
|
value |
Wert der Information. |
1 |
string |
|
specific_order_item_data |
Wrapper-Element für die plattformspezifischen Auftragspositionsdaten |
0..1 |
Element |
|
[entries] |
Platzhalter für Verkaufskanalspezifische Daten. Die möglichen Daten sind im Abschnitt "Spezifische Auftragsdaten" des Calls fetchOrders beschrieben. |
0..N |
||
tax_collected_by_marketplace |
Wurde für diese Auftragsposition bereits die Mehrwertsteuer durch den Marktplatz abgeführt. |
1 |
boolean |
|
tax_collected_by_marketplace_amount |
Summe der abgeführten Mehrwertsteuer für diese Auftragsposition. |
0..1 |
decimal |
|
specific_order_data |
Wrapper-Element für die plattformspezifischen Auftragsdaten |
0..1 |
Element |
|
[entries] |
Platzhalter für Verkaufskanalspezifische Daten. Die möglichen Daten sind im Abschnitt "Spezifische Auftragsdaten" des Calls fetchOrders beschrieben. |
0..N |
||
packets |
Wrapper-Element, das die Pakete dieses Auftrags zusammenfasst. |
0..1 |
Element |
Null: bleibt unangetastet. Sonst: überschreibt bestehende |
packet |
Wrapper-Element, das die Daten eines Paketes zusammenfasst. |
0..N |
Element |
|
shipping_provider |
Wrapper-Element, das die Daten des Versanddienstleisters zusammenfasst. |
1 |
Element |
|
shipping_provider_id |
ID des Versanddienstleisters |
1 |
integer |
|
shipping_provider_name |
Name des Versanddienstleisters |
1 |
string |
Länge: 0-255 Zeichen |
external_id |
externe ID |
1 |
string |
|
shipping_date |
Versanddatum |
0..1 |
dateTime |
|
arrival_date |
Ankunftsdatum |
0..1 |
dateTime |
|
estimated_arrival_date |
Geschätztes Ankunftsdatum |
0..1 |
dateTime |
|
tracking_number |
Trackingnummer des Pakets |
0..1 |
string |
Länge: 0-100 Zeichen |
return_number |
Retourennummer |
0..1 |
string |
Länge: 0-100 Zeichen |
dispatch_type |
Versandtyp |
1 |
Element |
|
dispatch_type_id |
Versandtyp-ID |
1 |
integer |
|
identifier |
Versandtypbezeichner |
1 |
string |
|
external_id |
externe ID |
1 |
string |
|
fulfillment_center_id |
ID des Versandzentrums |
0..1 |
string |
|
packet_content |
Wrapper-Element, das die Paketinhalte zusammenfasst. |
0..1 |
Element |
Siehe Hinweise. |
content |
Wrapper-Element, das einen Artikel des Paketinhaltes darstellt. |
1..N |
Element |
|
order_item_id |
ID der Auftragsposition |
1 |
integer |
|
amount |
Menge des Produkts in dem Paket |
1 |
integer |
|
item_identifier |
Bezeichner des Artikels |
1 |
string |
|
internal_item_number |
Interne Artikelnummer |
1 |
string |
|
multi_packet |
Gibt an ob die Auftragsposition auf mehrere Pakete aufgeteilt wurde |
1 |
boolean |
Siehe Infos zu Multi-Paket im Handbuch |
dispatch_handling |
Wrapper-Element, das die Daten für die Versandabwicklung zusammenfasst. |
0..1 |
Element |
|
dispatch_handling_id |
ID der Versandabwicklung |
1 |
integer |
Feste Werte: 1 = Standard 2 = Externer Versanddienstleister (Z. B. ein FBA-Auftrag von Amazon) |
identifier |
Bezeichnung der Versandabwicklung |
1 |
string |
|
ready_for_collection_date |
Legt das Datum fest ab dem die Ware vom Kunden abgeholt werden kann. |
0..1 |
dateTime |
|
order_tags |
Wrapper-Element, das alle Auftragskennzeichen des Auftrags zusammenfasst. |
0..1 |
Element |
Siehe Hinweise. |
order_tag |
Wrapper-Element für ein Auftragskennzeichen des Auftrags. |
1..64 |
Element |
|
tag_id |
ID des Auftragskennzeichens. |
1 |
integer |
|
tag_identifier |
Bezeichnung des Auftragskennzeichens. |
1 |
string |
|
additional_order_data |
Wrapper-Element für die zusätzlichen Auftragsinformationen. Diese werden von Speed4Trade CONNECT nicht verwertet und können als weitere Daten vom Shop an das ERP-System übergeben werden. |
0..1 |
Element |
|
keyvalueitem |
Wrapper-Element für eine zusätzliche Auftragsinformation. |
1..N |
Element |
|
key |
Schlüssel der Information. |
1 |
string |
|
value |
Wert der Information. |
1 |
string |
|
invoice_number |
Die Rechnungsnummer. Falls diese bereits vorgeben bzw. die Rechnung gedruckt wurde. |
0..1 |
integer |
|
purchase_order_number |
Die Kundenbestellnummer. Diese kann bei einigen Systemen vom Käufer selbst festgelegt werden. |
0..1 |
string |
|
payment_instructions |
Wrapper-Element, das die Zahlungshinweise zusammenfasst. |
0..1 |
Element |
|
payment_instruction |
Wrapper-Element, das die Informationen eines Zahlungshinweises beinhaltet. |
1..N |
Element |
|
payment_instruction_id |
Die ID des Zahlungshinweises. Zwingend nötig wenn ein bestehender Zahlungshinweis bearbeitet oder gelöscht werden soll. |
1 |
integer |
|
order_id |
Die ID des Auftrags dem der Zahlungshinweis angehört. |
1 |
integer |
|
external_id |
Externe ID des Zahlungshinweises. |
1 |
string |
|
recipient |
Zahlungsempfänger |
1 |
string |
|
iban |
Kontonummer |
1 |
string |
|
bic |
Bankkennzeichen |
1 |
string |
|
bank_name |
Name der Bank |
1 |
string |
|
payment_reason |
Verwendungszweck |
1 |
string |
|
note_to_buyer |
Hinweis an den Käufer. |
1 |
string |
|
url |
URL-Feld |
1 |
string |
|
transaction_number |
Transaktionsnummer |
1 |
string |
|
receipt_printing |
Belegdruck |
1 |
boolean |
|
read_only |
Gibt an ob der Zahlungshinweis bearbeitbar ist oder nicht. Es können nur manuell angelegte Zahlungshinweise bearbeitet werden. |
1 |
boolean |
|
amount |
Betrag |
1 |
decimal |
|
currency_code_iso |
Währung |
1 |
string |
ISO CODE z.B. „EUR“ |
due_date |
Fälligkeitsdatum |
1 |
date |
|
sepa_mandate_url |
URL für den Aufruf des SEPA-Mandats. |
1 |
string |
Länge: 0-2083 |
sepa_mandate_reference |
SEPA-Mandatsreferenznummer. Bis zu 35-Stellen langer, alphanumerischer String zur eindeutigen Identifikation eines SEPA-Mandats. |
1 |
string |
Länge: 0-35 |
marketplace_user_name |
Der Benutzername des Käufers bei Kauf dieser Bestellung. |
0..1 |
string |
Siehe Hinweise. |
anonymizations |
Wrapper-Element, das die Informationen aller Anonymisierungsvorgänge enthält |
0..1 |
Element |
|
anonymization |
Wrapper-Element, das die Informationen zu einer Anonymisierung vorhält. |
1 |
Element |
|
date |
Datum der Anonymisierung |
1 |
dateTime |
|
configuration |
Bezeichnung der verwendeten Anonymisierungskonfiguration |
1 |
string |
Value Table - for Field: order_status |
order_status_id |
order_status_identifier |
note |
---|---|---|
10 |
new |
new order | Neuer Auftrag |
120 |
outstanding payment |
order confirmed - waiting for payment | Auftrag bestätigt. Wartet auf Bezahlung. |
130 |
paid shipping |
order payed - ship now | Bezahlt. Versenden. |
140 |
shipped complete |
shipped - order completed | Versendet. Abgeschlossen. |
220 |
confirmed shipping |
ship now | Bestätigt Versenden |
230 |
shipped outstanding |
shipped - waiting for incoming payment | Versendet. Wartet auf Bezahlung |
240 |
paid complete |
paid - order completed | Bezahlt. Abgeschlossen. |
320 |
confirmed pickup |
order confirmed - waiting for order collection | Bestätigt. Wartet auf Abholung. |
330 |
pickedup completed |
collected by buyer - order completed | Abgeholt. Abgeschlossen. |
985 |
regrouped |
regrouped order | Umgruppiert |
990 |
canceled |
canceled order | Storniert |
995 |
back order |
temporary backordered | Auftragsrückstand |
Value Table - for field: payment_method. |
payment_method_id |
identifier |
note |
Workflow |
---|---|---|---|
1 |
prepay |
advance payment | Vorkasse |
1 |
2 |
credit card |
Kreditkarte |
1 |
3 |
cash on delivery |
Nachnahme |
2 |
4 |
invoice |
Rechnung |
2 |
5 |
cash |
Bar |
3 |
6 |
debit |
Bankeinzug |
2 |
7 |
giropay |
Giropay |
1 |
8 |
paypal |
Pay Pal |
1 |
9 |
finance |
Finanzierung |
1 |
10 |
sofortueberweisung |
pay now | Sofortüberweisung |
1 |
11 |
marketplace payment |
payment by marketplace | Zahlabwicklung über Marktplatz |
2 |
12 |
billsafe (deprecated) |
BillSAFE (deprecated) |
2 |
13 |
klarna invoice |
Klarna Rechnung |
2 |
14 |
klarna account |
hire-purchase | Klarna Ratenkauf |
2 |
15 |
amazon pay |
Amazon Pay |
2 |
16 |
RatePAY |
RatePAY |
2 |
20 |
eBay Payment |
eBay Payment |
1 |
60 |
Mollie |
mollie |
1 |
Address Field List used for several address occurances. |
Name |
Beschreibung |
Anz. |
Typ |
sonstiges |
---|---|---|---|---|
address_id |
ID of Address |
0..1 |
integer |
|
salutation_id |
Element of salutation. ID of salutation. |
1 |
integer |
fixed values: 1 (= Mr | Herr) 2 (= Mrs |Frau) 3 (= Business | Firma) |
salutation_identifier |
Element of salutation. Identifier of salutation. |
1 |
string |
fixed values: „mr“ | „ms“ | „business“ |
firm |
Company name of buyer. |
0..1 |
string |
Length: 0 – 200 characters |
title |
Titel of Customer |
0..1 |
string |
Length: 0 – 100 characters |
first_name |
first name |
0..1 |
string |
Length: 0 – 100 characters |
last_name |
last name |
0..1 |
string |
Length: 0 – 200 characters |
street |
street name |
0..1 |
string |
Length: 0 – 200 characters |
house_number |
street number |
0..1 |
string |
Length: 0 – 50 characters |
street_addition |
Additional address information (e.g. c/o Mrs Miller) |
0..1 |
string |
Length: 0 – 200 characters |
postal_code |
posal code |
0..1 |
string |
Length: 0 – 50 characters |
city |
city |
0..1 |
string |
Length: 0 – 200 characters |
country_code_iso |
country code |
0..1 |
string |
ISO 3166 ALPHA-2 Codes (e.g. „DE“ for Germany) |
phone_number |
phone number |
0..1 |
string |
Length: 0 – 50 characters |
(*)If no salutation is known (field is empty) we recommend to use a gender-neutral form of address.
Value Table - for Field sub_channel_id |
sub_channel_id |
sub_channel_identifier |
channel_identifier |
---|---|---|
1001 |
Speed4Trade COMMERCE |
Onlineshops |
1100 |
modified Shop |
Onlineshops |
1400 |
Gambio (Deprecated) |
Onlineshops (Deprecated) |
1500 |
Shopgate (Deprecated) |
Onlineshops (Deprecated) |
1600 |
MagentoCommerce |
Onlineshops |
1700 |
OXID |
Onlineshops |
1900 |
Shopware |
Onlineshops |
2100 |
eBay.de |
eBay |
2200 |
eBay.co.uk |
eBay |
2250 |
eBay.ie |
eBay |
2300 |
eBay.com |
eBay |
2310 |
eBay Motors |
eBay |
2350 |
eBay.ca |
eBay |
2400 |
eBay.fr |
eBay |
2500 |
eBay.it |
eBay |
2600 |
eBay.at |
eBay |
2650 |
eBay.ch |
eBay |
2700 |
eBay.es |
eBay |
2750 |
eBay.com.au |
eBay |
2800 |
eBay.nl |
eBay |
2850 |
eBay.be |
eBay |
2900 |
eBay.pl |
eBay |
3100 |
amazon.de |
Amazon |
3200 |
amazon.co.uk |
Amazon |
3300 |
amazon.fr |
Amazon |
3350 |
amazon.nl |
Amazon |
3400 |
amazon.com |
Amazon |
3500 |
amazon.it |
Amazon |
3550 |
amazon.ae |
Amazon |
3600 |
amazon.es |
Amazon |
3700 |
amazon.ca |
Amazon |
3750 |
amazon.com.au |
Amazon |
3800 |
amazon.com.mx |
Amazon |
3820 |
amazon.eg |
Amazon |
3830 |
amazon.sa |
Amazon |
3840 |
amazon.tr |
Amazon |
3850 |
amazon.se |
Amazon |
3860 |
amazon.pl |
Amazon |
4100 |
Telefonverkauf |
manual sales / telesales |
5100 |
Allyouneed.de (Deprecated) |
Allyouneed (Deprecated) |
6100 |
Yatego |
Yatego |
7100 |
Rakuten.de (Deprecated) |
Rakuten (Deprecated) |
9100 |
DAPARTO.de |
DAPARTO |
10100 |
otto.de |
OTTO |
10200 |
otto.at |
OTTO |
10300 |
otto.ch |
OTTO |
10400 |
otto.nl |
OTTO |
10500 |
otto.ru |
OTTO |
11100 |
Locafox.de (Deprecated) |
Locafox (Deprecated) |
12100 |
WEBSALE (Deprecated) |
WEBSALE (Deprecated) |
13100 |
Kaufland.de |
Kaufland.de |
14001-14999 |
individual channel name (see notes below) |
Multi-Channel-Plugin (MCP) |
15100 |
OTTO Market DE |
OTTO Market |
Note for value table and field : sub_channel_id: The sub channels for the Multi-Channel-Plugin (MCP) can be configured via the Speed4Trade CONNECT UI. This doesn't allow for a standardized definition across all customer systems. The required subchannel_ids can be retrieved by using the call fetchSubChannels which could be executed after the initial configuration of a new subchannel using a tool like SoapUI. Setup of this tool is described in the Partnerportal. |
Code |
Beschreibung |
0 |
Die Abfrage wurde erfolgreich durchgeführt. |
-1 |
Der Abfrage konnte auf Grund eines unspezifizierten Fehlers nicht erfolgreich durchgeführt werden. Bitte beachten Sie die mitgelieferte Fehlerbeschreibung und Meldungen in Speed4Trade CONNECT. |
-3 |
Die Aufträge konnten auf Grund von Lizenzproblemen nicht abgefragt werden. Die laut Lizenz festgelegte maximale Anzahl an Aufträgen für den betroffenen Mandanten wurde überschritten. |
Auftragskennzeichen (Order_Tags)
Value Table - for Field: order_tags.
ID |
Identifier |
Description |
---|---|---|
1 |
PRIORITY |
Order priority flag, e.g. for eBay Plus, Amazon SFP |
2 |
ISPU |
In Store Pickup, e.g. for eBay Click and Collect orders. |
3 |
B2B |
Business to Business, e.g. for Amazon Business orders. |
4 |
EXTERNAL_INVOICING |
External invoicing, e.g. for Amazon Business orders, if Amazon VCS is used (Amazon VAT Calculation Service). |
5 |
EXTERNAL_STATUSUPDATE_PENDING |
For some marketplaces the shipping status of shipped orders will be collected and transmitted in a bulk using the job "OrderStatusUpdateJob". Currently available for Daparto, Amazon, and magentocommerce. Once an order gets the status "shipped" it will be added to a queue and marked with this order tag flag. Once the job processed the order status transmission successfully to the marketplace the flag will be removed again. This ensures that the marketplace will definitely successfully receive the shipped status. |
6 |
NEXT_DAY_DELIVERY |
Currently only in use for Amazon orders. If this tag and the priority tag are present at the same time, the seller has to buy a shipping label from amazon. If only one of them is present, the order still has priority but the seller is allowed to use his preferred shipping service provider. |
7 |
LABEL_ERROR |
Used for shipcloud. If an error occurs while generating a shipment-label, this tag will be used. |
8 |
SHIPMENT_ERROR |
If setting the sipped state for an order fails, the order will be marked with the shipment-error tag. Only used for plugins that complete orders via order status update job. |
9 |
WEEEPICKUP |
Marks orders where the customers requires a takeback for old electrical equipment. (OTTO Market) |
•Unter Angabe der Attribute filter_method=“IS|IS NOT“ und filter_value=“NULL“ lassen sich mit dem export_date-Filter explizit alle Datensätze selektieren die hier den Wert NULL oder einen beliebigen Wert außer NULL enthalten. Diese Attribute stehen jedoch in Widerspruch mit den beiden anderen Datumsattributen fromDate und toDate und dürfen daher nicht gemeinsam verwendet werden. o1 = Die Kaufabwicklung ist vollständig abgeschlossen. o2 = Bei PayPal-Aufträgen wird auf den Zahlungseingang gewartet. Bei anderen Aufträgen wurde dieser Status durch Speed4Trade CONNECT gesetzt, als die Kaufabwicklung abgebrochen wurde (completeCheckout). Im letzten Fall verhindert die eBay-API das Setzen des Status auf 1. o3 = Die Kaufabwicklung wurde noch nicht abgeschlossen. •Bei einigen Marktplätzen kann es vorkommen, dass mehrere Positionen des Auftrags den gleichen Artikel referenzieren. Speed4Trade CONNECT fasst keine Positionen mit gleichen Artikeln zusammen und summiert auch keine Mengen und Preise auf, da im Falle einer Retoure oder eines Stornos keine eindeutige Zuordnung zu den Marktplatzinformationen mehr gegeben wäre. Falls die Warenwirtschaft diesen Fall nicht abbilden kann, muss die Schnittstelle zwischen Speed4Trade CONNECT und Warenwirtschaft auf Seiten der Warenwirtschaft diese Gruppierung und auch den umgekehrten Prozess im Aftersales-Bereich übernehmen. Zur Unterscheidung zwischen den einzelnen Positionen darf dann nicht die internal_item_number, nicht die item_id und auch nicht der order_item_identifier benutzt werden, sondern die order_item_id bzw. die order_id zusammen mit der order_item_position. Solche Marktplätze sind beispielsweise: Amazon, eBay und Kaufland.de. •Auftragsbemerkungen werden nicht mehr über das Feld note übergeben, sondern einzeln über order_notices. •Für die order_tags gibt es sowohl vordefinierte Auftragskennzeichen als auch durch die Nutzer frei definierte Auftragskennzeichen. •Da der gespeicherte Benutzernamen unter 'ebay_user_name' nicht dem aktuellsten Benutzernamen des Käufers entspricht, wurde dieses Feld deprecated markiert. Die Benutzernamen des Käufers wird beim Auftrag unter 'marketplace_user_name' ausgegeben. Dies ist zudem allgemeingültig für alle Marktplätze. Der beim Kundendatensatz gespeicherte ebay_user_name kann weiterhin über fetchCustomers abgerufen werden. •Das Element content wird nur ausgegeben, wenn für dieses Paket der Paketinhalt hinterlegt ist. Bisher werden Paketinhalte nur bei Amazon-FBA Aufträgen gespeichert und über dieses Element ausgegeben. •Das Feld order_number_prefix wird nur ausgegeben, wenn ein Auftragsnummernpräfix vorhanden ist. Ist in der Mandantenverwaltung von Speed4Trade CONNECT eingestellt, dass je Verkaufsaccount ein eigener Auftragsnummernkreis verwendet werden soll, dann muss zu jedem Account auch ein eigener Auftragsnummernpräfix definiert sein. Dadurch kann anhand des Präfix und der Auftragsnummer ein Auftrag eindeutig identifiziert werden. •Verwenden Sie weder marketplace_order_id_1 noch marketplace_order_id_2 als significant_key für eBay Aufträge, da diese Felder ihre Werte nach Abschluss des Bestellvorgangs ändern. •Im Request heißen die Filter marketplace_order_id_1 und marketplace_order_id_2. Im Response wird statt marketplace_order_id_1 der Bezeichner ohne Suffix (marketplace_order_id) zurückgegeben.
Sind im Response weniger Aufträge enthalten als erwartet, sind folgende Punkte zu prüfen: •Standardgemäß werden nur Aufträge zurückgeliefert, die nicht den Orderstatus „Umgruppiert“ haben (order_status_id = 985). Sollen diese trotzdem in der Ergebnismenge enthalten sein, so muss explizit der Auftragsstatusfilter genutzt werden. •Die Filteroption use_modification_context_filter muss berücksichtigt werden. |
Version |
Änderungsbeschreibung |
3.2.9.75 |
Redaktionelle Überarbeitung |
3.2.9.100 |
expected_delivery_date wurde in der Response ergänzt |
3.2.11.46 |
Einführung des Return-Codes "-3" zur Anzeige von Lizenzproblemen. |
3.3.2.181 |
Erweiterung der Response um dispatch_handling zum Anzeigen der Versandabwicklung. |
3.3.6.3205 |
Erweiterung der Response um initial_order zum Anzeigen des initialen Auftrags. |
3.3.41.30 |
Erweiterung des Filters um account_id. |
3.4.3.1 |
Erweiterung des Calls fetchOrders um die Filter order_ids, email_address, customer_ids, customer_numbers und complete_status |
3.4.3.1 |
Erweiterung des Calls fetchOrders um das Feld ready_for_collection_date |
3.4.9.1 |
Erweiterung des Calls um den Rechnungsnummern-Filter. |
3.4.16.1 |
Erweiterung der Response um customer_language_code_iso. |
3.4.16.1 |
Erweiterung der Response um marketplace_order_id_2. |
3.4.42.1 |
Erweiterung des Calls um den Auftragsnummern-Präfix-Filter. |
3.4.48.1 |
Wertetabelle für payment_method erweitert um eine Spalte für den zugehörigen Workflow. Hinweis zu Checkout-Status ergänzt. |
3.5.27 |
Hinweis zu mehrfachen Positionen mit gleichem Artikel innerhalb eines Auftrags ergänzt. |
3.5.37 |
Hinzufügen der externen ID |
3.5.37 |
Erweiterung der Response um den Bereich dispatch_type. |
3.4.35.1 |
Erweiterung um order_tags und additional_order_data |
3.5.47 |
Erweiterung der order_item_data um einen positionsbezogenen Rabattwert |
3.6.17 |
Erweiterung der Response um fulfillment_center_id. |
4.7.5 |
Erweiterung der Response um purchase_order_number. |
4.7.22 |
Erweiterung der Response um marketplace_user_name. |
4.7.22 |
Erweiterung der Response um payment_instructions. |
4.7.26 |
Erweiterung der Response um additional_order_item_data. |
4.7.42 |
Bankdaten als veraltet (deprecated) markiert. |
4.7.44 |
ebay_user_name als veraltet (deprecated) markiert. |
4.7.45 |
Erweiterung der Response um content. |
4.7.49 |
Erweiterung der Liste der vordefinierten Auftragskennzeichen um EXTERNAL_STATUSUPDATE_PENDING. |
4.7.51 |
Erweiterung der Information zu Setartikeln (Block: item_set) um die Verpackungseinheit (Feld: packaging_unit). |
4.8.2 |
Wertetabelle für Subchannels eingefügt. |
4.8.5 |
Zahlungshinweise (Payment-Instructions) erweitert um die Felder Betrag, Währung und Fälligkeitsdatum. |
4.8.5 |
Filter für Aufträge erweitert um die Möglichkeit, Aufträge nach Marktplatz-Auftragsnummern (marketplace_order_id_1 und marketplace_order_id_2) zu selektieren. |
4.8.15 |
Hinweise um Information zu Auftragsnummernkreisen und Auftragsnummerpräfix erweitert. |
4.8.16 |
Umbenennung des content innerhalb von packet in packet_content, damit keine zwei gleichnamigen Knoten ineinander verschachtelt sind. |
4.9.10 |
Erweiterung der payment_instructions um sepa_mandate_url und sepa_mandate_reference. |
4.9.28 |
Neuer Hinweistext zu marketplace_order_id_1 und marketplace_order_id_2 bei eBay Aufträgen. |
4.9.49 |
Tabelle: Order_Tags um neuen Wert (NEXT_DAY_DELIVERY ID:6) erweitert. |
4.10.48 |
Neues Feld Retourennummer (return_number). |
4.11.18 |
Erweiterung des Response um Informationen zur Anonymisierung |
4.11.24 |
Erweiterung des Response um tax_collected_by_marketplace und tax_collected_by_marketplace_amount. |
4.12.24 |
Neue Filtermöglichkeit: order_tags (Filterung auf Auftragskennzeichen) |
4.12.45 |
Auftragspositionstypen (type) Beschreibung aktualisiert und ID 3 und 4 nachgetragen. |
4.14.7 |
Erweiterung des Reponse um das Feld multi_packet. |