Spezifische Daten der Plattform shipcloud

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

Spezifische Daten der Plattform shipcloud

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Mit folgendem Request können Sie Versandlabel von shipcloud abrufen.

Beispiel Request

Code

<shipcloud_shipping_label reference_id="123">

   <mandator_id>1</mandator_id>

   <order significant_key="order_id">

      <order_id>55000</order_id>

      <order_number>34561</order_number>

      <external_order_number_1>1111</external_order_number_1>

      <external_order_number_2>2222</external_order_number_2>

      <marketplace_order_id>54981</marketplace_order_id>

      <order_number_and_prefix>Pref-1230</order_number_and_prefix>

      <mandator_id>1</mandator_id>

   </order>

   <shipcloud_account>Externe Account Bezeichnung</shipcloud_account>

   <height>15</height>

   <length>20</length>

   <width>30</width>

   <dimension_unit>110</dimension_unit>

   <weight>2500</weight>

   <weight_unit>400</weight_unit>

   <from_address>

      <salutation_id>1</salutation_id>

      <salutation_identifier>mr</salutation_identifier>

      <firm>Speed4Trade GmbH</firm>

      <title>Dr.</title>

      <first_name>Max</first_name>

      <last_name>Mustermann</last_name>

      <street>An den Gärten</street>

      <house_number>8</house_number>

      <street_additional>1. Stock</street_additional>

      <postal_code>92665</postal_code>

      <city>Altenstadt</city>

      <country_code_iso>DE</country_code_iso>

      <phone_number>0960294440</phone_number>

   </from_address>

      <carrier>dhl</carrier>

      <service>standard</service>

      <package_type>letter</package_type>

      <shipping_carrier>dhl_ext</shipping_carrier>

      <carrier_configuration>dhl_external_config_id</carrier_configuration>

   <return_label>false</return_label>

</shipcloud_shipping_label>

Feldliste Request

Name

Beschreibung

Anz.

Typ

Sonstiges

shipcloud_shipping_label

Wrapper-Element, das die Information zu einem Versandlabel umfasst.

1..N

Element

mandator_id

ID des Mandanten.

1

integer

order

Wrapper-Element, das die Informationen zu einer Bestellung zusammenfasst.

1

Element

significant_key

Gibt an welches Feld zur Identifikation des Auftrags beim Update genutzt wird.

1

string

Feste Werte: „order_id“ | „order_number“ | „external_order_number_1“ | „external_order_number_2“ | „marketplace_order_id“ | „order_number_and_prefix“

order_id

ID der Bestellung

1

integer

order_number

Nummer der Bestellung

1

integer

external_order_number_1

Externe Auftragsnummer 1

0..1

integer

external_order_number_2

Externe Auftragsnummer 2

0..1

integer

marketplace_order_id

Auftragsnummer des Marktplatzes

1

string

order_number_and_prefix

Auftragsnummernpräfix und Auftragsnummer

1

string

mandator_id

ID des Mandanten dem dieser Auftrag zugeordnet ist

0..1

integer

shipcloud_account

Externe Bezeichnung des shipcloud-Accounts

1

string

height

Höhenmaß des Pakets

1

integer

length

Längenmaß des Pakets

1

integer

width

Breitenmaß des Pakets

1

integer

dimension_unit

ID für die Einheit der angegebenen Maße

1

integer

Feste Werte

weight

Gewicht

1

integer

weight_unit

ID für die Einheit des angegebenen Gewichts

1

integer

Feste Werte

from_address

Wrapper-Element, das die Absenderadressdaten beinhaltet.

1

Element

salutation_id

ID der Anrede

1

integer

Hinweis

salutation_identifier

Bezeichnung der Anrede

string

Hinweis

firm

Firma

0..1

string

Max. 30 Zeichen. Hinweis

title

Namenszusatz

0..1

string

first_name

Vorname

1

string

last_name

Nachname

1

string

street

Straße

1

string

house_number

Hausnummer

1

string

street_additional

Adresszusatz

0..1

string

