Dokumentation zur Rakuten Shop-API


addOrderDHLShippingLabel

Diese Methode erstellt ein neues DHL-Versand-Etikett.

Mit dieser URL rufen Sie die API-Methode auf:

Authentifizierung

Für diese Methode ist eine Authentifizierung mit Schreibrechten erforderlich.
Empfohlen wird der Aufruf über HTTP-POST.

Parameter

Die mit * gekennzeichneten Parameter müssen übergeben werden.

key *

Authentifizierungs-Schlüssel

Datentyp: String
order_no *

Bestell-Nr.

Datentyp: String
Regeln: Das Format der Bestell-Nr. ist XXX-XXX-XXX.
step

Gewichtsstufe

Datentyp: Integer
Regeln:
0 = Pauschale (keine Gewichtsklassifizierung)
1 = bis 2kg
2 = bis 10kg
3 = bis 20kg
4 = bis 31,5kg

Standard: 0
retoure

Kennzeichen für einen Retouren-Identcode

Datentyp: Boolean
Standard: 1

Antwort

Beispiel im XML-Format.

<?xml version="1.0" encoding="utf-8"?>
<result>
   <success>1</success>
   <label>
   	<src>http://api.rakuten.de/webservice/docs/shipping_label?label_id=123456&key=123456789a123456789a123456789a12</src>
   	<created>2010-01-01 20:15:00</created>
   	<identcodes>
   		<shipping>
   			<identcode>123456789</identcode>
   			<tracking>URL zur Paketverfolgung</tracking>
   		</shipping>
   		<retoure>
   			<identcode>123456789</identcode>
   			<tracking>URL zur Paketverfolgung</tracking>
   		</retoure>
   	</identcodes>
   </label>
</result>
Element Datentyp Bedeutung
result Container Container mit angeforderten Daten
success Boolean Kennzeichen für einen erfolgreichen Aufruf
1 = erfolgreich
-1 = fehlerhaft
label Container Container mit Daten zum Versand-Etikett
src URL URL zum DHL Versand-Etikett als PDF
created Date Erstellungs-Datum
identcodes Container Container mit Identcodes
shipping Container Container mit Identcode-Daten zum Versand
identcode Integer Identcode
tracking URL URL zur Paketverfolgung
retoure Container Container mit Identcode-Daten zur Retoure
Beinhaltet keine Daten, wenn kein Retouren-Etikett angelegt wurde!
identcode Integer Identcode
tracking URL URL zur Paketverfolgung


Fehlermeldungen



Code Bedeutung
3102 Es wurde kein aktiver DHL-Vertrag gefunden
3105 Die Bestellung konnte nicht gefunden werden
3110 Die Maximale Anzahl an Labels wurde erreicht
3111 Es konnte kein neues Label erzeugt werden
3115 Eine Gewichtsangabe ist nicht gültig, da ein Pauschal-Vertrag hinterlegt ist
3116 Das Hinterlegen einer Pauschale ist bei einen Vertrag nach Gewicht nicht zulässig