adjustOrders |
  
|
adjustOrders |
|
Über diese Funktion ist es möglich Teilstornierungen von Aufträgen an die dazugehörige Verkaufsplattform zu übermitteln. Die Stornierung von Auftragspositionen muss vorher über andere Wege (z. B. UI, Import, UpdateOrders) erfolgt sein. |
<request method="adjustOrders" version="1.0.0"> <!-- [order] --> <!-- Platzhalter für plattformspezifische Daten --> <process_synchronous>true</process_synchronous> </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: „adjustOrders“ |
version |
Attribut von request. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
[order] |
Platzhalter für die verschiedenen Daten der plattformspezifischen Aufträge. Die möglichen Daten sind im Abschnitt "Plattformspezifische Daten" des Calls adjustOrders beschrieben. |
0..N |
Element |
|
process_synchronous |
Legt fest, ob der Call synchron oder asynchron durchgeführt wird. Weitere Informationen finden sich im Abschnitt "Hinweise". Falls das Element nicht mit angegeben wird, erfolgt eine asynchrone Verarbeitung |
0..1 |
boolean |
Feste Werte: true | false |
<response method="adjustOrders" version="1.0.0"> <report action="insert" return_code="0"> <order> <order_id>123456</order_id> <mandator_id>1</mandator_id> <order_number_prefix>AMZ</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> </order> </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: „adjustOrders“ |
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 Element aus dem Request wird ein Report zurückgegeben. |
0..N |
Element |
|
return_code |
Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind. |
1 |
integer |
|
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 eines Auftrags zusammenfasst. |
1 |
Element |
|
order_id |
ID des Auftrags |
1 |
integer |
|
mandator_id |
ID des Mandanten |
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 |
•Bei einer synchronen Verarbeitung des Calls wird auf die Ergebnisse gewartet, und der Erfolg oder Misserfolg der Operationen im Response zurückgegeben. Dies kann jedoch insbesondere durch die Kommunikation mit verschiedenen Plattformen (z.B. Amazon) viel Zeit in Anspruch nehmen. Daher kann der Call auch asynchron durchgeführt werden. Hier werden nur offensichtlich unmögliche Eingaben moniert. •Bei der synchronen Verarbeitung tritt ein Timeout auf wenn der Call nicht innerhalb von 3 Minuten abgearbeitet werden kann. Die zum Zeitpunkt des Timeouts vorhandenen Ergebnisse werden zurückgegeben und der Call läuft asynchron weiter. |
Version |
Änderungsbeschreibung |
3.3.2.90 |
Integration des Calls zum Abgleichen von Aufträgen eines Verkaufskanal |
3.4.48.1 |
Erweiterung des Calls um process_synchronous. |