postal_code

Postleitzahl

1

string

Max. 30 Zeichen. Hinweis

city

Stadt

1

string

Max. 30 Zeichen. Hinweis

country_code_iso

ISO-Ländercode

1

string

Z. B.: "DE" | "CH" | "AT" usw.

phone_number

Telefonnummer

1

string

Max. 30 Zeichen. Hinweis

carrier

Versanddienstleister (Vorgabe von shipcloud.)

1

string

Hinweis

service

Servicetyp (Vorgabe von shipcloud.)

1

string

Hinweis

package_type

Sendungsart (Vorgabe von shipcloud.)

1

string

Hinweis

shipping_carrier

Zugehöriger Speed4Trade-CONNECT-Versanddienstleister

1

string

Hinweis

carrier_configuration

Externe Bezeichnung der zu Versandkonfiguration

0..1

string

Hinweis

return_label

Definiert ob direkt ein Retourenlabel erstellt werden soll. Wird der Wert nicht angegeben, wird kein Retourenlabel erstellt.

0..1

bool

Hinweis

Beispiel Response

Code

<mandator_id>1</mandator_id>

<order_id>2053944</order_id>

<shipping_date>2016-10-04T15:42:00.000+02:00</shipping_date>

Feldliste Response

Name

Beschreibung

Anz.

Typ

Sonstiges

mandator_id

ID des Mandanten

1

integer

order_id

ID der Bestellung

1

integer

shipping_date

Versanddatum

1

dateTime

Hinweise

•Dieser Request wird asynchron ausgeführt. D.h. auf eine Antwort von shipcloud wird nicht gewartet. Sollte shipcloud mit einer Fehlermeldung antworten (z.B.: Ungültige Paketmaße) dann wird dieser Response am Auftrag gespeichert. Um diesen Response aus Speed4Trade CONNECT auszulesen, verwenden Sie bitte den Request fetchOrders. In den Auftragsdaten werden die Responses als order_notices gespeichert. Unter den additional_order_data werden ebenfalls Informationen hinterlegt, die für die Nutzung von shipcloud relevant sind. Dazu gehören: Versanddienstleister, shipcloud-VersandID, shipcloud Versandlabel und ob ein Pickup Request nötig ist. Pickup Requests (Abholaufträge) müssen aktuell noch über das shipcloud-Backend bestätigt werden.

•Die reference_id wird nicht in Speed4Trade CONNECT gespeichert und ist damit auch nicht fest an das betroffene Versandlabel gebunden. Die selbe ID kann daher in unterschiedlichen Calls problemlos wiederverwendet werden. Sie dient lediglich zur schnellen Zuordnung eines Reports in den Response-Daten zu einem ShippingLabel-Block aus den Request-Daten.

•Es muss entweder das Element 'salutation_id' oder 'salutation_identifier' übergeben werden. Beide Elemente gleichzeitig sind nicht zulässig.

•Wurde beim Erstellen des Versandlabels noch kein Retourenlabel erstellt, so kann dies im Nachgang durchgeführt werden. Es genügt den selben Request neu zu übergeben und diesesmal return_label mit dem Wert true zu übergeben.

•Wird eine gültige Versandkonfiguration via carrier_configuration übergeben und gleichzeitig die Werte die in einer Versandkonfiguration enthalten sind (carrier, service, package_type und shipping_carrier), dann nimmt die Software die Werte aus der Versandkonfiguration. Die zusätzlich übergebenen Werte werden ignoriert. Die Versandkonfigurationen können über die Oberfläche angelegt werden.

Wertetabelle(n)

Folgende Werte gelten für das Feld: dimension_unit

Wert

Beschreibung

105

mm

110

cm

115

dm

120

m

125

in.

130

ft.

135

yd

Folgende Werte gelten für das Feld: weight_unit

Value

Description

400

g

405

kg

407

t

409

oz.tr.

410

oz.

415

pd.

Änderungsübersicht

Version

Änderungsbeschreibung

4.10.12

Initiale Einführung des Request.