Mit diesem Call können Auftragsdaten aktualisiert werden. Eine Neuanlage von Aufträgen ist nur für den Kanal "Manual Sales" möglich. In allen Marktplatz- oder Shop-spezifischen Kanälen können keine Aufträge über diese Schnittstelle angelegt werden, da die nachfolgenden Prozesse mit Marktplatz- oder Shop-internen IDs arbeiten und es somit zu Problemen kommen kann. |
<request method="updateOrders" version="1.0.0"> <order significant_key="[significant_key]" reference_id="[ref_id]"> <order_id>3066</order_id> <mandator_id>1</mandator_id> <order_number_prefix>BY</order_number_prefix> <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></marketplace_order_id> <order_date>2020-06-20T15:42:00.000+02:00</order_date> <complete_status>2</complete_status> <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> <shipping_provider>143</shipping_provider><!--Alternative 1--> <!--<shipping_provider_identifier>DHL</shipping_provider_identifier>--><!--Alternative 2--> <price_type_id>1</price_type_id><!--Alternative 1--> <!--<price_type_identifier>gross</price_type_identifier>--><!--Alternative 2--> <currency_code_iso>EUR</currency_code_iso> <invoice_number>2199</invoice_number> <note></note> <order_notices> <order_notice delete="false"> <order_notice_id>123456</order_notice_id> <text>Kommentar</text> <notice_type>10</notice_type> </order_notice> </order_notices> <sub_channel_id>4100</sub_channel_id><!--Alternative 1--> <!--<sub_channel_identifier>Telefonverkauf</sub_channel_identifier>--><!--Alternative 2--> <account_id>2649</account_id><!--Alternative 1--> <!--<account_identifier>Demo-Account</account_identifier>--><!--Alternative 2--> <order_status_id>120</order_status_id><!--Alternative 1--> <!--<order_status_identifier>outstanding payment</order_status_identifier>--><!--Alternative 2--> <payment_method_id>2</payment_method_id><!--Alternative 1--> <!--<payment_method_identifier>credit card</payment_method_identifier>--><!--Alternative 2--> <export_date>2020-06-21T19:00:00</export_date> <hold_reason_id>132</hold_reason_id> <hold_reason>Begründung</hold_reason> <customer_type_id>1</customer_type_id><!--Alternative 1--> <customer_type_identifier>private</customer_type_identifier><!--Alternative 2--> <customer_id>3064</customer_id><!--Alternative 1--> <!--<customer_number>5037</customer_number>--><!--Alternative 2--> <!--<external_customer_id_1>ext_cust_no1</external_customer_id_1>--><!--Alternative 3--> <!--<external_customer_id_2>ext_cust_no2</external_customer_id_2>--><!--Alternative 4--> <master_customer_id></master_customer_id><!--Alternative 1--> <!--<master_customer_number>[MASTER_CUST_NO]</master_customer_number>--><!--Alternative 2--> <!--<external_master_customer_id_1>[MASTER_EXT_CUST_NO1]</external_master_customer_id_1>--><!--Alternative 3--> <!--<external_master_customer_id_2>[MASTER_EXT_CUST_NO2]</external_master_customer_id_2>--><!--Alternative 4--> <invoice_address> <address_id>3064</address_id> <salutation_id>1</salutation_id><!--Alternative 1--> <!--<salutation_identifier>mr</salutation_identifier>--><!--Alternative 2--> <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_additional>1. Stock</street_additional> <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_id>1</salutation_id><!--Alternative 1--> <!--<salutation_identifier>mr</salutation_identifier>--><!--Alternative 2--> <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_additional>1. Stock</street_additional> <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> <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></branch_id> <desired_delivery_date>2020-06-22T00:00:00.000+02:00</desired_delivery_date> <transaction_id_1></transaction_id_1> <transaction_id_2></transaction_id_2> <ip_address></ip_address> <tax_id>DE243653785</tax_id> <payment_status_id>1</payment_status_id><!--Alternative 1--> <!--<payment_status_identifier>unpaid</payment_status_identifier>--><!--Alternative 2--> <marketplace_actualisation_deactivated_at>2020-06-21T19:00:00</marketplace_actualisation_deactivated_at> <order_items> <order_item significant_key="[significant_key]"> <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>2020-04-06T15:42:00.000+02:00</order_date> <reference_number></reference_number> <external_offer_number>20110406</external_offer_number> <sub_channel_id>4100</sub_channel_id><!--Alternative 1--> <!--<mandator_id>1</mandator_id>--><!--Alternative 2--> <!--<sub_channel_identifier>Telefonverkauf</sub_channel_identifier>--><!--Alternative 2--> <account_id>2649</account_id><!--Alternative 1--> <!--<account_identifier>Musteraccount</account_identifier>--><!--Alternative 2--> <item_id>61</item_id> <internal_item_number>s4t_05-001</internal_item_number> <quantity>1</quantity> <price>14.95</price> <purchase_price>10.0</purchase_price> <tax_rate>19.0000</tax_rate> <note>Diese Auftragsposition separat versenden.</note> <serial_number></serial_number> <cancel_date></cancel_date> <type>0</type> <coupon_percent>5</coupon_percent> <expected_delivery_date>2020-04-06T00:00:00.000+02:00</expected_delivery_date> <discount_value>4.95</discount_value> <additional_order_item_data delete="true"> <keyvalueitem> <key>Zusatzinfo-Schlüssel</key> <value>Zusatzinfo-Wert</value> </keyvalueitem> </additional_order_item_data> </order_item> </order_items> <payment_instructions> <payment_instruction delete="false"> <payment_instruction_id>64</payment_instruction_id> <external_id>External Id 123</external_id> <recipient>Empfängername</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> <amount>24.95</amount> <currency_code_iso>EUR</currency_code_iso> <due_date>2020-01-16T00: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> <packets> <packet> <shipping_carrier_id>143</shipping_carrier_id><!--Alternative 1--> <!--<mandator_id>1</mandator_id>--><!--Alternative 2+3--> <!--<shipping_carrier_identifier>DHL</shipping_carrier_identifier>--><!--Alternative 2--> <!--<shipping_carrier_external_id>DHL</shipping_carrier_external_id>--><!--Alternative 3--> <shipping_date>2020-04-06T00:00:00.000+02:00</shipping_date> <arrival_date>2020-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>913884631685</tracking_number> <return_number>654132</return_number> <dispatch_type_id>1</dispatch_type_id><!--Alternative 1--> <!--<dispatch_type_identifier>Standard</dispatch_type_identifier>--><!--Alternative 2--> <!--<dispatch_type_external_id>DHL</dispatch_type_external_id>--><!--Alternative 3--> <packet_content> <content> <order_item_id>3067</order_item_id><!--Alternative 1--> <!--<item_identifier>Demoartikel Poloshirt/ L / Weiß</item_identifier>--><!--Alternative 2--> <!--<internal_item_number>s4t_05-001</internal_item_number>--><!--Alternative 3--> <amount>1</amount> <multi_packet>false</multi_packet> </content> </packet_content> </packet> </packets> <ready_for_collection_date>2020-04-11T00:00:00.000+02:00</ready_for_collection_date> <last_changed_at>2020-04-11T00:00:00.000+02:00</last_changed_at> <order_tags> <order_tag significant_key="tag_id"> <tag_id>1</tag_id><!--Alternative 1--> <!--<tag_identifier>PRIORITY</tag_identifier>--><!--Alternative 2--> </order_tag> </order_tags> <additional_order_data delete="true"> <keyvalueitem> <key>Sonderwunsch</key> <value>Überbreite</value> </keyvalueitem> </additional_order_data> <dispatch_type_id>1</dispatch_type_id><!--Alternative 1--> <!--<dispatch_type_identifier>Standard</dispatch_type_identifier>--><!--Alternative 2--> <!--<dispatch_type_external_id>DHL</dispatch_type_external_id>--><!--Alternative 3--> </order> </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: „updateOrders“ |
version |
Attribut von request. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
order |
Wrapper-Element, das die Daten eines Auftrags zusammenfasst |
0..N |
Element |
|
significant_key |
Gibt an welches Feld zur Identifikation des Auftrags beim Update genutzt wird. |
1 |
string |
Feste Werte: „order_id“ | „order_number“ | „external_order_ number_1“ | „external_order_ number_2“ | „marketplace_order_id“ | „order_number_and_prefix“ |
reference_id |
Optionales Attribut des Elements "order". In diesem Feld kann eine beliebige ID angegeben werden die später im zugehörigen Report-Block der Response-Daten wieder erscheint. |
0..1 |
string |
|
order_id |
ID des Auftrages |
0..1 |
integer |
|
mandator_id |
ID des Mandanten dem dieser Auftrag zugeordnet ist. |
1 |
integer |
|
order_number_prefix |
Auftragsnummernpräfix |
0..1 |
string |
|
order_number |
Auftragsnummer |
0..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 |
Auftragsnummer des Marktplatzes |
0..1 |
string |
|
order_date |
Auftragsdatum |
1 |
dateTime |
|
Schließt den Checkout bei eBay Aufträgen. Dieser Vorgang ist irreversibel, da direkt bei eBay der Checkout abgeschlossen wird. (Deprecated) |
0..1 |
integer |
Fester Wert: 2 (=schwebend) |
|
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 |
0..1 |
decimal |
|
shipping_provider |
ID des Versanddienstleisters |
0..1 |
integer |
|
shipping_provider_identifier |
Namen des Versanddienstleisters |
0..1 |
string |
|
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“ |
invoice_number |
Rechnungsnummer |
0..1 |
integer |
|
note |
Bemerkung |
0..1 |
string |
|
order_notices |
Wrapper-Element, das die Auftragsbemerkungen zusammenfasst. |
0..1 |
Element |
|
order_notice |
Wrapper-Element, das die Auftragsbemerkung zusammenfasst. |
1..N |
Element |
|
delete |
Attribut von order_notice. Gibt an, ob die Bemerkung gelöscht werden soll. Standardwert: false. |
0..1 |
boolean |
Feste Werte: true | false |
order_notice_id |
ID der Auftragsbemerkung |
1 |
integer |
|
text |
Bemerkungstext |
1 |
string |
|
notice_type |
Bemerkungstyp |
1 |
integer |
Feste Werte: 10 (=intern) 20 (=extern) |
sub_channel_id |
Element von sub_channel. ID des Sub-Channels. |
1 |
integer |
Siehe Wertetabelle. |
sub_channel_identifier |
Element von sub_channel. Bezeichner des Sub-Channels. |
1 |
string |
Länge: 0-50 Zeichen |
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_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_id |
Element von payment_method. ID der Zahlungsart. |
0..1 |
integer |
Feste Werte |
payment_method_identifier |
Element von payment_method. Bezeichner der Zahlungsart |
0..1 |
string |
Feste Werte |
export_date |
Setzt das Export-Datum mit Uhrzeit des Auftrags an die Warenwirtschaft. |
0..1 |
dateTime |
Datum und Uhrzeit des Exportzeit-punkts |
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_id |
Element von customer_type. ID des Kundentyps. |
0..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_id |
ID des Kunden |
0..1 |
integer |
|
customer_number |
Kundennummer |
0..1 |
integer |
|
external_customer_id_1 |
Externe Kundennummer 1 |
0..1 |
string |
|
external_customer_id_2 |
Externe Kundennummer 2 |
0..1 |
string |
|
master_customer_id |
ID des Kunden des Dublettenmasters |
1..N |
integer |
|
master_customer_number |
Kundennummer des Dublettenmasters |
0..1 |
integer |
|
external_master_customer_id_1 |
Externe Kundennummer 1 des Dublettenmasters |
0..1 |
string |
|
external_master_customer_id_2 |
Externe Kundennummer 2 des Dublettenmasters |
0..1 |
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 |
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 |
0..1 |
string |
Länge: 0-50 Zeichen |
tax_id |
Umsatzsteuer-Ident-Nr. |
0..1 |
string |
Länge: 0-50 Zeichen |
payment_status_id |
ID des Bezahlstatus |
1 |
integer |
Feste Werte: 1 (=offen) 2 (=unterbezahlt) 3 (=bezahlt) 4 (=überbezahlt) |
payment_status_identifier |
Bezeichner des Bezahlstatus |
1 |
string |
Feste Werte: „unpaid“ | „underpaid“ | „paid“ | „overpaid“ |
marketplace_actualisation_deactivated_at |
Wird dieses Datum gesezt, so kann der Auftrag von den Verkaufskanälen nicht mehr geändert werden. |
0..1 |
dateTime |
|
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 |
|
significant_key |
Attribut von order_item. Gibt an welches Feld zur Identifikation der Auftragsposition beim Update genutzt wird. Die Schlüssel item_id und internal_item_number sind nicht immer eindeutig. Näheres dazu in den Hinweisen. |
1 |
string |
Feste Werte: „order_item_id“ | „item_id“ | „internal_item_number“ |
order_item_id |
ID der Auftragsposition |
1 |
integer |
|
order_item_identifier |
Bezeichner der Auftragsposition |
1 |
string |
Länge: 0-200 Zeichen |
order_item_position |
Platzierung der Auftragsposition innerhalb des Auftrags. |
1 |
integer |
|
order_date |
Bestelldatum des Artikels das dieser Position zugeordnet ist. |
1 |
dateTime |
|
reference_number |
Referenznummer dieser Auftragsposition in der jeweiligen Verkaufsplattform über die der Auftrag abgeschlossen wurde. |
0..1 |
string |
|
external_offer_number |
Externe Artikelnummer des Artikels |
0..1 |
string |
|
mandator_id |
ID des Mandanten dem diese Auftrags- Porsition zugeordnet ist. |
1 |
integer |
|
sub_channel_id |
ID des Sub-Channels. |
1 |
integer |
|
sub_channel_identifier |
Identifier des Sub-Channels |
0..1 |
string |
|
account_id |
ID des Accounts |
1 |
integer |
|
account_identifier |
Identifier des Accounts |
0..1 |
integer |
|
item_id |
ID des Artikels der dieser Position zugeordnet ist. |
1 |
integer |
|
internal_item_number |
Interne Artikelnummer des Artikels der dieser Position zugeordnet ist. |
1 |
string |
Länge: 0-50 Zeichen |
quantity |
Menge des Artikels. Die Menge darf nicht über der Menge sein, mit der die Auftragsposition angelegt wurde. Soll eine Menge Storniert werden, so muss für diese Position weniger übergeben werden. |
1 |
integer |
|
price |
Preis für einen einzelnen (!) Artikel |
1 |
decimal |
|
purchase_price |
Einkaufspreis des Artikels |
0..1 |
decimal |
|
tax_rate |
Steuersatz für die Auftragsposition |
1 |
decimal |
|
note |
Bemerkung |
1 |
string |
|
serial_number |
Seriennummer des Artikels |
0..1 |
string |
|
cancel_date |
Storno-Datum des Artikels |
0..1 |
dateTime |
|
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 |
prozentualer Gutscheinwert |
0..1 |
integer |
|
expected_delivery_date |
Voraussichtliches Lieferdatum |
0..1 |
dateTime |
|
discount_value |
Rabattwert dieser Auftragsposition |
0..1 |
decimal |
Keine Prozentangabe |
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 ERP-System an den Shop übergeben werden. |
0..1 |
Element |
|
delete |
Optionales Attribut von additional_order_item_data. Im Default werden bestehende zusätzliche Auftragspositionsinformationen überschrieben, wenn diese im Request nicht mitgegeben werden. Sollen die bereits bestehenden zusätzlichen Auftragspositionsinformationen erhalten bleiben, ist hier "false" zu übergeben. |
0..1 |
boolean |
Default: true |
keyvalueitem |
Wrapper-Element für eine zusätzliche Auftragspositionsinformation. |
1..N |
Element |
|
key |
Schlüssel der Information. |
1 |
string |
|
value |
Wert der Information. |
1 |
string |
|
payment_instructions |
Wrapper-Element, das die Informationen aller Zahlungshinweise zusammenfasst. |
0..1 |
Element |
|
payment_instruction |
Wrapper-Element, das die Informationen eines Zahlungshinweises beinhaltet. |
1..N |
Element |
|
delete |
Attribut von payment_instruction zum Löschen der Information. |
0..1 |
boolean |
|
payment_instruction_id |
Die ID des Zahlungshinweises. Zwingend nötig wenn ein bestehender Zahlungshinweis bearbeitet oder gelöscht werden soll. |
0..1 |
integer |
|
external_id |
Externe ID des Zahlungshinweises. |
0..1 |
string |
|
recipient |
Zahlungsempfänger |
0..1 |
string |
|
iban |
Kontonummer |
0..1 |
string |
|
bic |
Bankkennzeichen |
0..1 |
string |
|
bank_name |
Name der Bank |
0..1 |
string |
|
payment_reason |
Verwendungszweck |
0..1 |
string |
|
note_to_buyer |
Hinweis an den Käufer. |
0..1 |
string |
|
url |
URL-Feld |
0..1 |
string |
|
transaction_number |
Transaktionsnummer |
0..1 |
string |
|
receipt_printing |
Belegdruck |
0..1 |
boolean |
|
amount |
Betrag |
0..1 |
decimal |
|
currency_code_iso |
Währung |
0..1 |
string |
ISO CODE z.B. „EUR“ |
due_date |
Fälligkeitsdatum |
0..1 |
datetime |
|
sepa_mandate_url |
URL für den Aufruf des SEPA-Mandats. |
0..1 |
string |
Länge: 0-2083 |
sepa_mandate_reference |
SEPA-Mandatsreferenznummer. Bis zu 35-Stellen langer, alphanumerischer String zur eindeutigen Identifikation eines SEPA-Mandats. |
0..1 |
string |
Länge: 0-35 |
packets |
Wrapper Element, das die Pakete dieses Auftrags zusammenfasst. |
0..1 |
Element |
|
packet |
Wrapper-Element, das die Daten eines Pakets zusammenfasst. |
0..N |
Element |
|
packet_id |
ID des Pakets. Nötig wenn ein bestehendes Paket aktualisiert werden soll. Bei neuen Paketen wird das Feld ignoriert. |
0..1 |
integer |
|
shipping_carrier_id |
ID des Versanddienstleisters |
0..1 |
integer |
|
mandator_id |
ID des Mandanten. Nur nötig wenn der Versanddienstleister mittels shipping_carrier_identifier oder shipping_carrier_external_id festgelegt werden soll. |
0..1 |
integer |
|
shipping_carrier_identifier |
Bezeichner des Versanddienstleisters |
0..1 |
string |
Länge: 0-255 Zeichen |
shipping_carrier_external_id |
Externe ID des Versanddienstleisters |
0..1 |
string |
|
shipping_date |
Versanddatum |
0..1 |
dateTime |
|
arrival_date |
Lieferdatum |
0..1 |
dateTime |
|
estimated_arrival_date |
Geschätztes Lieferdatum |
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_id |
Versandtyp-ID |
0..1 |
integer |
|
dispatch_type_identifier |
Bezeichnung für Versandtyp |
0..1 |
string |
|
dispatch_type_external_id |
Externe ID des Versandtyps |
0..1 |
string |
|
packet_content |
Wrapper-Element, das alle Inhalte eines Pakets zusammenfasst. |
0..1 |
Element |
|
content |
Wrapper-Element für den Inhalt eines Paketes. |
1..N |
Element |
|
order_item_id |
ID der Auftragsposition, die diesem Paketinhalt zugeordnet ist. |
0..1 |
integer |
Eines dieser drei Felder muss gefüllt sein. |
item_identifier |
Artikelbezeichnung des Artikels, der diesem Paketinhalt zugeordnet ist. |
0..1 |
string |
|
internal_item_number |
Interne Artikelnummer des Artikels, der diesem Paketinhalt zugeordnet ist. |
0..1 |
string |
|
amount |
Anzahl der Artikel dieser einen Auftragsposition, die in diesem Paketinhalt enthalten sind. (Kann bei multi_packet=true weggelassen werden.) |
0..1 |
integer |
|
multi_packet |
Gibt an ob die Auftragsposition auf mehrere Pakete aufgeteilt wurde. |
0..1 |
boolean |
Siehe Infos zu Multi-Paket im Handbuch |
ready_for_collection_date |
Datum, ab dem die Ware vom Kunden abgeholt werden kann. |
0..1 |
dateTime |
|
last_changed_at |
Wird dieses Feld mit dem letzten Änderungsdatum des Auftrags aus dem fetchOrders-Call befüllt, vergleicht der Speed4Trade CONNECT-Server dieses mit dem Datum des vorhandenen Auftrags aus der Datenbank. Ist das Datenbank-Datum jünger als das Übertragegen, wird der Auftrag nicht gespeichert (siehe Return-Codes), da der Auftrag in der Zwischenzeit bereits verändert wurde. |
0..1 |
dateTime |
|
order_tags |
Wrapper-Element, das alle Auftragskennzeichen des Auftrags zusammenfasst. |
0..1 |
Element |
|
order_tag |
Wrapper-Element für ein Auftragskennzeichen des Auftrags. |
1..64 |
Element |
|
significant_key |
Gibt an welches Feld zur Identifikation des Auftragskennzeichens beim Update genutzt wird. |
1 |
string |
Feste Werte: „tag_id“ | tag_identifier“ |
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 ERP-System an den Shop übergeben werden. |
0..1 |
Element |
|
delete |
Optionales Attribut von additional_order_data. Im Default werden bestehende zusätzliche Auftragsinformationen überschrieben, wenn diese im Request nicht mitgegeben werden. Sollen die bereits bestehenden zusätzlichen Auftragsinformationen erhalten bleiben, ist hier "false" zu übergeben. |
0..1 |
boolean |
Default: true |
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 |
|
dispatch_type_id |
Versandtyp-ID |
0..1 |
integer |
|
dispatch_type_identifier |
Bezeichnung für Versandtyp |
0..1 |
string |
|
dispatch_type_external_id |
Externe ID des Versandtyps |
0..1 |
string |
Aufgeführte Werte beschreiben die Adressdaten. |
Name |
Beschreibung |
Anz. |
Typ |
sonstiges |
---|---|---|---|---|
address_id |
ID der Adresse |
0..1 |
integer |
|
salutation_id |
Element von salutation. ID der Anrede. |
1 |
integer |
Zulässige Werte: 1 (= Herr) 2 (= Frau) 3 (= Firma) |
salutation_identifier |
Element von salutation. Bezeichner der Anrede. |
1 |
string |
Zulässige Werte: „mr“ | „ms“ | „business“ |
firm |
Firma des Kunden |
0..1 |
string |
Länge: 0 – 200 Zeichen |
title |
Titel des Kunden |
0..1 |
string |
Länge: 0 – 100 Zeichen |
first_name |
Vorname |
0..1 |
string |
Länge: 0 – 100 Zeichen |
last_name |
Nachname |
0..1 |
string |
Länge: 0 – 200 Zeichen |
street |
Straße |
0..1 |
string |
Länge: 0 – 200 Zeichen |
house_number |
Hausnummer |
0..1 |
string |
Länge: 0 – 50 Zeichen |
street_additional |
Zusatzinformation für die Adresse (z.B. bei Müller) |
0..1 |
string |
Länge: 0 – 200 Zeichen |
postal_code |
Postleitzahl |
0..1 |
string |
Länge: 0 – 50 Zeichen |
city |
Ort |
0..1 |
string |
Länge: 0 – 200 Zeichen |
country_code_iso |
Ländercode |
0..1 |
string |
ISO 3166 ALPHA-2 Codes (z.B. „DE“) |
phone_number |
Telefonnummer (Festnetz) |
0..1 |
string |
Länge: 0 – 50 Zeichen |
<response method="updateOrders" version="1.0.0"> <report action="update" return_code="0"> <order> <order_id>1369896</order_id> <mandator_id>1</mandator_id> <order_number>52</order_number> <external_order_number_1></external_order_number_1> <external_order_number_2></external_order_number_2> </order> </report> <!-- <report return_code="-3" reference_id="ws-123"> <error_description>Die laut der Lizenz maximal zulässige Anzahl an Aufträgen für den Mandanten mit der Id 2 wird um 5 % überschritten. Bitte wenden Sie sich an den Support. </error_description> </report> --> </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: „updateOrders“ |
version |
Attribut von response. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
report |
Information über die ausgeführte Operation. Für jedes Customer-Element aus dem Request wird ein Report zurückgegeben. |
0..N |
Element |
|
action |
Attribut von report. Gibt an welche Operation mit dem Datensatz durchgeführt wurde. |
1 |
string |
Feste Werte: insert | update |
return_code |
Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind. |
1 |
integer |
|
reference_id |
Optionales Attribut von report. Enthält die im zugehörigen order-Block des Requests angegebene reference_id falls diese angegeben wurde. |
0..1 |
string |
|
error_description |
Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert |
0..1 |
string |
|
order |
Wrapper-Element, das die Daten des Auftrags zusammenfasst |
1 |
Element |
|
order_id |
ID des Auftrags |
1 |
integer |
|
mandator_id |
Mandanten-ID |
1 |
integer |
|
order_number |
Auftragsnummer |
1 |
integer |
|
external_order_number_1 |
Externe Auftragsnummer 1 |
0..1 |
string |
Länge: 0 – 50 Zeichen |
external_order_number_2 |
Externe Auftragsnummer 2 |
0..1 |
string |
Länge: 0 – 50 Zeichen |
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 |
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 |
Der Auftrag wurde erfolgreich angelegt oder aktualisiert. |
-1 |
Der Auftrag konnte auf Grund eines unspezifizierten Fehlers nicht aktualisiert werden. |
-3 |
Der Auftrag konnte auf Grund von Lizenzproblemen nicht angelegt werden. Die laut Lizenz festgelegte maximale Anzahl an Aufträgen für den betroffenen Mandanten wurde überschritten. |
-5 |
Zugriff verweigert: Die Bestandteile des Request wurden nicht auf einen gültigen Mandanten eingeschränkt. |
-6 |
Der Auftrag konnte nicht aktualisiert werden. Möglicherweise wurde er zwischenzeitlich von einem anderen Benutzer bearbeitet. |
-7 |
Fehler beim Anlegen des Auftrags. |
-8 |
Fehler beim Laden eines vorhandenen Auftrags. |
-9 |
Fehler beim Aktualisieren des Auftrags. |
-10001 |
Der Auftrag kann nicht aktualisiert werden, weil dessen Positionen unter einem anderen Auftragskopf gruppiert wurden. |
-10002 |
Der Auftrag wurde nicht gespeichert, da sein letztes Änderungsdatum nicht mit dem in der Datenbank übereinstimmt, oder das Datenbank-Datum aktueller ist. |
Allgemeine Hinweise zu UpdateOrders
•Bei jeder Operation wird zunächst geprüft ob bereits ein passender Datensatz mit dem durch significant_key angegebenen Schlüssel zum Aktualisieren vorhanden ist. Wenn dies nicht der Fall ist wird ein neuer Datensatz angelegt. •Die reference_id wird nicht in Speed4Trade CONNECT gespeichert und ist damit auch nicht fest an den betroffenen Auftrag gebunden. Die selbe ID kann daher in unterschiedlichen Calls problemlos wiederverwendet werden. Sie dient lediglich zur schnellen Zuordnung eines Reports in den Response-Daten zu einem order-Block aus den Request-Daten. Dies ist insbesondere dann nützlich wenn es bei der Verarbeitung eines oder mehrerer der übergebenen Aufträgen zu Fehlern kommt und noch keine Auftrags-IDs vorhanden sind. So kann dennoch die Fehlermeldung zu einem Request-Bestandteil zugeordnet werden. •Paketdaten müssen immer vollständig angegeben werden, falls mehrere Pakete zu einem Auftrag existieren. •Pakete ohne Paketinhalt werden destruktiv aktualisiert. Pakete mit Paketinhalt werden additiv behandelt. •Die Rechnungsnummer (invoice_number) kann nur gesetzt werden, solange noch keine Rechnung für den Auftrag gedruckt wurde. •Werden Aufträge, Auftragspositionen oder Teilmengen von Auftragspositionen via updateOrders storniert, so werden vorhandene Bestandsreservierungen zum Artikel aufgelöst. Ist der Auftrag bereits abgeschlossen, dann wird die stornierte Menge beim Artikel aufgebucht. •Der Versanddienstleister muss immer zur Trackingnummer passen, vor allem wenn sich der Versanddienstleister gegenüber dem Angebot geändert hat. •Wird bei den Paketdaten kein Versanddienstleister übergeben, wird automatisch der Standardversanddienstleister des Mandanten verwendet. |
Alternative Felder (entweder oder) •Es muss entweder das Element price_type_id oder price_type_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es muss entweder das Element sub_channel_id oder sub_channel_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es muss entweder das Element account_id oder account_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es muss entweder das Element order_status_id oder order_status_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es muss entweder das Element payment_method_id oder payment_method_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es muss entweder das Element customer_type_id oder customer_type_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es muss entweder das Element salutation_id oder salutation_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es muss entweder das Element payment_status_id oder payment_status_identifier angegeben werden. Die Angabe beider Elemente, oder keines der Elemente ist nicht zulässig. •Es kann entweder das Feld dispatch_type_id oder das Feld dispatch_type_identifier verwendet werden,aber nicht beide geleichzeitig. Wichtige Informationen zu optionalen Feldern •Das Feld cancel_date ist zwingend notwendig, wenn per adjustOrders eine Storno- oder Retourenmeldung an den Marktplatz übertragen werden soll. |
Marktplatzspezifische Hinweise
•Bei einigen Marktplätzen kann es vorkommen, dass mehrere Positionen des Auftrags den gleichen Artikel referenzieren. Dies bedeutet, dass der significant_key bei order_item mit den Werten item_id bzw. internal_item_number nicht eindeutig eine Position identifiziert. Somit können auch keine einzelnen Positionsdaten über diese Schlüssel geändert werden, da sonst mehrere Positionen betroffen wären. In diesen Fällen muss die order_item_id benutzt werden. Speed4Trade CONNECT stellt diese Aufträge genau so dar, wie sie auf den Marktplätzen vorliegen. Erst dadurch ist auch eine Aktualisierung mit dem Marktplatz möglich. Dies betrifft beispielsweise die Marktplätze Amazon, eBay und Kaufland.de. •Senden des Amazon „Versandt-Status“ (order_status_id = 230): •Senden des Amazon „Bezahlt-Status“ (order_status_id = 240): •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. |
Version |
Änderungsbeschreibung |
3.2.9.75 |
Redaktionelle Überarbeitung |
3.2.9.100 |
expected_delivery_date wurde in dem Request ergänzt |
3.2.11.46 |
Ergänzung des Attributs reference_id in den Request- und Response-Daten. |
3.2.11.46 |
Rückgabe eines Fehlers mit dem Return-Code "-3", falls die durch die Software-Lizenz festgelegte maximale Anzahl an Aufträgen überschritten wird. |
3.4.9.1 |
Erweiterung des Calls updateOrders um das Feld ready_for_collection_date |
3.4.16.1 |
Einführung neuer Return-Codes. |
3.4.35.1 |
Erweiterung des Calls updateOrders um das Feld complete_status. |
3.4.48.1 |
Wertetabelle für payment_method erweitert um eine Spalte für den zugehörigen Workflow. |
3.5.27 |
Hinweis zur Nicht-Eindeutigkeit der Schlüssel item_id und internal_item_number bei Auftragspositionen ergänzt. |
3.5.37 |
Erweiterung des Requests um dispatch_type_id und dispatch_type_identifier |
3.5.37 |
Erweiterung um die Felder shipping_carrier_external_id und dispatch_type_external_id |
3.4.35.1 |
Erweiterung um die Felder marketplace_order_id und complete_status |
3.4.35.1 |
Erweiterung um order_tags und additional_order_data |
3.6.30 |
Möglichkeit zum Setzen der Rechnungsnummer hinzugefügt. (invoice_number) |
4.6.46 |
In den Hinweisen die Notizen vom 23.03.2017 ergänzt. |
4.7.22 |
Erweiterung um payment_instructions. |
4.7.26 |
Erweiterung um additional_order_item_data. |
4.7.42 |
Bankdaten als veraltet (deprecated) markiert. |
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.11 |
Erweiterung um Paketinhalte (packet_content). |
4.8.28 |
Erweiterung der additional_order_data um ein delete-Flag. |
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.44 |
Neuer Hinweistext zum Versanddienstleister bei den Paketdaten |
4.10.25 |
Erweiterung der additional_order_item_data um ein delete-Flag. |
4.10.44 |
Setzen des Versandtyps auf Auftragskopfebene. |
4.10.48 |
Retourennummer kann beim Paket übergeben werden. (return_number) |
4.11.5 |
Bisher war es über die Software möglich, den Checkoutstatus von Aufträgen bei eBay zu beeinflussen. Diese Funktion wurde von eBay ersatzlos aus der Schnittstelle entfernt. Dadurch ergeben sich Änderungen für diesen Call. Die Felder export_date und der complete_status sind nun nur noch informativ. |
4.12.45 |
Auftragspositionstypen (type) Beschreibung aktualisiert und ID 3 und 4 nachgetragen. |
4.13.19 |
Rabattwert (discount_value) bei Auftragsposition hinzugefügt. |
4.14.7 |
Für den Paketinhalt kann angegeben werden, ob die Position auf mehrere Pakete aufgeteilt wurde (multi_packet). |