Vorwort

Bei diesem Paket handelt es sich um eine inoffizielle Bibliothek für die DHL Geschäftskundenversand APIin der Version 3.2, geschrieben in PHP.

Diese Bibliothek ermöglicht einen leichteren objektorientierten Zugriff auf die Funktionalität deroffiziellen Geschäftskundenversand API der DHL.

• Erstellen, Löschen und Aktualisieren von Versandscheinen
• Exportdokumente generieren
• Prüfen von Verssanddaten
• Tagesabschlüsse eines gegebenen Datums als PDF-Datei herunterladen

• Anstelle von String-Statusmeldungen werden Status-Objekte zurückgegeben
• Trennung von Straßenname und Hausnummer aus einem String. Diese Funktion ist jedoch "experimentell" und funktioniert nicht mit allen Adressen
• Landescodierung zu Landenamen konvertieren
• PHPUnit Tests für interne Funktionen

• Sendungsverfolgungs-Daten abfragen
• Die Unterschrift des Empfängers als Bilddatei herunterladen

Voraussetzungen

• PHP 5.6=<
• PHP Soap Extension
• Composer

Installation

Fügen Sie das Paket manuell Ihren composer.json Abhängigkeiten hinzu oder navigieren Sie zu Ihrem Projektordner und geben den folgenden Befehl ein:

composer require christoph-schaeffer/dhl-business-shipping

Authentifizierung

Entwicklerkonto

Um diese Library und die DHL Geschäftskundenversand API zu nutzen benötigen Sie ein DHL-Entwicklerkonto. Sie können sich kostenlos unter entwickler.dhl.de registrieren.

Um später den Sandbox Modus zu nutzen benötigen Sie das passwort, welches Sie hier in Registrierung eingegeben haben. Desweiteren benötigen Sie Ihre Entwickler-ID. Dies entspricht einem Usernamen, den Sie jedoch nicht frei wählen können, sondern Ihnen zugeteilt wird. Um diesen einzusehen melden Sie sich auf dem DHL-Entwicklerportal an und klicken Sie anschließend rechts oben auf Ihren Namen.

Geschäftskunden Konto

Um den Produktiv-Modus zu nutzen werden Zugangsdaten für das DHL Geschäftskundenportal benötigt. Falls Sie diese Library in ein Projekt, dass für Ihre Kunden gedacht ist einbauen, sollten diese Daten von Ihrem Kunden pflegbar sein. Über diese Zugangsdaten erfolgt zudem die Abrechnung der Versandkosten. Es ist trotzdem empfehlenswert eigene Zugangsdaten bei DHL anzufordern um auch den Produktiv-Modus zu testen. Erzeugte Paketscheine kann man über das Geschäftskundenportal im Browser stornieren, damit keine versehentlichen Kosten durch Tests entstehen.

Um die Sendungsverfolgung um Produktiv-Modus zu verwenden wird zusätzlich noch ein ZT-Token mit DASS Freigabe, sowie ein Passwort für diesen benötigt. Den Token mitsamt Passwort erhalten Sie im Geschäftskundenportal unter Meine Daten ->Verfolgen.

Freigabe beantragen

Bevor eine Integration der DHL API im Produktiv-Modus genutzt werden kann, muss eine Freigabe durch DHL erfolgen. Dies können Sie über das DHL Entwickler-Portal tun. Unter dem Menüpunkt "Freigabe erhalten" können Sie anschließend einen API-Token generieren. Bitte beachten Sie, dass dabei abgehakt werden muss welche Features für Ihre App aktiviert sind.

Client instanzieren

Um die Funktionen dieser Bibliothek ausführen zu können, muss zunächst ein Client-Objekt instanziiert werden. Die erforderlichen API-Anmeldeinformationen werden über den Konstruktor gesetzt. Außerdem wird der Sandbox-Modus ein- und ausgeschaltet. Wenn der Sandbox-Modus aktiviert ist, muss anstelle der APP-ID eine Entwickler-ID übergeben werden. Außerdem wird anstelle des API-Tokens das Passwort IhresEntwicklerkontos auf der DHL-Entwickler-Website. Beides finden sie auf dem DHL Entwickler Portal

Es gibt 3 Client-Klassen in dieser Bibliothek: ShippingClient, TrackingClient und MultiClient. Der MultiClient fasst beide Clients in einem zusammen, was in der Regel auch gewünscht ist. Daher verwenden wir ihn als Basisbeispiel. Die Authentifizierungsdaten werden in 2 Klassen gespeichert. Eine für die Geschäftsversand-API und eine für die Tracking-API. Diese 2 APIs sind nicht identisch und benötigen unterschiedliche Parameter für die Authentifizierung. Bitte beachten Sie, dass Sie im Sandbox-Modus Login und Passwort, sowie ztToken und ztToken Passwort nicht ändern sollten, da im Sandbox-Modus nur die Standardwerte erlaubt sind.

Erstellen Sie ein Versand-Client-Credentials-Objekt und füllen Sie es mit Ihren Credentials.

use ChristophSchaeffer\Dhl\BusinessShipping\Credentials\ShippingClientCredentials; // Autoload the ShippingClientCredentials class

$shippingClientCredentials = new ShippingClientCredentials(
    'appID',        // Im Sandbox-Modus ist dies Ihre Entwickler-ID.
    'apiToken',     // Im Sandbox-Modus ist dies das Passwort für Ihr Entwicklerkonto.
    'login',        // DHL Geschäftskunden-Kontoname. Dies ist optional und standardmäßig 2222222222_01 (Sandbox)
    'password',     // DHL-Geschäftskunden-Passwort. Dies ist optional und steht standardmäßig auf pass (Sandbox)
);

Erstellen Sie ein Tracking-Client-Credentials-Objekt und füllen Sie es mit Ihren Credentials.

use ChristophSchaeffer\Dhl\BusinessShipping\Credentials\TrackingClientCredentials; // Autoload the TrackingClientCredentials class

$shippingClientCredentials = new TrackingClientCredentials(
    'appID',        // Im Sandbox-Modus ist dies Ihre Entwickler-ID.
    'apiToken',     // Im Sandbox-Modus ist dies das Passwort für Ihr Entwicklerkonto.
    'ztToken',      // DHL-Geschäftskunden-ZT-Token. Dies ist optional und standardmäßig zt12345 (Sandbox)
    'password',     // DHL-Geschäftskunden-ZT-Token-Passwort. Dies ist optional und steht standardmäßig auf geheim (Sandbox)
);

Erstellen Sie ein Client-Objekt und füllen Sie es mit Ihren Anmeldedaten.

use ChristophSchaeffer\Dhl\BusinessShipping\MultiClient; // Autoload der MultiClient-Klasse

$client = new MultiClient(
    $shippingClientCredentials
    $trackingClientCredentials
    TRUE,                              // isSandbox
    MultiClient::LANGUAGE_LOCALE_ENGLISH_GB // Setzen Sie die Sprache der Statusmeldung auf Englisch (Standard ist Deutsch).
);

Funktionen

