Spezifische Daten für das Multi-Channel-Plugin

Navigation:  WebService Calls > Options for Growth > cancelOrders > Plattformspezifische Daten >

Spezifische Daten für das Multi-Channel-Plugin

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Die XML-Struktur, welche die Daten der Aufträge für das Multi-Channel-Plugin enthält, ist als Kindelement in den Request-Daten von cancelOrders eingebettet. Sie besitzt folgende Struktur:

Beispiel Request

Code

<multi_channel_plugin_order significant_key="order_id">

   <mandator_id>1</mandator_id>

   <order_id>607767</order_id> <!-- Alternative 1 -->

   <!-- <order_number_prefix>AM</order_number_prefix> Alternative 2-->

   <!-- <order_number>38721</order_number> Alternative 2 -->

   <!-- <external_order_number_1>TES_0002</external_order_number_1> Alternative 3 -->

   <!-- <external_order_number_2>RSP_0002</external_order_number_2> Alternative 4 -->

   <!-- <marketplace_order_id_1>AM20-EFC2Z</marketplace_order_id_1> Alternative 5 -->

   <order_items>

      <order_item significant_key="internal_item_number">

         <order_item_id>1124970</order_item_id>

         <item_id>1124970</item_id>

         <internal_item_number>com006</internal_item_number>

         <type_identifier>Cancellation</type_identifier>

         <type_id>1</type_id>

         <reason_identifier>TEST-ONE</reason_identifier>

         <reason_external_identifier>Storno 12</reason_external_identifier>

         <amount>2</amount>

         <was_accepted>true</was_accepted>

         <creation_timestamp>2022-02-08T10:11:12.763+01:00</creation_timestamp>

      </order_item>

   </order_items>

</multi_channel_plugin_order>

Feldliste Request

Name

Beschreibung

Anz.

Typ

Sonstiges

multi_channel_plugin_order

Wrapper-Element, das die spezifischen Daten eines Auftrags für das Multi-Channel-Plugin zusammenfasst.

0..N

Element

significant_key

Gibt an welches Feld zur Identifikation des Auftrags beim Stornieren 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

Auftragsnummern Prä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_1

Marktplatzauftragsnummer

0..1

string

order_items

Wrapper-Element für die Auftragspositionen

1

Element

order_item

Wrapper Element, das die Daten einer Auftragsposition zusammenfasst.

0..N

Element

significant_key

Gibt an welches Feld zur Identifikation einer Auftragsposition beim Stornieren des Auftrags genutzt wird.

1

string

Feste Werte: „order_item_id“ | „item_id“ | „internal_item_number“

order_item_id

ID der Auftragsposition

0..1

integer

item_id

ID des Artikels der dieser Position zugeordnet ist.

0..1

integer

internal_item_number

Interne Artikelnummer des Artikels der dieser Position zugeordnet ist.

0..1

string

type_identifier

Bezeichnung des Abbruchtyps

0..1

string

Hinweis

type_id

ID des Abbruchtyps

0..1

integer

Hinweis

reason_identifier

Bezeichnung des Abbruchgrundes

0..1

string

Hinweis

reason_external_identifier

Externe Bezeichnung des Abbruchgrundes

0..1

string

Hinweis

amount

Menge

1

integer

was_accepted

Abbruch wurde akzeptiert oder abgelehnt.

0..1

boolean

creation_timestamp

Zeitstempel des Abbruchs

0..1

dateTime

Wird kein Datum angegeben, dann wird automatisch der aktuelle Timestamp gesetzt.

 

Wertetabelle(n)

 

Aufgeführte Werte gelten für das Feld type_id.

Wert

Beschreibung

1

Cancellation

2

Return

 

Hinweise

•Es ist der type_identifier oder die type_id anzugeben. Die Felder dürfen nicht zusammen verwendet werden.

•Es ist der reason_identifier oder reason_external_identifier anzugeben. Die Felder dürfen nicht zusammen verwendet werden.

•Abbruchgründe (Reason) entsprechen den in der Software gepflegten Daten

Änderungsübersicht

Version

Änderungsbeschreibung

4.12.11

Integration des Calls zum Stornieren von Aufträgen beim Multi-Channel-Plugin.