Die XML-Struktur welche die Daten der Versandlabel für die Verkaufsplattform Amazon enthält ist als Kindelement in den Request-Daten von fetchShippingLabels eingebettet. Sie besitzt folgende Struktur: |
<amazon_shipping_label_filter> <mandator_id filter_method="=" filter_value="1" /> <order_id filter_method="=" filter_value="120861" /> <order_number filter_method="=" filter_value="123" /> <external_order_number_1 filter_method="=" filter_value="T45815" /> <external_order_number_2 filter_method="=" filter_value="T45815" /> <marketplace_order_id filter_method="=" filter_value="Amazon-039490" /> <packet_id filter_method="=" filter_value="120865" /> <tracking_number filter_method="=" filter_value="5140502700040" /> <shipping_carrier_external_id filter_method="=" filter_value="ext_id_2314" /> <fetch_confirmed_too>true</fetch_confirmed_too> </amazon_shipping_label_filter> |
Name |
Beschreibung |
Anz. |
Typ |
Sonstiges |
amazon_shipping_label_filter |
Root-Element des plattformspezifischen Versandlabel-Filters. |
0..1 |
Element |
|
mandator_id |
Schränkt die Ergebnismenge der Abfrage auf einen Mandanten ein. |
1 |
Element |
|
filter_method |
Attribut von mandator_id. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von mandator_id. Legt den Wert des Filters fest. |
1 |
integer |
|
order_id |
Schränkt die Ergebnismenge der Abfrage anhand der ID der Bestellung ein. |
0..1 |
Element |
|
filter_method |
Attribut von order_id. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von order_id. Legt den Wert des Filters fest. |
1 |
string |
|
order_number |
Schränkt die Ergebnismenge der Abfrage anhand der Nummer der Bestellung ein. |
0..1 |
Element |
|
filter_method |
Attribut von order_number. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von order_number. Legt den Wert des Filters fest. |
1 |
integer |
|
external_order_number_1 |
Schränkt die Ergebnismenge der Abfrage anhand der externen Bestellnummer 1 ein. |
0..1 |
Element |
|
filter_method |
Attribut von external_order_number_1. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von external_order_number_1. Legt den Wert des Filters fest. |
1 |
string |
|
external_order_number_2 |
Schränkt die Ergebnismenge der Abfrage anhand der externen Bestellnummer 2 ein. |
0..1 |
Element |
|
filter_method |
Attribut von external_order_number_2. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von external_order_number_2. Legt den Wert des Filters fest. |
1 |
string |
|
marketplace_order_id |
Schränkt die Ergebnismenge der Abfrage anhand der Marktplatz-ID der Bestellung ein. |
0..1 |
Element |
|
filter_method |
Attribut von marketplace_order_id. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von marketplace_order_id. Legt den Wert des Filters fest. |
1 |
string |
|
packet_id |
Schränkt die Ergebnismenge der Abfrage Anhand der Packetnummer ein. |
0..1 |
Element |
|
filter_method |
Attribut von packet_id. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von packet_id. Legt den Wert des Filters fest. |
1 |
integer |
|
tracking_number |
Schränkt die Ergebnismenge der Abfrage auf Bestellungen mit der übergebenen Trackingnummer ein. |
0..1 |
Element |
|
filter_method |
Attribut von tracking_number. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von tracking_number. Legt den Wert des Filters fest. |
1 |
integer |
|
shipping_carrier_external_id |
Schränkt die Ergebnismenge der Abfrage auf Bestellungen anhand der externen Versender-ID ein. |
0..1 |
Element |
|
filter_method |
Attribut von shipping_carrier_external_id. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: "=" |
filter_value |
Attribut von shipping_carrier_external_id. Legt den Wert des Filters fest. |
1 |
string |
|
fetch_confirmed_too |
Legt fest ob nur bisher unbestätigte Label abgeholt werden. Wird dieses Feld nicht explizit angegeben, wird der Standardwert '0' verwendet. |
0..1 |
boolean |
<amazon_shipping_label> <mandator_id>1</mandator_id> <order_id>2053944</order_id> <packet_id>2053956</packet_id> <file_name>\\server1\export\shipping_label_5bccd6f0-df5d-505d-a3c6-30a7cdc99084.png</file_name> <created_at>2016-10-04T11:39:21.827+02:00</created_at> </amazon_shipping_label> |
Name |
Beschreibung |
Anz. |
Typ |
Sonstiges |
amazon_shipping_label |
Wrapper-Element, das die Informationen zu einem Versandlabel beinhaltet. |
0..N |
Element |
|
mandator_id |
ID des Mandanten |
1 |
integer |
|
order_id |
Auftrags-ID |
1 |
integer |
|
packet_id |
Paket-ID |
1 |
integer |
|
file_name |
Pfad zum Speicherort des Versandlabels (inkl. Dateiname) |
1 |
string |
|
created_at |
Erstelldatum des Labels |
1 |
dateTime |
•Mit dem Feld fetch_confirmed_too wird gesteuert ob alle gefundenen Versandlabel abgeholt werden (Wert = "1") oder ob nur Versandlabel abgeholt werden, die bisher noch nicht bestätigt wurden. Bestätigung von Versandlabeln werden über den Webservice Call 'confirmShippingLabels' durchgeführt. |
Version |
Änderungsbeschreibung |
3.6.36 |
Initiale Einführung des Request. |