Nachdem das Client-Objekt instanziert ist lassen sich darüber die Funktionen der Bibliothek aufrufen.
Vorher muss jedoch noch ein Request-Objekt erzeugt werden, welches mit Daten, die für spezifisch für jede Funktion unterschiedlich gefüllt werden müssen. Bitte ersetzen Sie in dem Beispiel unten API entweder mit Tracking oder Shipping jenachdem um welche API es sich handelt. "function" natürlich mit der jeweiligen Funktion

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\API\function($param1, $param2);
$response = $client->function($request);

function muss hier in den Namen der jeweiligen Funktion geändert werden.

Über das zurückgegebene Response-Objekt lässt sich prüfen, ob die Funktion erfolgreich ausgeführt wurde. Bei ShippingClient Funktionen ist es zudem möglich die Statusmeldungen abzufragen. Falls Fehler aufgetreten sind, sind diese dort beschrieben.

if($response->hasNoErrors()):
   foreach($status as $response->Status):
       echo $status->message;
   endforeach;
else:
   echo 'Erfolgreich ausgeführt';
endif;

Die TrackingClient Funktionen haben lediglich einen error String, falls es einen Fehler gab. Wenn es keinen Fehler gab ist dieser null.

if($response->hasNoErrors()): // Prüft ob Fehlermeldungen zurückgegeben wurden.
   echo 'Success!';
else:
   echo 'An error occured!\n';
   echo $response->error;   // Dies ist der error String, der von DHL zurückgegeben wurde.
endif;

Get Version

Mit diesem Vorgang kann die neueste im Web verfügbare Version abgefragt werden.

Diese Funktion ist auch nützlich, um Ihre Verbindung und Authentifizierung zu überprüfen.

