Spezifische Daten der Plattform shipcloud

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

Spezifische Daten der Plattform shipcloud

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Die XML-Struktur welche die Daten der Versandlabel für die Plattform shipcloud enthält ist als Kindelement in den Request-Daten von fetchShippingLabels eingebettet. Sie besitzt folgende Struktur:

Beispiel Request

Code

<shipcloud_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" />

</shipcloud_shipping_label_filter>

Feldliste Request

Name

Beschreibung

Anz.

Typ

Sonstiges

shipcloud_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

Beispiel Response

Code

<shipcloud_shipping_label>

   <mandator_id>1</mandator_id>

   <order_id>160041</order_id>

   <packet_id>160222</packet_id>

   <file_name>E:\speed4trade\emmida\export\1\119237\160041_7_23.pdf</file_name>

   <created_at>2020-03-10T14:35:38.760+01:00</created_at>

   <exported_at>2020-03-10T14:35:38.760+01:00</exported_at>

</shipcloud_shipping_label>

Feldliste Response

Name

Beschreibung

Anz.

Typ

Sonstiges

shipcloud_shipping_label

Wrapper-Element, das die Informationen zu einem Versandlabel beinhaltet.

0..N

Element

mandator_id

Softwareinterne ID des Mandanten

1

integer

order_id

Softwareinterne Auftrags-ID

1

integer

packet_id

Softwareinterne Paket-ID

1

integer

file_name

Pfad zum Speicherort des Versandlabels (inkl. Dateiname)

1

string

created_at

Erstelldatum des Labels

1

dateTime

exported_at

Exportdatum des Labels (Bei shipcloud-Versandlabels ist dieses Feld aktuell ohne Funktion. Es wird immer das selbe Datum wie bei created_at ausgegeben.)

1

dateTime

Änderungsübersicht

Version

Änderungsbeschreibung

4.10.12

Initiale Einführung des Request.