Abfrage von Accounts. |
<request method="fetchAccounts" version="1.0.0"> <filter> <mandator_id filter_method="=" filter_value="1" /> <last_changed from_date="2000-01-01T00:00:00.000+01:00" to_date="2012-12-31T00:00:00.000+01:00" /> <created_at from_date="2000-01-01T00:00:00.000+01:00" to_date="2012-12-31T00:00:00.000+01:00" /> </filter> </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: „fetchAccounts“ |
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 |
|
mandator_id |
Schränkt die Ergebnismenge der Abfrage auf einen 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 |
|
last_changed_at |
Schränkt die Ergebnismenge der Abfrage nach dem letzten Änderungsdatum der Accounts ein. |
0..1 |
Element |
|
from_date |
Attribut von last_changed. Selektiert alle Accounts die ab einschließlich des angegebenen Datums geändert wurden. |
0..1 |
dateTime |
|
to_date |
Attribut von last_changed. Selektiert alle Accounts die bis einschließlich des angegebenen Datums geändert wurden. |
0..1 |
dateTime |
|
created_at |
Schränkt die Ergebnismenge der Abfrage nach dem Erstellungsdatum der Accounts ein. |
0..1 |
Element |
|
from_date |
Attribut von created_at. Selektiert alle Accounts die ab einschließlich des angegebenen Datums erstellt wurden. |
0..1 |
dateTime |
|
to_date |
Attribut von created_at. Selektiert alle Accounts die bis einschließlich des angegebenen Datums erstellt wurden. |
0..1 |
dateTime |
<response method="fetchAccounts" version="1.0.0"> <report return_code="0"/> <account> <account_id>25217</account_id> <mandator_id>1</mandator_id> <account_identifier>eBay-Account</account_identifier> <channel> <channel_id>2000</channel_id> <channel_identifier>eBay</channel_identifier> </channel> <sub_channel> <sub_channel_id>2100</sub_channel_id> <sub_channel_identifier>eBay.de</sub_channel_identifier> </sub_channel> <email_account> <email_account_id>24594</email_account_id> <email_account_identifier>Speed4Trade</email_account_identifier> <email_address>contact@speed4trade.com</email_address> <email_address_bcc>contact@speed4trade.com</email_address_bcc> </email_account> <active>true</active> <order_number_prefix>Bay</order_number_prefix> </account> <account> <account_id>25715</account_id> <mandator_id>1</mandator_id> <account_identifier>Amazon-Account</account_identifier> <channel> <channel_id>3000</channel_id> <channel_identifier>Amazon</channel_identifier> </channel> <sub_channel> <sub_channel_id>3100</sub_channel_id> <sub_channel_identifier>amazon.de</sub_channel_identifier> </sub_channel> <email_account> <email_account_id>24594</email_account_id> <email_account_identifier>Speed4Trade</email_account_identifier> <email_address>contact@speed4trade.com</email_address> </email_account> <active>false</active> <created_by>Administrator</created_by> </account> </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: „fetchAccounts“ |
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 |
0 = OK. < 0 = Fehler |
error_ description |
Fehlerbeschreibung falls bei der Durchführung der Operation Fehler aufgetreten sind. |
0..1 |
string |
|
account |
Wrapper-Element, das die Daten eines Accounts zusammenfasst |
0..N |
Element |
|
account_id |
ID des Accounts |
1 |
integer |
|
mandator_id |
ID des Mandanten |
1 |
integer |
|
account_identifier |
Bezeichnung des Accounts |
1 |
string |
Länge: 0-50 Zeichen |
channel |
Wrapper-Element, das Informationen über den Channel enthält |
1 |
Element |
|
channel_id |
Element von channel. ID des Channels. |
1 |
integer |
|
channel_identifier |
Element von channel. Bezeichner des Channels. |
1 |
string |
Länge: 0-50 Zeichen |
sub_channel |
Wrapper-Element, das Informationen über den Subchannel enthält |
1 |
Element |
|
sub_channel_id |
Element von subchannel. ID des Sub-Channels. |
1 |
integer |
Siehe Wertetabelle. |
sub_channel_identifier |
Element von subchannel. Bezeichner des Sub-Channels. |
1 |
string |
Länge: 0-50 Zeichen |
email_account |
Wrapper-Element, das Informationen über den Email-Account enthält. |
1 |
Element |
|
email_account_id |
Element von email_account. ID des E-Mail-Accounts |
1 |
integer |
|
email_account_identifier |
Element von email_account. Bezeichner des E-Mail-Accounts |
1 |
string |
Länge: 0-100 Zeichen |
email_address |
Element von email_account. Adresse des E-Mail-Accounts. |
1 |
string |
Länge: 0-100 Zeichen |
email_address_bcc |
Element von email_account. BCC-Adresse des E-Mail-Accounts. |
0..1 |
string |
Länge: 0-100 Zeichen |
active |
Legt fest ob der Account aktiv ist. |
1 |
boolean |
|
created_by |
Benutzer der den Account angelegt hat |
0..1 |
string |
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 |
Onlineshops |
1500 |
Shopgate |
Onlineshops |
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. |
Version |
Änderungsbeschreibung |
---|---|
3.2.9.75 |
Redaktionelle Überarbeitung |
3.5.27 |
Erweiterung der Response um das Feld email_address_bcc. |
4.8.2 |
Wertetabelle für Subchannels eingefügt. |