Erstellen Sie das Request-Objekt, rufen Sie die Funktion getVersion auf und speichern Sie die Response in einer Variable.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getVersion();
$response = $client->getVersion($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob der Vorgang erfolgreich war. Wenn der RequestFehler enthält, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:ul

Validate Shipment

Mit diesem Vorgang können die Daten für eine Sendung validiert werden, bevor ein Sendungsetikett und eineSendungsverfolgungsnummer erstellt werden.

Erstellen Sie für jede Sendung, die Sie prüfen möchten, einen neuen Sendungsauftrag.

$shipmentOrder = new \ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder();

Legen Sie die Versanddetails fest.

$shipmentOrder->Shipment->ShipmentDetails->product = 'V01PAK'; // V01PAK = Nationales Paket
$shipmentOrder->Shipment->ShipmentDetails->accountNumber = '22222222220101'; // DHL Geschäftskunden Kontonummer
$shipmentOrder->Shipment->ShipmentDetails->ShipmentItem->weightInKG = 1.2; // Das Gewicht inklusive Verpackung

Legen Sie die Absenderadresse fest, falls die Sendung nicht geliefert werden kann, wird sie an diese Adresse zurückgesandt.

$shipmentOrder->Shipment->Shipper->Name->name1 = 'DHL Paket GmbH';
$shipmentOrder->Shipment->Shipper->Address->streetName = 'Sträßchensweg';
$shipmentOrder->Shipment->Shipper->Address->streetNumber = '10';
$shipmentOrder->Shipment->Shipper->Address->zip = '53113';
$shipmentOrder->Shipment->Shipper->Address->city = 'Bonn';
$shipmentOrder->Shipment->Shipper->Address->Origin->countryISOCode = 'DE';

Legen Sie die Empfängeradresse fest.

$shipmentOrder->Shipment->Receiver->name1 = 'DHL Paket GmbH';
$shipmentOrder->Shipment->Receiver->Address->streetName = 'Charles-de-Gaulle-Str.';
$shipmentOrder->Shipment->Receiver->Address->streetNumber = '20';
$shipmentOrder->Shipment->Receiver->Address->zip = '53113';
$shipmentOrder->Shipment->Receiver->Address->city = 'Bonn';
$shipmentOrder->Shipment->Receiver->Address->Origin->countryISOCode = 'DE';

Fügen Sie einem Array bis zu 30 Versandaufträge hinzu.

$shipmentOrders = [$shipmentOrder]; // Es ist möglich, bis zu 30 ShipmentOrders in einem Request zu senden.

Erstellen Sie das Request-Objekt, rufen Sie die Funktion validateShipment auf und speichern Sie die Response ineiner Variable.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\validateShipment($shipmentOrders);
$response = $client->validateShipment($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob der Vorgang erfolgreich war. Wenn der Requestselbst oder eines der Validation-State Objekte Fehler aufweist, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;

   foreach($response->ValidationStates as $validationState): // Für jeden Sendungsauftrag wird ein Validation-State zurückgegeben.
       foreach($validationState->Status as $status): // echo Alle Statusmeldungen des Validation-State.
           echo '\n-- '.$status->message;
       endforeach;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\validateShipment
• Response\validateShipment

Create Shipment Order

Dieser Vorgang erstellt Sendungen für "DHL Paket" einschließlich der entsprechenden Versanddokumente. DieSendungsnummer wird zusammen mit einem Versandetikett zurückgegeben, welches gedruckt werden kann.

Erstellen Sie für jede Sendung, die Sie erstellen möchten, einen neuen Sendungsauftrag.

$shipmentOrder = new \ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder();

Stellen Sie die Versanddetails ein.

$shipmentOrder->Shipment->ShipmentDetails->product = 'V01PAK'; // V01PAK = Nationales Paket
$shipmentOrder->Shipment->ShipmentDetails->accountNumber = '22222222220101'; // DHL Geschäftskunden Kontonummer
$shipmentOrder->Shipment->ShipmentDetails->ShipmentItem->weightInKG = 1.2; // Gewicht inkl. Verpackung

Legen Sie die Absenderadresse fest, falls die Sendung nicht geliefert werden kann, wird sie an diese Adresse zurückgesandt.

$shipmentOrder->Shipment->Shipper->Name->name1 = 'DHL Paket GmbH';
$shipmentOrder->Shipment->Shipper->Address->streetName = 'Sträßchensweg';
$shipmentOrder->Shipment->Shipper->Address->streetNumber = '10';
$shipmentOrder->Shipment->Shipper->Address->zip = '53113';
$shipmentOrder->Shipment->Shipper->Address->city = 'Bonn';
$shipmentOrder->Shipment->Shipper->Address->Origin->countryISOCode = 'DE';

Definieren Sie die Empfängeradresse.

$shipmentOrder->Shipment->Receiver->name1 = 'DHL Paket GmbH';
$shipmentOrder->Shipment->Receiver->Address->streetName = 'Charles-de-Gaulle-Str.';
$shipmentOrder->Shipment->Receiver->Address->streetNumber = '20';
$shipmentOrder->Shipment->Receiver->Address->zip = '53113';
$shipmentOrder->Shipment->Receiver->Address->city = 'Bonn';
$shipmentOrder->Shipment->Receiver->Address->Origin->countryISOCode = 'DE';

Fügen Sie einem Array bis zu 30 Versandaufträge hinzu.

$shipmentOrders = [$shipmentOrder]; // Es ist möglich, bis zu 30 Sendungsaufträge in einer Anfrage zu versenden.

Erstellen Sie das Request-Objekt, rufen Sie die Funktion createShipmentOrder auf und speichern Sie die Response ineiner Variable.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\createShipmentOrder($shipmentOrders);
$response = $client->createShipmentOrder($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob der Vorgang erfolgreich war. Wenn der Requestselbst oder eines der Creation-State-Objekte Fehler enthält, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
   foreach($response->CreationState as $creationState):
       echo 'shipment number: '. $creationState->shipmentNumber;
       echo 'shipment label url:'.$creationState->LabelData->labelUrl; // Wenn der labelResponseType auf URL gestellt wurde
       echo 'shipment label data:'.$creationState->LabelData->labelData; // Wenn der labelResponseType auf base64 oder ZPL2 gestellt wurde
   endforeach;
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;

   foreach($response->CreationStates as $creationState): // Für jeden Sendungsauftrag wird ein CreationState zurückgegeben.
       foreach($creationState->LabelData->Status as $status): // echo Alle Statusmeldungen zum Erstellungsstatus.
           echo '\n-- '.$status->message;
       endforeach;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\createShipmentOrder
• Response\createShipmentOrder

Update Shipment Order

Mit diesem Vorgang werden Versanddokumente für zuvor erstellte Sendungen aktualisiert. Das Update führt automatischeine Stornierung und Erstellung einer Sendung durch. Dies funktioniert jedoch nur für Sendungen, für die Sie die Funktion doManifest noch nicht aufgerufen haben. Beachten Sie auch, dass, wenn im Geschäftskundenportal nichts anderes festgelegt ist, täglich um 18 Uhr ein automatischer doManifest-Anruf für alle offenen Sendungen erfolgt.

Erstellen Sie einen neuen Sendungsauftrag, und befüllen Sie diesen mit allen Daten die Sie von Ihrem vorhandenenSendungsauftrag aktualisieren möchten.

$shipmentOrder = new \ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder();

Definieren Sie die Versanddetails ein.

$shipmentOrder->Shipment->ShipmentDetails->product = 'V01PAK'; // V01PAK = Nationales Paket
$shipmentOrder->Shipment->ShipmentDetails->accountNumber = '22222222220101'; // DHL Geschäftskunden Kontonummer
$shipmentOrder->Shipment->ShipmentDetails->ShipmentItem->weightInKG = 1.2; // Das Gewicht inklusive Verpackung

Legen Sie die Absenderadresse fest, falls die Sendung nicht geliefert werden kann, wird sie an diese Adresse zurückgesandt.

$shipmentOrder->Shipment->Shipper->Name->name1 = 'DHL Paket GmbH';
$shipmentOrder->Shipment->Shipper->Address->streetName = 'Sträßchensweg';
$shipmentOrder->Shipment->Shipper->Address->streetNumber = '10';
$shipmentOrder->Shipment->Shipper->Address->zip = '53113';
$shipmentOrder->Shipment->Shipper->Address->city = 'Bonn';
$shipmentOrder->Shipment->Shipper->Address->Origin->countryISOCode = 'DE';

Legen sie die Empfänger Adresse fest.

$shipmentOrder->Shipment->Receiver->name1 = 'DHL Paket GmbH';
$shipmentOrder->Shipment->Receiver->Address->streetName = 'Charles-de-Gaulle-Str.';
$shipmentOrder->Shipment->Receiver->Address->streetNumber = '20';
$shipmentOrder->Shipment->Receiver->Address->zip = '53113';
$shipmentOrder->Shipment->Receiver->Address->city = 'Bonn';
$shipmentOrder->Shipment->Receiver->Address->Origin->countryISOCode = 'DE';

Erstellen Sie das Request-Objekt, rufen Sie die Funktion updateShipmentOrder auf und speichern Sie die Response ineiner Variable. Der erste Parameter ist die Sendungsnummer der Sendungsbestellung, die Sie aktualisieren möchten. Der zweite Parameter sind die neuen Daten.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\updateShipmentOrder('existingShipmentNumberAsString', $shipmentOrder);
$response = $client->updateShipmentOrder($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob der Vorgang erfolgreich war. Wenn der Request selbst oderdas LabelData Objekt Fehler aufweist, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
   echo 'shipment label url:'.$response->LabelData->labelUrl; // Wenn der labelResponseType des Etiketts URL ist
   echo 'shipment label data:'.$response->LabelData->labelData; // Wenn der labelResponseType des Etiketts base64 oder ZPL2 ist
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;

   foreach($response->LabelData->Status as $status): // echo Alle LabelData Statusmeldungen.
       echo '\n-- '.$status->message;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\updateShipmentOrder
• Response\updateShipmentOrder

Delete Shipment Order

Dieser Vorgang bricht bereits erstellte Sendungen ab. Dies funktioniert jedoch nur für Sendungen, für die Sie dieFunktion doManifest noch nicht aufgerufen haben. Beachten Sie auch, dass, wenn im Geschäftskundenportal nichts anderes festgelegt ist, täglich um 18 Uhr ein automatischer doManifest-Anruf für alle offenen Sendungen erfolgt.

Erstellen Sie ein Array und fügen Sie bis zu 30 Sendungsnummern hinzu, die Sie löschen möchten.

$shipmentNumbers = ['124894812491','81242189821','12789175981'];

Erstellen Sie das Request-Objekt, rufen Sie die Funktion deleteShipmentOrder auf und speichern Sie die Response ineiner Variable.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\deleteShipmentOrder($shipmentNumbers);
$response = $client->deleteShipmentOrder($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob der Vorgang erfolgreich war. Wenn der Requestselbst oder eines der Deletion-State Objekte Fehler aufweist, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // Prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;

   foreach($response->DeletionStates as $deletionState): // Für jede Sendungsnummer wird ein Deletion-State zurückgegeben.
       foreach($deletionState->Status as $status): // echo Alle Statusmeldungen des Deletion-States.
           echo '\n-- '.$status->message;
       endforeach;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\deleteShipmentOrder
• Response\deleteShipmentOrder

Get Label

Dieser Vorgang gibt das Versandetikett für zuvor erstellte Sendungen zurück.

Erstellen Sie ein Array und fügen Sie bis zu 30 Sendungsnummern hinzu, von denen Sie ein Etikett erhalten möchten.

$shipmentNumbers = ['124894812491','81242189821','12789175981'];

Erstellen Sie das Request-Objekt, rufen Sie die Funktion getLabel auf und speichern Sie die Response ineiner Variable.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getLabel($shipmentNumbers);
$response = $client->getLabel($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob die Anforderung erfolgreich war. Wenn die Anforderungselbst oder eines der LabelData Objekte Fehler aufweist, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
   echo 'shipment label url:'.$response->LabelData->labelUrl; // Wenn der labelResponseTypes des Etiketts URL ist
   echo 'shipment label data:'.$response->LabelData->labelData; // Wenn der labelResponseTypes des Etiketts base64 oder ZPL2 ist
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;

   foreach($response->LabelData as $labelData): // Für jede Sendungsnummer gibt es ein Etikettendatenobjekt.
       foreach($labelData->Status as $status): // echo Alle LabelData Statusmeldungen.
           echo '\n-- '.$status->message;
       endforeach;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\getLabel
• Response\getLabel

Get Export Doc

Dieser Vorgang gibt Exportdokumente für zuvor erstellte Sendungen zurück.

Erstellen Sie ein Array und fügen Sie bis zu 30 Sendungsnummern hinzu, von denen Sie das Exportetikett erhalten möchten.

$shipmentNumbers = ['124894812491','81242189821','12789175981'];

Erstellen Sie das Request-Objekt, rufen Sie die Funktion getExportDoc auf und speichern Sie die Response ineiner Variable.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getExportDoc($shipmentNumbers);
$response = $client->getExportDoc($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob die Anforderung erfolgreich war. Wenn die Anforderungselbst oder eines der Exportdokumentdatenobjekte Fehler aufweist, können Sie deren Meldungen anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
   foreach($response->ExportDocData as $exportDocData):
       echo 'export doc url:'.$exportDocData->exportDocUrl; // Wenn der labelResponseType des Exportdokuments URL ist
       echo 'export doc data:'.$exportDocData->exportDocData; // Wenn der labelResponseType des Exportdokuments base64 oder ZPL2 ist
   endforeach;
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;

   foreach($response->ExportDocData as $exportDocData): // Für jede Sendungsnummer gibt es ein Exportdokument-Objekt.
       foreach($exportDocData->Status as $status): // echo Alle Statusmeldungen für Exportdokumentdaten.
           echo '\n-- '.$status->message;
       endforeach;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\getExportDoc
• Response\getExportDoc

Get Manifest

Mit dieser Operation sind Tagesabschlussberichte für einen bestimmten Tag oder Zeitraum abrufbar. In einem Berichtsind immer alle Sendungen des gewählten Tages aufgelistet.

Erstellen Sie das Request-Objekt, rufen Sie die Funktion getManifest auf und speichern Sie die Response ineiner Variable. Übergeben Sie das Datum (JJJJ-MM-TT-Zeichenfolge), dessen Manifest Sie als Rückgabe erhalten möchten, an das Request-Objekt.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getManifest('2020-01-30');
$response = $client->getManifest($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob der Vorgang erfolgreich war. Wenn der Request Fehlerenthält, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
   echo 'manifest base64 data : '.$response->manifestData //Dies ist eine PDF-Datei als Base64-codierte Zeichenfolge
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\getManifest
• Response\getManifest

Do Manifest

Mit diesem Vorgang kann ein Tagesabschluss für bis zu 30 zuvor erstellte Sendungen durchgeführt werden. Bitte beachtenSie, dass sobald Sie diese Funktion für einen Versandauftrag aufgerufen haben, der Versandauftrag nicht mehr storniert werden kann.

Erstellen Sie ein Array und fügen Sie bis zu 30 Sendungsnummern hinzu, für die Sie die Funktion doManifest ausführen möchten.

$shipmentNumbers = ['124894812491','81242189821','12789175981'];

Erstellen Sie das Request-Objekt, rufen Sie die Funktion doManifest auf und speichern Sie die Response ineiner Variable.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\doManifest($shipmentNumbers);
$response = $client->doManifest($request);

Verwenden Sie die Funktion hasNoErrors, um zu überprüfen, ob der Vorgang erfolgreich war. Wenn der Requestselbst oder eines der Manifest-State Objekte Fehler aufweist, können Sie deren Nachrichten anzeigen.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
   echo 'Success!';
else:
   echo 'An error occured!\n';

   foreach($response->Status as $status): // echo alle Statusmeldungen.
       echo '\n- '.$status->message;
   endforeach;

   foreach($response->ManifestStates as $manifestState): // Für jede Sendungsnummer gibt es einen ManifestState.
       foreach($manifestState->Status as $status): // echo alle Statusmeldungen des ManifestState.
           echo '\n-- '.$status->message;
       endforeach;
   endforeach;
endif;

Weitere Informationen zu den anderen Properties dieser Funktion finden Sie unter:

• Request\doManifest
• Response\doManifest

Get Piece Detail

TrackingClient Funktion

Diese Funktion funktioniert nur bei Sendungen, die Sie mit demselben Geschäftskundenkonto versendet haben wie die von Ihnen verwendeten zt-Token-Anmeldedaten.

Die Funktion getPieceDetail ruft über eine Abfrage alle Informationen zu einer Sendung ab. Dies geschieht durch die Kombination der Abfrage der Funktionen getPiece und getPieceEvents.

Die Funktion kann mit einer Sendungsnummer, einer Sendungsreferenz oder einer Auftragsnummer für eine einzelne Abholung aus dem Abholportal aufgerufen werden.

Richten Sie das Anfrageobjekt ein, rufen Sie die Funktion getPieceDetail auf und erhalten Sie die Response.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getPieceDetail();
$request->pieceCode = '00340434161094027318';
$response = $client->getPieceDetail($request);

Um zu prüfen, ob die Anfrage erfolgreich war, verwenden Sie die Funktion hasNoErrors. Wenn die Anfrage selbst oder ein untergeordnetes Objekt nicht den Statuscode "0" hat, was = Erfolg ist, gibt diese Funktion false zurück.

if($response->hasNoErrors()): // Prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
    echo 'Success!';
else:
    echo 'An error occured!\n';
    echo $response->error;   // Dies ist die von dhl übermittelte String-Fehlermeldung
endif;

Weitere Informationen über die anderen Eigenschaften dieser Funktion finden Sie hier:

• Request\getPieceDetail
• Response\getPieceDetail

Get Piece

TrackingClient Funktion

Diese Funktion funktioniert nur bei Sendungen, die Sie mit demselben Geschäftskundenkonto versendet haben wie die von Ihnen verwendeten zt-Token-Anmeldedaten.

Die Funktion getPiece liefert den aktuellen Versandstatus von einer oder mehreren Sendungen. Im Gegensatz zur Abfrageaus der DHL-Sendungsverfolgung für jedermann liefert diese Funktion mehr Statusdaten, die nur für betriebsinterne Auswertungen verwendet werden dürfen.

Die Funktion kann mit einer Sendungsnummer, einer Sendungsreferenz oder einer Auftragsnummer für eine einzelne Abholung aus dem Abholportal aufgerufen werden.

Richten Sie das Anfrageobjekt ein, rufen Sie die Funktion getPiece auf und erhalten Sie die Response.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getPiece();
$request->pieceCode = '00340434161094027318';
$response = $client->getPiece($request);

Um zu prüfen, ob die Anfrage erfolgreich war, verwenden Sie die Funktion hasNoErrors. Wenn die Anfrage selbst oder ein untergeordnetes Objekt nicht den Statuscode "0" hat, was = Erfolg ist, gibt diese Funktion false zurück.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
    echo 'Success!';
else:
    echo 'An error occured!\n';
    echo $response->error;   // dies ist die von dhl übermittelte String-Fehlermeldung
endif;

Weitere Informationen über die anderen Eigenschaften dieser Funktion finden Sie hier:

• Request\getPiece
• Response\getPiece

Get Piece Events

TrackingClient Funktion

Diese Funktion funktioniert nur bei Sendungen, die Sie mit demselben Geschäftskundenkonto versendet haben wie die von Ihnen verwendeten ZT-Token-Anmeldedaten.

Die Funktion getPieceEvents liefert den Sendungsverlauf, bestehend aus den einzelnen Ereignissen einer Sendung.

Für einen erfolgreichen Aufruf benötigt diese Funktion das Attribut piece-id aus dem getPiece/getPieceDetail-Aufruf.Daher kann diese Funktion immer nur in Kombination mit einem vorhergehenden Funktionsaufruf für den Transportstatus getPiece/getPieceDetail verwendet werden. Da immer nur eine piece-id übertragen werden kann, wird immer nur eine Route für einen Transport abgerufen.

Richten Sie das Anfrageobjekt ein, rufen Sie die Funktion getPieceEvents auf und erhalten Sie die Response.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getPieceEvents();
$request->pieceId = '3b048653-aaa9-485b-b0dd-d16e068230e9';
$response = $client->getPieceEvents($request);

Um zu prüfen, ob die Anfrage erfolgreich war, verwenden Sie die Funktion hasNoErrors. Wenn die Anfrage selbst oder ein untergeordnetes Objekt nicht den Statuscode "0" hat, was = Erfolg ist, gibt diese Funktion false zurück.

if($response->hasNoErrors()): // Prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
    echo 'Success!';
else:
    echo 'An error occured!\n';
    echo $response->error;   // Dies ist die von dhl übermittelte String-Fehlermeldung
endif;

Weitere Informationen über die anderen Eigenschaften dieser Funktion finden Sie hier:

• Request\getPieceEvents
• Response\getPieceEvents

Get Signature

TrackingClient Funktion

Diese Funktion funktioniert nur bei Sendungen, die Sie mit demselben Geschäftskundenkonto versendet haben wie die von Ihnen verwendeten ZT-Token-Anmeldedaten.

Mit der Funktion getSignature kann die Unterschrift des Empfängers oder des Ersatzempfängers abgefragt werden. Die Unterschriften sind auch als POD = Proof of Delivery bekannt.

Dabei sind die folgenden Besonderheiten zu beachten:

• Die Empfängerunterschriften können nur über die Sendungsnummer abgerufen werden.
• Die Signatur selbst wird in Form eines GIF-Bildformats geliefert. Da dieses Bildformat Binärdaten enthält,die bei der Umwandlung in XML Probleme bereiten würden, wurden die Daten byteweise in die hexadezimale Notation umgewandelt. Diese Bibliothek konvertiert sie jedoch wieder in Binärdaten, nachdem sie von DHL empfangen wurden.
• Die Zugriffe belasten die Ressourcen in der Regel erheblich. Es wird empfohlen, Unterschriften nur fürzugestellte Sendungen (deliveryEventFlag = true) mit dest-country = DE abzurufen, da Unterschriften nur für diese Sendungen im System vorhanden sind. Die Signaturen müssen nur einmal abgerufen werden. Wenn Sie eine Unterschrift abgeholt haben, sollten Sie diese in Ihrem System speichern, um später wieder darauf zugreifen zu können.

Richten Sie das Anfrageobjekt ein, rufen Sie die Funktion getSignature auf und erhalten Sie die Response.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getSignature();
$request->pieceCode = '00340434161094027318';
$response = $client->getSignature($request);

Um zu prüfen, ob die Anfrage erfolgreich war, verwenden Sie die Funktion hasNoErrors. Wenn die Anfrage selbst oder ein untergeordnetes Objekt nicht den Statuscode "0" hat, was = Erfolg ist, gibt diese Funktion false zurück..

if($response->hasNoErrors()): // Prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
    echo 'Success!';
else:
    echo 'An error occured!\n';
    echo $response->error;   // Dies ist die von dhl übermittelte String-Fehlermeldung
endif;

Weitere Informationen über die anderen Eigenschaften dieser Funktion finden Sie hier:

• Request\getSignature
• Response\getSignature

Get Status For Public User

TrackingClient Funktion

!!! WICHTIGE INFO !!! Diese Funktion ist im Sandbox-Modus deaktiviert (sagt der Support). Keine Ahnung, warum dhl sich dazu entschlossen hat ¯\_(ツ)_/¯

Die Funktion getStatusForPublicUser stellt Informationen so zur Verfügung, wie sie derzeit in der DHLSendungsverfolgung für jedermann sichtbar sind. Sie können mit dieser Funktion alle Sendungsnummern abfragen, auch von Sendungen, die Sie nicht selbst verschickt oder empfangen haben. Sie können bis zu 15 Sendungen mit einer Anfrage abfragen.

Erstellen Sie für jede Sendung, die Sie abfragen möchten ein PieceData Objekt

$piece1 = new PieceData(); // Erstellen Sie das erste PieceData, das Sie anfordern möchten
$piece1->pieceCode = '00340435091628083543'; // die Sendungsnummer setzen

$piece2 = new PieceData(); // Erstellen Sie das zweite PieceData, das Sie anfordern möchten
$piece2->pieceCode = '00340435091628083544'; // die Sendungsnummer setzen

$pieces = [$piece1, $piece2]; // beide Objekte zu einem Array kombinieren

Richten Sie das Anfrageobjekt ein, rufen Sie die Funktion getStatusForPublicUser auf und erhalten Sie die Antwort.

$request = new \ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getStatusForPublicUser($pieces);
$response = $client->getStatusForPublicUser($request);

Um zu prüfen, ob die Anfrage erfolgreich war, verwenden Sie die Funktion hasNoErrors. Wenn die Anfrage selbst oder ein untergeordnetes Objekt nicht den Statuscode "0" hat, was = Erfolg ist, gibt diese Funktion false zurück.

if($response->hasNoErrors()): // prüft, ob Fehlerstatusmeldungen zurückgegeben wurden.
    echo 'Success!';

    foreach($response->pieceStatusPublicList as $pieceStatusPublic):
    if(!$pieceStatusPublic->hasNoErrors()) {
        echo 'An error occured with the shipment number'.$pieceStatusPublic->pieceCode.'\n';
        echo $pieceStatusPublic->pieceStatusDesc.'\n';
    }
endforeach;
else:
    echo 'An error occured!\n';
    echo $response->error.'\n';   // dies ist die von dhl übermittelte String-Fehlermeldung
endif;

Weitere Informationen über die anderen Eigenschaften dieser Funktion finden Sie hier:

• Request\getStatusForPublic
• Response\getStatusForPublic

Utility

Address Parser

Wird verwendet, um Strings mit Straßennamen und Hausnummer zu teilen. Verwenden Sie diese Funktion jedoch auf eigenes Risiko,obwohl es mit 99% der europäischen und amerikanischen Adressen funktioniert. Es ist immer besser, die Benutzer ihre Adresse separiertt eingeben zu lassen. (Also ein Feld für Hausnummer und eins für die Straße)

Benutzung

use ChristophSchaeffer\Dhl\BusinessShipping\Utility\AddressParser

list($street, $houseNumber) = AddressParser::splitStreetAndHouseNumber('testerstraße 123');

Country Code Conversion

Wird verwendet, um Ländercodes in ISO 3166-1 (Alpha 2) in den Ländernamen und umgekehrt zu konvertieren. Sie können dieconst COUNTRYCODE_TO_COUNTRY_MAP als Optionen für ein Select-Feld verwenden. Verwenden Sie die Keys, bei denen es sich um Ländercodes handelt, als Werte und die Array-Werte als Bezeichnung.

Benutzung

use ChristophSchaeffer\Dhl\BusinessShipping\Utility\CountryCodeConversion

$countryName = CountryCodeConversion::countryCodeToCountry('DE');
echo $countryName; // Germany

$countryName = CountryCodeConversion::countryCodeToCountry('GB');
echo $countryName; // United Kingdom

$countryCode = CountryCodeConversion::countryToCountryCode('Germany');
echo $countryCode; // DE

$countryCode = CountryCodeConversion::countryToCountryCode('United Kingdom');
echo $countryCode; // GB

CountryCodeConversion::COUNTRYCODE_TO_COUNTRY_MAP; // Verwenden Sie dies in Ihrer Benutzeroberfläche als Select-Feld

Sanitizer

Status Mapper

XML-Parser

Daten-Objekte

Version

Die Version der Webdienstimplementierung, für die der anfordernde Client entwickelt wurde.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\Version

Request

Shipping

Alle Shipping Request-Klassen extenden die AbstractShippingRequest-Klasse.

ChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

Get Version

Mit diesem Vorgang kann die neueste im Web verfügbare Version abgefragt werden.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getVersion

Validate Shipment

Mit diesem Vorgang können die Daten für eine Sendung validiert werden, bevor ein Sendungsetikett und eineSendungsverfolgungsnummer erstellt werden.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\validateShipment

Create Shipment Order

Dieser Vorgang erstellt Sendungen für "DHL Paket" einschließlich der entsprechenden Versanddokumente. DieSendungsnummer wird zusammen mit einem Versandetikett zurückgegeben, welches gedruckt werden kann.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\createShipmentOrder

Update Shipment Order

Mit diesem Vorgang werden Versanddokumente für zuvor erstellte Sendungen aktualisiert. Das Update führt automatischeine Stornierung und Erstellung einer Sendung durch. Dies funktioniert jedoch nur für Sendungen, für die Sie die Funktion doManifest noch nicht aufgerufen haben. Beachten Sie auch, dass, wenn im Geschäftskundenportal nichts anderes festgelegt ist, täglich um 18 Uhr ein automatischer doManifest-Anruf für alle offenen Sendungen erfolgt.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\updateShipmentOrder

Delete Shipment Order

Dieser Vorgang bricht bereits erstellte Sendungen ab. Dies funktioniert jedoch nur für Sendungen, für die Sie dieFunktion doManifest noch nicht aufgerufen haben. Beachten Sie auch, dass, wenn im Geschäftskundenportal nichts anderes festgelegt ist, täglich um 18 Uhr ein automatischer doManifest-Anruf für alle offenen Sendungen erfolgt.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\deleteShipmentOrder

Get Label

Dieser Vorgang gibt das Versandetikett für zuvor erstellte Sendungen zurück.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getLabel

Get Export Doc

Dieser Vorgang gibt Exportdokumente für zuvor erstellte Sendungen zurück.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getExportDoc

Get Manifest

Mit dieser Operation sind Tagesabschlussberichte für einen bestimmten Tag oder Zeitraum abrufbar. In einem Berichtsind immer alle Sendungen des gewählten Tages aufgelistet.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\getManifest

Do Manifest

Mit diesem Vorgang kann ein Tagesabschluss für bis zu 30 zuvor erstellte Sendungen durchgeführt werden. Bitte beachtenSie, dass sobald Sie diese Funktion für einen Versandauftrag aufgerufen haben, der Versandauftrag nicht mehr storniert werden kann.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Request\AbstractShippingRequest

ChristophSchaeffer\Dhl\BusinessShipping\Request\Shipping\doManifest

Tracking

Get Status for Public User

ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getStatusForPublicUser

Get Piece Detail

ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getPieceDetail

Get Piece

ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getPiece

Get Piece Events

ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getPieceEvents

Get Signature

ChristophSchaeffer\Dhl\BusinessShipping\Request\Tracking\getSignature

Response

Alle Response-Klassen extenden die AbstractResponse-Klasse. Diese Klasse und ihre untergeordneten Elemente solltenjedoch nicht manuell instanziiert werden, sondern werden nur automatisch befüllt und von den Client-Funktionen zurückgegeben. Verwenden Sie sie also nur read-only.

ChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractResponse

Shipping

Alle Versandantwortklassen erweitern die Klasse AbstractShippingResponse. Diese Klasse und ihre Unterklassen solltenjedoch nicht manuell instanziiert werden, sondern werden nur automatisch ausgefüllt und von den Client-Funktionen zurückgegeben. Verwenden Sie sie als schreibgeschützt.

ChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

Get Version

Mit diesem Vorgang kann die neueste im Web verfügbare Version abgefragt werden.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\getVersion

Validate Shipment

Mit diesem Vorgang können die Daten für eine Sendung validiert werden, bevor ein Versandetikett und eineSendungsverfolgungsnummer erstellt werden.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\validateShipment

Validation State

Der Erfolgsstatus des Vorgangs für jede einzelnen ShipmentOrder wird von einem CreationState-Element zurückgegeben.Diese sind über die sequenceNumber Property identifizierbar.

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\State\ValidationState

Create Shipment Order

Dieser Vorgang erstellt Sendungen für "DHL Paket" einschließlich der entsprechenden Versanddokumente. DieSendungsnummer wird zusammen mit einem Versandetikett zurückgegeben, welches gedruckt werden kann.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\createShipmentOrder

Creation State

Der Erfolgsstatus des Vorgangs für jede einzelne ShipmentOrder wird von einem CreationState-Element zurückgegeben. Diese ist über die sequenceNumber Property identifizierbar.

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\State\CreateionState

Label Data

Bei erfolgreicher Ausführung wird ein Sendungsetikett erstellt und zurückgegeben. Abhängig vom angefordertenAntworttyp werden nur die Eigenschaften labelData oder labelUrl gefüllt.

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\Data\LabelData

Update Shipment Order

Mit diesem Vorgang werden Versanddokumente für zuvor erstellte Sendungen aktualisiert. Das Update führt automatischeine Stornierung und Erstellung einer neuen Sendung durch. Dies funktioniert jedoch nur für Sendungen, für die Sie die Funktion doManifest noch nicht aufgerufen haben. Beachten Sie auch, dass, wenn im Geschäftskundenportal nichts anderes festgelegt ist, täglich um 18 Uhr ein automatischer doManifest-Anruf für alle offenen Sendungen erfolgt.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\updateShipmentOrder

Delete Shipment Order

Dieser Vorgang storniert bereits erstellte Sendungen. Dies funktioniert jedoch nur für Sendungen, für die Sie dieFunktion doManifest noch nicht aufgerufen haben. Beachten Sie auch, dass, wenn im Geschäftskundenportal nichts anderes festgelegt ist, täglich um 18 Uhr ein automatischer doManifest-Anruf für alle offenen Sendungen erfolgt.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\deleteShipmentOrder

Deletion State

Für jede angeforderte Sendungsnummer wird ein DeletionState-Element zurückgegeben, welches den Status des jeweiligen Löschvorgangs enthält.

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\State\DeletionState

Get Label

Dieser Vorgang gibt das Versandetikett für zuvor erstellte Sendungen zurück.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\getLabel

Label Data

Bei erfolgreicher Ausführung wird ein Sendungsetikett erstellt und zurückgegeben. Abhängig vom angefordertenAntworttyp werden nur die Eigenschaften labelData oder labelUrl gefüllt.

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\Data\LabelData

Get Export Doc

Dieser Vorgang gibt Exportdokumente für zuvor erstellte Sendungen zurück.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\getExportDoc

Export Doc Data

Enthält das Ergebnis der Dokumentverarbeitung: Falls keine Fehler vorliegen, ist eine Base64-codierte PDF-Dateienthalten. Außerdem werden der Status dieser Dokumentgenerierung und die übergebene Sendungsnummer zurückgegeben.

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\Data\ExportDocData

Get Manifest

Mit dieser Operation sind Tagesendberichte für einen bestimmten Tag oder Zeitraum abrufbar.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\getManifest

Do Manifest

Mit diesem Vorgang kann ein Tagesabschluss für bis zu 30 zuvor erstellte Sendungen durchgeführt werden. Bitte beachtenSie, dass diese Funktion, sobald Sie sie für einen Versandauftrag aufgerufen haben, dieser nicht mehr storniert werden kann.

Diese Klasse extended vonChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractShippingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\doManifest

Manifest State

Der Status des Vorgangs für die entsprechende (n) Sendung (en).

ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\State\ManifestState

Tracking

Alle Tracking-Response-Klassen erweitern die AbstractTrackingResponse-Klasse. Diese Klasse und ihre Unterklassensollten jedoch nicht manuell instanziiert werden, sondern werden nur automatisch ausgefüllt und von den Client-Funktionen zurückgegeben. Verwenden Sie sie wie schreibgeschützt.

ChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractTrackingResponse

Get Status for Public User

Diese Klasse erweitertChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractTrackingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\getStatusForPublicUser

Piece Status Public

Not translated yet

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\Data\PieceStatusPublic

Piece Event

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\Data\PieceEvent

Get Piece Detail

Diese Klasse erweitertChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractTrackingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\getPieceDetail

Piece Shipment

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\Data\PieceShipment

Piece Event

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\Data\PieceEvent

Get Piece

Diese Klasse erweitertChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractTrackingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\getPiece

Piece Shipment

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\Data\PieceShipment

Get Piece Events

Diese Klasse erweitertChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractTrackingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\getPieceEvents

Piece Event

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\Data\PieceEvent

Get Signature

Diese Klasse erweitertChristophSchaeffer\Dhl\BusinessShipping\Response\AbstractTrackingResponse

ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\getSignature

Signature

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Tracking\Data\Signature

Shipment Order

ShipmentOrder ist das höchste übergeordnete Element, welches alle Daten zu einem Sendungsauftrag enthält. Sie könnenbis zu 30 ShipmentOrder-Objekte pro Anfrage senden.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder

Print Only If Codeable

Wenn active auf TRUE gesetzt ist, kann das Etikett nur gedruckt werden, wenn die Empfängeradresse gültig ist.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\PrintOnlyIfCodeable

Shipment

Ist das Kernelement eines ShipmentOrder. Es enthält alle relevanten Informationen der Sendung.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment

Export Document

Bei internationalen Sendungen enthält dieser Abschnitt Informationen zu den für den Zoll relevanten Exportgütern. Fürinternationale Sendungen: Handelsrechnung, Versandschein (CP71) und Zollanmeldung (CN23) werden in die zurückgegebenen Etiketteninformationen gedruckt. Die Daten werden auch als elektronische Zollanmeldung an den Zoll übermittelt. Für europäische Sendungen. Bei internationalen Sendungen kann ExportDocument eine oder mehrere Positionen im untergeordneten Element enthalten.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ExportDocument

Export Doc Position

Ein oder mehrere untergeordnete Elemente für jede Position, die im Exportdokument definiert werden soll. Jedes enthälteine Beschreibung, einen Herkunftscode des Landes, eine Menge, ein Nettogewicht und einen Zollwert. Mehrfachpositionen nur für internationale Sendungen außer EU-Sendungen möglich.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ExportDocument\ExportDocPosition

Receiver

Enthält relevante Informationen über den Empfänger.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver

Address

Die Adresse des Versandempfängers

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver\Address

Origin

Land des Empfängers

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver\Address\Origin

Communication

Kommunikationsdaten des Sendungsempfängers

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver\Communication

Packstation

Die Adresse des Empfängers ist eine deutsche Packstation.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver\Packstation

Origin

Land der Packstation

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver\Packstation\Origin

Postfiliale

Die Adresse des Empfängers ist eine deutsche Postfiliale.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver\Postfiliale

Origin

Land der Postfiliale

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Receiver\Postfiliale\Origin

Return Receiver

Wird verwendet, wenn eine Rücksendeetikette generiert werden soll.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ReturnReceiver

Address

Die Adresse, an die die Sendung zurückgeschickt werden soll. Dies wird nur beim Drucken eines Rücksendeetiketts verwendet.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ReturnReceiver\Address

Origin

Land der Absenderadresse. Dies wird nur beim Drucken eines Rücksendeetiketts verwendet.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ReturnReceiver\Address\Origin

Communication

Kommunikationsdaten für die Absenderadresse. Dies wird nur beim Drucken eines Rücksendeetiketts verwendet.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ReturnReceiver\Communication

Name

Name der Adresse, die auf dem Rücksendeetikett gedruckt wird. Dies wird nur beim Drucken eines Rücksendeetiketts verwendet.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ReturnReceiver\Name

Shipment Details

Enthält die Informationen des Versandproduktcodes, der Gewichts- und Größenmerkmale und der zu verwendenden Dienstleistungen.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails

Bank Data

Bankdaten können hier für verschiedene Zwecke bereitgestellt werden. z.B. Wenn Nachnahme als Service gebucht wird,müssen die Bankdaten vom DHL-Kunden bereitgestellt werden (Pflichtangabe für die Serverlogik). Das gesammelte Geld wird auf das angegebene Bankkonto überwiesen.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\BankData

Notification

Mechanismus zum Senden von Benachrichtigungen per E-Mail nach erfolgreicher Manifestation der Sendung.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Notification

Service

Container für alle Dienstleistungen

Verwenden Sie für jeden Service, der mit dem Versandprodukt gebucht werden soll, ein dediziertes Serviceobjekt.Fügen Sie ein weiteres Serviceobjekt hinzu, um einen weiteren Service zu buchen etc. Die erfolgreiche Buchung eines bestimmten Service hängt von den Kontoberechtigungen und der Service Kombinierbarkeit des Produkts ab. Das heißt, Nicht jeder Service ist für jedes Produkt zulässig oder kann mit allen anderen zulässigen Services kombiniert werden.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service

Additional Insurance

Versichern Sie den Versand mit einem höheren als dem Standardbetrag.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\AdditionalInsurance

Bulky Goods

Service zum Versand sperriger Güter.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\BulkyGoods

Cash On Delivery

Nachname Service

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\CashOnDelivery

Day Of Delivery

Tag der Lieferung für das Produkt: V06TG: Kurier Taggleich; V06WZ: Kurier Wunschzeit

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\DayOfDelivery

Delivery Timeframe

Lieferzeitraum für das Produkt: V06TG: Kurier Taggleich; V06WZ: Kurier Wunschzeit

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\DeliveryTimeframe

Endorsement

Dieser Service wird verwendet, um die Vorgehensweise anzugeben, wenn der Empfänger nicht anzutreffen ist.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\Endorsement

Go Green

Klimaneutraler Versand

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\GoGreen

Identcheck

Servicekonfiguration für die Identitätsprüfung.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\IdentCheck

Ident

Servicekonfiguration für die Identitätsprüfung.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\IdentCheck\Ident

Individual Sender Requirement

Individuelle Absenderanforderungen für das Produkt: V06TG: Kurier Taggleich; V06WZ: Kurier Wunschzeit

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\IndividualSenderRequirement

Named Person Only

Service Nur benannte Person.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\NamedPersonOnly

Noneighbour Delivery

Keine Nachbarlieferung

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\NoNeighbourDelivery

Notice Of Non Deliverability

Service Hinweis auf Nichtzustellbarkeit.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\NoticeOfNonDeliverability

Packaging Return

Service für die Rücksendung von Paketen.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\PackagingReturn

Parcel Outlet Routing

Servicekonfiguration für ParcelOutletRouting. Details können eine E-Mail-Adresse sein, wenn nicht festgelegt, wird die Empfänger-E-Mail verwendet

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\ParcelOutletRouting

Perishables

DHL Kurier Verderbliche Ware

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\Perishables

Preferred Day

Wunsch-Tag

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\PreferredDay

Preferred Location

Wunschort

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\PreferredLocation

Preferred Neighbour

Service Wunsch-Nachbar

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\PreferredNeighbour

Preferred Time

Bevorzugte Lieferzeit für das Produkt: V01PAK: DHL PAKET; V06PAK: DHL PAKET TAGGLEICH

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\PreferredTime

Premium

Premium für die schnelle und sichere Lieferung internationaler Sendungen.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\Premium

Return Immediately

Service für sofortige Rücksendung bei erfolgloser Lieferung des Produkts: V06PAK: DHL PAKET TAGGLEICH

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\ReturnImmediately

Return Receipt

Service "Rücksendebestätigung".

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\ReturnReceipt

Shipment Handling

Versandabwicklung für Produkt: V06TG: Kurier Taggleich; V06WZ: Kurier Wunschzeit

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\ShipmentHandling

Visual Check Of Age

Visuelle Altersprüfung

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\Service\VisualCheckOfAge

Shipment Item

Enthält für jedes angegebene Paket Gewicht in kg, Länge in cm, Breite in cm und Höhe in cm.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\ShipmentDetails\ShipmentItem

Shipper

Enthält relevante Informationen zum Versender.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Shipper

Address

Die Adresse des Absenders der Sendung

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Shipper\Address

Origin

Land des Absenders

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Shipper\Address\Origin

Communication

Kommunikationsdaten des Sendungssenders

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Shipper\Communication

Name

Name der Adresse, die auf dem Versand-Etikett als Absender angegeben ist.

ChristophSchaeffer\Dhl\BusinessShipping\Resource\ShipmentOrder\Shipment\Shipper\Name

Piece Data

 ChristophSchaeffer\Dhl\BusinessShipping\Resource\Tracking\PieceData

Statusmeldungen

Statusobjekte, die zurückgegeben wurden. Diese Objekte finden Sie in src/Status. Diese Objekte werden nur in derGeschäftskundversand API benutzt.

Alle Statusklassen erben von AbstractStatus. Diese Klassen müssen nicht fürRequests instanziert werden, sondern werden automatisch der Response angefügt.

 ChristophSchaeffer\Dhl\BusinessShipping\Response\Shipping\Status\AbstractStatus

Success

Unknown Error

Weak Validation Error

City Not Known To Zip Code

Invalid Email Address

Invalid Packstation Number

Routing Code Not Possible

Street Not Found

Street Number Not Found

Unknown Packstation Number

Unknown Postfilial Number

Value Has Been Shortened

Zip Code Not Found

ZPL2 Label Format Automatically Changed

Hard Validation Error

Account Number Not Available

Cant Send From Shipper Country

COD Amount To High

Day Of Delivery In The Past

Empty City

Empty COD Amount

Empty Customs Value

Empty Date Of Birth Or Minimum Age

Empty Day Of Delivery

Empty Export Amount

Empty Export Position Description

Empty Export Type

Empty Export Type Description

Empty Export Weight

Empty Given Name

Empty Name 1

Empty Post Number

Empty Preferred Time

Empty Product

Empty Street Name

Empty Street Number

Empty Surname

Empty Weight

Empty Zip Code

Girth To Long

Height To High

Invalid Account Number

Invalid Account Number For Given Zip Code

Invalid Amount

Invalid Date

Invalid Export Type

Invalid IBAN

Invalid Minimum Age

Invalid Phone Number

Invalid Postfilial Number

Invalid Post Number

Invalid Shipment Date

Invalid Timeframe

Invalid Visual Check Of Age Type

Invalid Zip Code

Length To Long

Missing Dimension

Non Integer Given

Product Not Available Fro Receiver Country

Product Not Available For Shipper Country

Same Day Delivery Not Available For Receiver Address

Shipment Weight Is Equal To Net Weight

Timeframe Not Available For Receiver Address

Unknown Product

Weight Lower Than CN23 Form

Weight To High

Weight To Low

Width To Large

General Error

Authorization Failure

Authentification Failed

Password Expired

Insufficient Right

General Failure

Network Failure

Connection Failure

Network IO Read Failure

Network IO Write Failure

Incorrect Request

Invalid Parameter

Missing Parameter

Request Processing Failure

No Shipments For Manifest Found

Not Wellformed XML

Wrong Service Call

XML Schema Violation

QoS Failure

System Overload

Authentication Failure

Illegal Shipment State

Service Temporary Not Available

Unknown Shipment Number