createShippingLabels |
  
|
createShippingLabels |
|
Mit folgendem Request können Sie Versandlabel über externe Anbieter generieren lassen. |
<request method="createShippingLabels" version="1.0.0"> <shipping_labels> <!-- [createShippingLabels] --> <!-- Platzhalter für plattformspezifische Daten --> </shipping_labels> </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: „createShippingLabels“ |
version |
Attribut von request. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
shipping_labels |
Wrapper-Element, das die beantragten Versandlabel beinhaltet. |
1 |
Element |
|
[createShippingLabels] |
Platzhalter für die verschiedenen Daten der plattformspezifischen Wrapper. Die möglichen Daten sind im Abschnitt "Plattformspezifische Daten" des Calls createShippingLabels beschrieben. |
0..N |
Element |
<response method="createShippingLabels" version="1.0.0"> <report action="insert" return_code="0" reference_id="123"> <shipping_label> <!-- [createShippingLabels] --> <!-- Platzhalter für plattformspezifische Daten --> </shipping_label> </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: „“ |
version |
Attribut von response. Legt die Version der Anfrage fest. |
1 |
string |
Fester Wert: „1.0.0“ |
report |
Information über die ausgeführte Operation. |
1 |
Element |
|
return_code |
Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind. |
1 |
integer |
0 = OK. < 0 = Fehler |
reference_id |
Optionales Attribut. Enthält die im zugehörigen ShippingLabel-Block des Requests angegebene reference_id falls diese angegeben wurde. |
0..1 |
string |
|
error_description |
Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert |
1 |
string |
|
shipping_label |
Wrapper-Element, das die Informationen für ein Versandlabel beinhaltet. |
1 |
Element |
|
[createShippingLabels] |
Platzhalter für die verschiedenen Daten der plattformspezifischen Wrapper. Die möglichen Daten sind im Abschnitt "Plattformspezifische Daten" des Calls createShippingLabels beschrieben. |
1 |
Element |
Hinweise
•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. |
Version |
Änderungsbeschreibung |
3.6.36 |
Initiale Einführung des Request. |
4.10.12 |
Aufgliederung des Requests in plattformspezifische Einträge. |