Die XML-Struktur, welche die Daten der Aufträge für die Plattform OTTO Market enthält, ist als Kindelement in den Request-Daten von cancelOrders eingebettet. Sie besitzt folgende Struktur: |
<ottomarket_order significant_key="order_id"> <mandator_id>1</mandator_id> <order_id>489434</order_id><!--Alternative 1--> <!-- <order_number_prefix>BY</order_number_prefix> --><!--Alternative 2--> <!-- <order_number>66</order_number> --><!--Alternative 2--> <!-- <external_order_number_1>ext_ord_no_1</external_order_number_1> --><!--Alternative 3--> <!-- <external_order_number_2>ext_ord_no_2</external_order_number_2> --><!--Alternative 4--> <!-- <marketplace_order_id>123456</marketplace_order_id> --><!--Alternative 5--> </ottomarket_order> |
Name |
Beschreibung |
Anz. |
Typ |
Sonstiges |
---|---|---|---|---|
otto_order |
Wrapper-Element, das die spezifischen Daten eines Auftrags für die Plattform OTTO Market zusammenfasst. |
0..N |
Element |
|
significant_key |
Gibt an welches Feld zur Identifikation des Auftrags genutzt wird. |
1 |
string |
Feste Werte: „order_id“ | „order_number“ | „order_number_and_prefix“ | „external_order_number_1“ | „external_order_number_2“ | „marketplace_order_id“ |
mandator_id |
ID des Mandanten |
1 |
integer |
|
order_id |
ID des Auftrags |
0..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 |
|
external_order_number_2 |
Externe Auftragsnummer 2 |
0..1 |
string |
|
marketplace_order_id |
Marktplatzauftragsnummer |
0..1 |
string |
Beispiel Response
<response method="cancelOrders" version="1.0.0"> <report return_code="0"> <order> <order_id>1803376</order_id> <mandator_id>2</mandator_id> <order_number>3281</order_number> <marketplace_order_id>b2kk2x12c4</marketplace_order_id> <marketplace_order_id_2>1336f8a6-cda7-4a18-abc2-e6ddf611c9a1</marketplace_order_id_2> </order> </report> </response> |
Feldliste 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: „cancelOrders“ |
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 |
order |
Wrapper-Element, das Informationen zu einem angepasstem Auftrag enthält. |
1..N |
Element |
|
order_id |
Auftrags-ID |
1 |
integer |
|
mandator_id |
Mandanten-ID |
1 |
integer |
|
order_number |
Auftragsnummer |
1 |
integer |
|
marketplace_order_id |
Marktplatzauftragsnummer 1 |
1 |
string |
|
marketplace_order_id_2 |
Marktplatzauftragsnummer 2 |
1 |
string |
•Dieser Call ist asynchron und gibt keine Erfolgsmeldung des Stornierungsprozesses zurück. Die Rückgabe besteht lediglich aus der Information, dass der referenzierte Auftrag existiert. Eine Überprüfung, ob die Stornierung funktioniert hat, erfolgt über den Call fetchOrders oder über die Oberfläche von Speed4Trade CONNECT •Bei einem Auftragsstorno über CancelOrders wird immer der vollständige Auftrag storniert. |
Version |
Änderungsbeschreibung |
---|---|
4.11.3 |
Integration des Calls zum Stornieren von OTTO Market Aufträgen. |
4.11.48 |
Marktplatzauftragsnummer 1 und 2 im Response hinzugefügt. |