DHL Paket DE Abholen (Post & Paket Deutschland)
v 1.0.3
Division: Post & Parcel Germany, Parcel

Am besten geeignet für

  • Kostenlose oder kostenpflichtige Paketabholungen über den Webservice buchen
Region: Deutschland
Used for: Abholen
Übersicht

Sie befinden sich auf der Dokumentations-Seite der DHL Paket DE Abholen API von Post & Paket Deutschland. In den folgenden Kapiteln bieten wir Ihnen:

Umfang

Kunden können:

  1. Abholaufträge an vordefinierten Standorten in Deutschland (Abholkosten sind im Paketpreis enthalten) erteilen
  2. Abholaufträge an einer beliebigen Adresse in Deutschland (zusätzliche Kosten pro Abholauftrag und -versuch) erteilen

Abholaufträge an vordefinierten Standorten erfordern eine entsprechende Konfiguration der Standorte in den DHL Systemen - diese müssen im Post & DHL Geschäftskundenportal (GKP) vorhanden sein. Bitte prüfen Sie alle möglichen Abholorte und Informationen, bevor Sie Abholaufträge erteilen.

Abholaufträge an beliebigen Adressen erfordern eine gültige Kundennummer/Abrechnungsnummer, die im GKP des Kunden konfiguriert ist. Falls der Service "Label" (DHL bringt das Versandetikett) genutzt wird, muss eine Kundennummer/Abrechnungsnummer im Verfahren 08 (DHL Retoure mit Abholung) im Kunden-GKP konfiguriert sein.

    Voraussetzungen

    Um Abholaufträge über die Pickup API zu erteilen, müssen die folgenden Voraussetzungen erfüllt sein:

    • einen Geschäftskundenvertrag mit DHL Paket Deutschland GmbH
    • einen GKP-Benutzer mit Zugriffsrechten für die Funktion "Abholung"
    • je nach Anwendungsfall mindestens ein vertraglich vereinbarter Abholort oder eine Kundennummer/Abrechnungsnummer, die für den GKP-Benutzer konfiguriert ist

    Benutzung der API

    Abholarten

    Abhängig von der Anzahl und Beschaffenheit der Pakete und dem Ort, an dem die Abholung erfolgen soll, können über die Pickup API verschiedene Dienstleistungen beauftragt werden

    1. Paketabholung an einem vordefinierten Ort
    2. Paketabholung an einer beliebigen Adresse
    Paketabholung an einem vordefinierten Ort (Kosten sind im Paketpreis enthalten)

    Erfordert mindestens einen Abholort für die verwendete Kundennummer (EKP), die mit DHL vereinbart und im DHL GKP-System konfiguriert ist.

    Abhängig von der Anzahl oder den Eigenschaften der Pakete erfolgt die Abholung als

    • Abholung auf Abruf durch den Zusteller (in der Regel bis zu 10 Pakete) 
    • Einmalige Abholung als geplante Abholtour (bei mehr als 10 Paketen/Tag oder sperrigen Gütern)
    Abholung auf Anfrage / bei Bedarf

    Für Kunden, die keine regelmäßige (tägliche) Abholung mit DHL vereinbart haben.

    • Abholort muss mit dem DHL-Vertrieb vereinbart sein
    • Muss bis 22 Uhr am Vortag der Abholung bestellt werden
    • Abholung Montag-Samstag möglich
    • Abholung durch den DHL-Zusteller auf der regulären Zustelltour
    • Max. 10 Pakete/Tag und Standort
    • Keine sperrigen Güter
    • Kosten sind im Paketpreis enthalten
    • Nicht kombinierbar mit zusätzlichen Abholservices (z.B. Labelprint by DHL)
    • In der Regel gibt es einen Abholscan pro Paket

    Falls mehr als 10 Abholaufträge pro Tag/Standort vorliegen, wird der Abholauftrag in einen einmaligen Abholauftrag umgewandelt.

    Einmalige Abholung

    Für Kunden, die keine regelmäßige (tägliche) Abholung durch DHL haben und eine Abholung für mehr als 10 Pakete, sperrige Güter oder ein höheres Volumen zusätzlich zu ihrer regulären Abholung bestellen möchten

    • Abholort ist mit DHL vereinbart
    • Abholaufträge sind für den nächsten Tag Montags bis Freitags bis 12 Uhr möglich
    • Ausführung muss von DHL bestätigt werden
    • Ausführung mit einer separaten Abholtour
    • Ausführung in der Regel Mo-Fr möglich, Samstag nicht in allen Regionen
    • Abholung von mehr als 10 Paketen pro Standort/Tag oder sperrigen Sendungen. Die Sendungen müssen in Rollkäfigen, Wechselbrücken oder auf Paletten sein.
    • Nicht kombinierbar mit zusätzlichen Abholservices (z.B. Labeldruck durch DHL)
    • Kein Abholscan für jedes Paket

    Die einmalige Abholung ist lediglich ein Abholauftrag an die DHL Transportkoordination - eine Abholung am gewünschten Abholtag wird nicht automatisch gebucht. Die DHL-Transportkoordination prüft die Verfügbarkeit und informiert den Kunden per E-Mail (an die im DHL-Geschäftskundenportal für den Standort definierte E-Mail-Adresse). Eine weitere bilaterale Kommunikation kann erforderlich sein.

    Paketabholung an jedem Ort in Deutschland (kostenpflichtige Einzelabholung)

    Erfordert mindestens eine für den Nutzer eingerichtete Kunden-/Abrechnungsnummer im Post & DHL Geschäftskundenportal.

    • Abholung von bis zu 10 Paketen oder sperrigen Gütern pro Standort und Tag
    • Abholaufträge für den nächsten Werktag müssen bis 22 Uhr erteilt werden 
    • Abholung von bis zu 10 Paketen oder Sperrgütern je Abholort und Ausführungstag
    • Abholung Mo-Fr möglich
    • Abholung durch den DHL Zusteller
    • Abholung an jeder codierbaren Adresse in Deutschland möglich
    • Kostenpflichtig, auch wenn die Abholung nicht erfolgreich ist
    • Zusätzlicher, kostenpflichtiger Service "Labelprint by DHL" möglich
      • DHL druckt und bringt das Transportetikett mit
      • Falls eine Abholung nicht möglich ist, wird das Transportlabel in den Briefkasten eingeworfen
      • Für die Buchung des Services ist eine Abrechnungsnummer im Verfahren 08 erforderlich
    • Stornierung für einen Auftrag am nächsten Tag bis 22 Uhr möglich
    • Abholscan für alle Pakete

    Adressen

    • Abholadresse: Adresse, bei der die Sendung abgeholt werden soll
    • Zieladresse (nur wenn Etikettendruck bestellt wird): Adresse, an die die Sendung zugestellt werden soll

    Für die folgenden Abholadressen können keine Abholungen bestellt werden:

    • Große Empfängeradressen ("Großempfänger")
    • Postämter
    • DHL Packstationen
    • DHL-Paketshops

    Bitte beachten Sie: Wenn eine Sendung in einem DHL Paketshop oder einer Packstation eingelagert ist, kann eine neue Zustellung über https://www.dhl.de/nochmal-zustellen   beauftragt werden.

    Abholtermine

    Individuelle Abholaufträge und Abholungen auf Abruf
    • können bis 22.00 Uhr für den folgenden Werktag bestellt und storniert werden
    • können bis zu 14 Tage im Voraus bestellt werden
    • können Montags bis Samstags von 8:00 bis 19:00 Uhr erfüllt werden
    • die Buchung von Zeitfenstern ist nicht möglich
    • der Abholzeitrahmen wird erst am Abholtag bekannt gegeben
    • Wird im Abholauftrag eine E-Mail-Adresse angegeben, wird der Abholzeitraum am Abholtag per E-Mail bekannt gegeben
    Einmalige Abholungen
    • können Montags bis Freitags bis 12 Uhr für den nächsten Werktag bestellt werden (Ausnahme: Samstag)
    • Bestellungen für Samstage müssen am Donnerstag bis 12 Uhr aufgegeben werden, falls eine Abholung am Samstag im PLZ-Gebiet möglich ist
    • die Verfügbarkeit wird von der DHL Transportkoordination geprüft - der Kunde wird über das Ergebnis informiert
    • kann bis zu 30 Tage im Voraus bestellt werden
    • Abholzeitfenster sind nicht möglich
    • Abholung in der Regel vormittags, Öffnungszeiten werden nach Möglichkeit berücksichtigt

    Hinweis:

    Es ist möglich, in der API-Anfrage "asap" als Abholtag anzugeben. In diesem Fall wird ein Abholauftrag für den nächstmöglichen Tag erteilt. Dieser Tag wird in der API-Antwort zurück geliefert.

    Services

    Serviceleistungen sind nur bei individuellen Abholaufträgen an jeder Adresse möglich.

    Sperrgut

    Für die Abholung von Sperrgut ist das Feld "Bemerkung zum Sperrgut" ein Pflichtfeld und muss ausgefüllt werden.

    Bitte beachten Sie: Die Definition von Sperrgut ist in den FAQs aufgeführt. Weitere Details zu den Geschäftskundenprodukten und -services von DHL Paket finden Sie unter: www.dhl.de

    Etikettendruck

    Das Versandetikett kann über den Etikettendruckservice von DHL erstellt werden. Hierfür muss neben der Abholadresse auch eine gültige deutsche Zieladresse angegeben werden.

    Sendungsnummer/Tracking-ID

    Wenn der Etikettendruck durch DHL nicht beauftragt wurde, muss die Sendung für eine erfolgreiche Abholung bereits ein gültiges Versandetikett haben.

    Wird bei der Auftragserteilung keine Sendungsnummer angegeben, wird automatisch eine Sendungsnummer aus dem zentralen Nummernkreis von DHL verwendet.

    Bitte beachten Sie:

    • Geben Sie bei der Beauftragung von Abholungen immer die Sendungsnummer des Pakets an; dies erleichtert die Identifizierung der abzuholenden Sendung
    • Bei Nutzung des Services "Labelprint by DHL" muss die Sendungsnummer aus einem von DHL zur Verfügung gestellten Bereich stammen und vom Typ Identcode (12-stellige Tracking-ID) sein

    Weitere Informationen und Empfehlungen

    • Ein DHL-Produkt kann mehrere Abrechnungsnummern oder Teilnahmen haben, z.B. zur Unterscheidung von Standorten, Kunden oder Aktionen. Wir empfehlen Shop-Software-Anbietern und Marktplätzen, in diesen Fällen mehrere Felder für die Eingabe von Abrechnungsnummern oder Teilnahmen einzurichten.
    • Wenn Sie als Marktplatz- oder Shopsoftware-Anbieter nicht alle DHL Produkte und Services über die API anbinden möchten, empfehlen wir Ihnen, zusätzlich einen direkten Aufruflink zum Post & DHL Geschäftskundenportal zu integrieren, den Sie über die Funktion "Abholung" aufrufen können.

     

    Anwenderhandbuch

    Nachfolgend stellen wir Ihnen eine Übersicht bereit, wie Sie Zugang zu der API erhalten.

    • technische Details zu den API-Aufrufen finden Sie im Kapitel: "API-Spezifikation".
    • Weitere Hinweise zur Benutzung der API finden Sie in den Kapiteln "Support" und "FAQ".

    Wenn Sie die vorherige Abholen-API implementiert haben, beachten Sie bitte die Änderungen unter Release Notes.

     

    Zugang erhalten

    Wie erfolgt die Registrierung ihrer Abholen-API und wie bekommen Sie die Zugangsdaten:

    1. Klicken Sie auf die Schaltfläche "Zugang erhalten" oben auf dieser Seite und das Formular "App erstellen" wird geöffnet, wobei die Sandbox-Umgebung der API vorausgewählt ist.
      • Falls erforderlich, ändern Sie die Auswahl in "DHL Paket DE Abholen API".
      • Wenn Sie das Formular ausgefüllt haben, klicken Sie auf die Schaltfläche "App erstellen".
      • Unter Meine Apps finden Sie nun ihre App.
      • Klicken Sie auf dem Bildschirm Meine Apps auf den Namen Ihrer App. Der Bildschirm mit Details erscheint.
      • Wenn Sie Zugang zu mehr als einer API haben, klicken Sie auf den Namen der relevanten API.
        Hinweis: Die APIs sind im Bereich "Zugangsdaten" aufgelistet.
      • Klicken Sie auf den Link Anzeige unter den Sternchen, die die Zugangsdaten verdecken. Der Benutzer-Schlüssel wird angezeigt. 

      Jeder Aufruf der API erfordert einen Benutzerschlüssel. Dieser Schlüssel muss im Request-Header angegeben werden (DHL API-Key).

      Bitte beachten Sie, dass für die Sandbox- bzw. Produktionsumgebung unterschiedliche Schlüssel erforderlich sind. Beide können über das oben beschriebene Verfahren angefordert und aus dem Abschnitt API-Anmeldeinformationen kopiert werden.

      Alternativ zu "Zugang erhalten" können Sie auf der Portal-Website zu Meine Apps gehen und auf die Schaltfläche + App erstellen:

      • Das Formular "App erstellen" erscheint.
      • Füllen Sie das Formular "App erstellen" aus und wählen Sie "Abholen API".
        • In der Liste finden Sie zwei Einträge der API: einen für die Sandbox, einen für die Produktion.

      Authentifizierung

      Sandbox

      Für die Erstellung von Abholaufträgen in der Sandbox haben Sie die Möglichkeit, unsere Testsuite mit den folgenden Benutzerdaten zu verwenden:

      • Benutzername: 2222222222_abr_0801
      • PasswortS8PjmLB!s2vrzWV3o
      • Der oben angegebene Benutzername und das Passwort müssen über die Basisauthentifizierung (Basic Auth) bereitgestellt werden.

      Sie können die "Open API Spezification" hier herunterladen: 

      Zur Erstellung von Testabholaufträgen verwenden sie die folgenden Kundendaten:

      • Abrechnungsnummer für einzelne Abholaufträge: 22222222220801
      • Kundennummer für Abholung bei Aufträgen und Einzelabholungen: 2222222222

      Produktion

      Um die "Abholen API" nutzen zu können, muss zunächst die Anwendung so erstellt werden, das sie die API im Produktionsmodus enthält. Darüber hinaus müssen folgende Zugangsdaten für den Webservice (API) angegeben werden:

      • Benutzer: "Benutzer aus dem Post & DHL Geschäftskundenportal". (Der Benutzer muss für Abholungen autorisiert sein!).
      • Passwort: "Passwort des obigen Benutzers".
      • Die Werte für Benutzer und Passwort Ihres aktiven Geschäftskunden-Nutzers müssen über die Basisauthentifizierung (Basic Auth) bereitgestellt werden.

      Bitte beachten Sie bei der Auswahl des jeweiligen Benutzers auch die Dauer der Gültigkeit der Passwörter:

      • die Passwortgültigkeit eines "Benutzers" beträgt" 90 Tage
      • die Passwortgültigkeit eines "Systembenutzers" beträgt" 365 Tage

      Es ist nicht möglich, sich mit einem "Systembenutzer" am Post & DHL Geschäftskundenportal anzumelden.

      Voraussetzungen für die Produktion

      • Ein gültiger Geschäftskundenvertrag mit DHL Paket
      • Ein gültiger Benutzer für das Post & DHL Geschäftskundenportal (GKP) mit Zugriffsrechten für die Funktion "Abholung"
      • Je nach Anwendungsfall muss mindestens ein vereinbarter Abholort oder eine konfigurierte Abrechnungsnummer für den GKP-Benutzer angelegt sein

      Bitte geben Sie den Benutzernamen des Post & DHL Geschäftskundenportals nur in Kleinbuchstaben an.

      Hinweis:

      • Für Abholungen an einem beliebigen Ort: Im GKP können Sie nachsehen, welche Abrechnungsnummern / Kundennummern für einen Benutzer verfügbar sind
      • Im Menü zuerst die persönlichen Daten aufrufen (1.), dann "Abholen" auswählen (2.)

      Voraussetzung Prod_23_0

       

      Voraussetzung Prod_23_1

       

      Bitte beachten:

      • Abholaufträge können nur für deutsche Adressen erteilt werden
      • Abholkosten für vereinbarte Standorte sind im Paketpreis enthalten, müssen also im Voraus vereinbart werden
      • Abholaufträge für beliebige Standorte (nicht im Voraus vereinbart) werden auch dann in Rechnung gestellt, wenn sie nicht erfolgreich sind.

      Wir empfehlen:

      • Eine Abrechnungsnummer/Kundenummer im Verfahren 08 für Abholungen an einer beliebigen Adresse. Damit wird die Möglichkeit geschaffen, den Service "Labelprint by DHL" zu nutzen.
      • Einen GKP-Benutzer mit der Rolle "Systembenutzer" - für solche Benutzer ist eine Passwortänderung nur einmal im Jahr erforderlich (persönlicher Benutzer: 3 Monate).
      • Für Abholungen an vorher vereinbarten Orten: Bitte prüfen Sie alle verfügbaren Abholorte und die Informationen zu diesen im GKP. Hierfür ist ein GKP-Benutzer mit Zugriffsrechten für "Abholung" und zusätzlich für "Einstellungen" erforderlich.

      Voraussetzung Prod_23_2

       

      Fehler- und Status-Codes

      In der folgenden Tabelle sind die möglichen Statuscodes zur Information der Ausführung von Abholungen aufgeführt:

      Fehlercodes: 
      Code Beschreibung Empfehlung
      1 Interner Fehler Auftrag kann zurzeit nicht bearbeitet werden. Bitte DHL kontaktieren.
      2 Autorisierung fehlgeschlagen Bitte Post & DHL Geschäftskundenportal Benutzernamen und/oder Passwort prüfen.
      3 Ungültiger Request Bitte Request Struktur prüfen.
      4 Fehlende Pflichtangabe Bitte alle Pflichtangaben ergänzen.
      5

      Ungültige Angabe

      Bitte Auftragsdaten prüfen.

      6 Abholadresse nicht leitcodierbar Bitte Abholadresse per PLZ-Suche der Deutsche Post Direkt www.postdirekt.de/plzserver auf Gültigkeit
      7 Empfängeradresse nicht leitcodierbar Bitte Empfängeradresse per PLZ-Suche der Deutsche Post Direkt www.postdirekt.de/plzserver auf Gültigkeit prüfen.
      8 Anzahl Sendungen für Abholdatum oder Abholadresse überschritten Bitte Anzahl abzuholender Sendungen oder Abholdatum anpassen.
      9 Erforderliche Anzahl an Sendungen für den Ausführungstag nicht erreicht Bitte anderes Abholdatum wählen.
      10 Abholdatum ungültig Bitte Abholdatum prüfen.
      11 Abholdatum nach cut-off, in der Vergangenheit oder zu weit in der Zukunft Bitte anderes Abholdatum wählen.
      12 Abholdatum ist Feiertag oder Abholungen können an diesem Tag nicht ausführt werden Bitte anderes Abholdatum wählen.
      13 Abholdatum ist ein Sonntag Bitte anderes Abholdatum wählen.
      14 E-Mailadresse nicht akzeptiert Bitte E-Mailadresse auf Gültigkeit prüfen.
      15 Abrechnungsnummer fehlt Bitte Kundenkonfiguration für die Funktion Abholen im Post & DHL  Geschäftskundenportal prüfen, mindestens eine Abrechnungsnummer wird für diese Auftragsart benötigt.
      16 Abrechnungsnummer nicht zulässig Diese Abrechnungsnummer ist in der Kundenkonfiguration vom Post & DHL Geschäftskundenportal nicht für die Funktion Abholen konfiguriert.
      17 Abholstelle unbekannt Bitte Abholort prüfen oder kostenpflichtige Abholung beauftragen.
      18 Am Abholdatum wird bereits eine Regelabholung von DHL am Abholort ausgeführt Bitte Abholdatum prüfen.
      19 Abholauftrag kann am Abholort nicht ausgeführt werden Bitte Abholort prüfen oder kostenpflichtige Abholung beauftragen.

       

      Statuscodes: 
      Code Beschreibung
      200 OK - Die Anfrage wurde erfolgreich bearbeitet.
      201 Erstellt - Die Anfrage wurde erfolgreich bearbeitet und hat zur Erstellung einer oder mehrerer neuer Ressourcen geführt
      400 Bad Request - Die Anfrage konnte vom Server aufgrund einer fehlerhaften Syntax nicht verstanden werden.
      401 Unauthorized - Der Client konnte nicht authentifiziert werden, da der Anfrage der erforderliche HTTP-Header fehlt oder die Anmeldeinformationen falsch sind.
      403 Verboten - Der Client wurde erfolgreich authentifiziert, konnte aber für die betreffende Anfrage nicht autorisiert werden.
      404 Nicht gefunden.
      409 Konflikt.
      422 Unverarb.eitbare Entität
      429 Too Many Requests - Der Aufrufer hat sein Anfragekontingent überschritten.
      500 Interner Serverfehler.
      503 Service nicht verfügbar.

       

      Postman Collection

      Wir empfehlen die Verwendung der Software Postman zum testen der API. Postman ist eine Kollaborations Platform für API Entwicklung und Testing. Post & DHL Deutschland stellt Ihnen eine umfangreiche Postman Test Collection für jede API zur Verfügung. Folgen sie der Anleitung in diesem Kapitel um die Test Collection in Ihren Postman Workspace zu importieren und schnell mit der Integration unserer API zu beginnen.

      Die folgenden Schritte müssen zuvor durchgeführt werden, um die API zu testen:

      Sie müssen den Zugang zur Sandbox-Umgebung beantragen um einen API-Schlüssel (dhl-api-key) zu erhalten.
      Eine ausführliche Anleitung dazu finden Sie unter Zugang erhalten.

      Einrichten der Postman Test Collection

      • Laden sie die Postman Test Collection im Download Bereich herunter.
      • Importieren Sie die Postman Test Kollektion (siehe offizielle Dokumentation der Postman-Lernplattform) 
      • Ersetzen Sie den Wert der Variable "dhl-api-key" durch Ihren persönlichen API-Schlüssel

      Bitte beachten Sie auch unsere Schritt-für-Schritt Anleitung zur Benutzung der Postman Test Collection.

       

      Anwendungsfälle

      Übersicht der Anwendungsfälle

      • Abholauftrag
      • Abholauftrag löschen
      • Abholauftrags-Details und -Status abrufen

      Beispiel Aufrufe

      Hinweis: Diese Beispiel Aufrufe decken nur die grundlegenden Operationen der API ab. Ausführliche Beispiel Aufrufe für alle Produkte und Services finden Sie in unserer Postman Testsuite, weitere Erläuterungen im Kapitel wie testet man die API.

      Abholauftrag

      Erteilt einen Paketabholauftrag für eine Reihe von Paketen.

      POST /parcel/de/transportation/pickup/v1/orders?validate=true HTTP/1.1
      Host: https:api-sandbox.dhl.com
      dhl-api-key: <API Key>
      Content-Length: 1380
      Content-Type: application/json
      
      {
        "customerDetails": {
          "billingNumber": "22222222220801"
        },
        "pickupLocation": {
          "pickupAddress": {
            "name1": "Deutsche Post DHL Group",
            "name2": "Lieferanteneingang",
            "addressStreet": "Charles-de-Gaulle-Straße",
            "addressHouse": "20",
            "postalCode": "53113",
            "city": "Bonn",
            "country": "DE"
          },
          "businessHours": [
            {
              "timeFrom": "09:00",
              "timeUntil": "12:00"
            },
            {
              "timeFrom": "13:30",
              "timeUntil": "17:30"
            }
          ]
        },
        "contactPerson": {
          "name": "Max Mustermann",
          "phone": "09999 100111820",
          "email": "max@post.de"
        },
        "pickupDetails": {
          "pickupDate": {
            "type": "Date",
            "value": "2099-04-21"
          },
          "emailNotification": "abholstelle@post.de"
        },
        "shipmentDetails": {
          "shipments": [
            {
              "transportationType": "PAKET",
              "size": "M",
              "pickupServices": {
                "printLabel": {
                  "receiverAddress": {
                    "name1": "Max Mustermann",
                    "name2": "z. Hd. Frau Mustermann",
                    "addressStreet": "Platz der Deutschen Post",
                    "addressHouse": 1,
                    "postalCode": "53113",
                    "city": "Bonn",
                    "country": "DE"
                  }
                }
              },
              "customerReference": "987654321"
            }
          ]
        }
      }
      

      Abholauftrag löschen

      DELETE /parcel/de/transportation/pickup/v1/orders?orderID=<string> HTTP/1.1
      Host: https://api-sandbox.dhl.com
      dhl-api-key: <API Key>
      Content-Type: application/json
      
      {
        "confirmedCancellations": [
          {
            "orderID": "stringstringstringstringstringst",
            "orderState": "string",
            "message": "string"
          }
        ],
        "failedCancellations": [
          {
            "orderID": "stringstringstringstringstringst",
            "orderState": "string",
            "message": "string"
          }
        ]
      }

      Abholauftrags-Details und -Status abrufen

      GET /parcel/de/transportation/pickup/v1/orders?orderID=<string>&pickupDate=<string>&pickupName1=<string>&pickupStreetName=<string>&pickupHouseNumber=<string>&pickupPostalCode=<string>&pickupCity=<string> HTTP/1.1
      Host: https://api-sandbox.dhl.com
      dhl-api-key: <API Key>
      Content-Type: application/json
      
      
      [
        {
          "orderDetails": {
            "orderID": "stringstringstringstringstringst",
            "orderState": "string"
          },
          "customerDetails": {
            "accountNumber": "1805893028",
            "billingNumber": "336576686072vv"
          },
          "pickupLocation": {
            "pickupAddress": {
              "name1": "string",
              "name2": "string",
              "addressStreet": "string",
              "addressHouse": "string",
              "postalCode": "string",
              "city": "string",
              "country": "st",
              "state": "string"
            },
            "businessHours": [
              {
                "timeFrom": "77:79",
                "timeUntil": "80:35"
              }
            ]
          },
          "contactPerson": {
            "name": "string",
            "phone": "string",
            "email": "string"
          },
          "pickupDetails": {
            "pickupDate": {
              "value": "8414-21-06",
              "type": "string"
            },
            "emailNotification": "string",
            "totalWeight": {"uom":"kg","value":50},
            "comment": "string"
          },
          "shipmentDetails": {
            "shipments": [
              {
                "shipment": {
                  "transportationType": "PAKET",
                  "replacement": true,
                  "shipmentNumber": "string",
                  "size": "S",
                  "pickupServices": {
                    "bulkyGood": {
                      "comment": "string"
                    },
                    "printLabel": {
                      "receiverAddress": {
                        "name1": "string",
                        "name2": "string",
                        "addressStreet": "string",
                        "addressHouse": "string",
                        "postalCode": "string",
                        "city": "string",
                        "country": "st",
                        "state": "string"
                      }
                    }
                  },
                  "customerReference": "string"
                },
                "shipmentState": {
                  "state": "string",
                  "responseTime": "2659-15-24T04:29:11",
                  "actualPickupDate": "3175-22-19"
                },
                "orderDate": "6729-62-06T73:61:29"
              }
            ]
          },
          "feedback": "string",
          "pickupTimeFrame": {
            "timeFrom": "60:30",
            "timeUntil": "23:91"
          }
        }
      ]
      FAQs
      Wie viele einzelne Abholaufträge sind pro Abholort zulässig?

      Pro Abholort können maximal 10 Sendungen pro Tag bestellt werden.
      Wenn mehr als 10 Sendungen abgeholt werden sollen, können Sie die Auftragsart "Einmalige Abholung" verwenden.

      Was bedeuten die Größen S, M, L?

      Die Größen beziehen sich auf die längste Seite eines Paketes

      • Bis zu 30 cm:   S
      • Bis zu 60 cm:   M
      • Bis zu 120 cm: L
      Wann gilt ein Paket als Sperrgut?

      Als Sperrgut gelten Pakete, die

      • in Quaderform die Paketmaße von 120 x 60 x 60 cm überschreiten,
      • in Rollenform mehr als 5 kg wiegen oder eine Länge von 120 cm oder
        einen Durchmesser von 15 cm überschreiten,
      • weder rechteckig noch rollenförmig sind,
      • abstehende Teile oder lose Bänder aufweisen oder
      • keine feste Außenverpackung aus Wellpappe, Vollpappe oder Papier haben

      Maximale Abmessungen für sperrige Güter

      • Quaderform: bis zu einer Länge von 200 cm, bis zu einem Gurtmaß  
        (= Länge + 2x Breite + 2x Höhe) von 360 cm
      Was bedeuten die Codes für den Ausführungsstatus der einzelnen Abholungen?

      Abgeholt
      10: Abholung erfolgreich
      11: Abholung erfolgreich (ohne Sendungsnummer)
      12: Abholung erfolgreich (am gewünschten Ort)
      13: Abholung erfolgreich (am gewünschten Ort ohne Sendungsnummer)

      Nicht abgeholt
      30: Nicht angetroffen
      31: Keine Sendung zur Abholung verfügbar
      32: Unbekannt (Adresse, Kunde)
      33: Sendung entspricht nicht den Bestimmungen und Bedingungen
      34: Sendung nicht ausreichend frankiert
      35: Sendung nicht versandfertig
      36: Sendung bereits aufgegeben

      Verspätung
      37: Die Abholung erfolgt aus betrieblichen Gründen am nächsten Arbeitstag

      Support

      Sie erhalten Unterstützung in unserem Help Center . Sie können ein Ticket eröffnen, um direkte Unterstützung durch den DHL Support zu bekommen. Bitte beschreiben sie ihre Anfrage so detailliert wie möglich und senden sie uns nachvollziehbare Auszüge der Webservice Kommunikation. Wir versuchen ihnen so schnell wie möglich in den folgenden Zeiten mit ihrem Problem zu helfen:

      IT Kundensupport & Integration Paket

      Geschäftszeiten: Mo - Fr von 8.00 - 16 Uhr 

      Gesetzliche Bestimmungen
      Besondere Bedingungen für die Nutzung und/oder den Zugang zur "DHL Paket DE Abholen API"

      Um sich für die Nutzung der DHL Paket DE Abholen API zu registrieren, müssen Sie und/oder die juristische Person, die Sie zu vertreten berechtigt sind (im Folgenden "Sie"/"Ihr"), über ein aktives Kundenkonto im Post & DHL Geschäftskundenportal (im Folgenden "DHL") verfügen. Ein API-Produktivschlüssel und die Zugangsdaten werden Ihnen vorbehaltlich einer erfolgreichen Validierung Ihrer Anmeldedaten durch DHL zur Verfügung gestellt. Wenn Sie einen externen Entwickler oder einen anderen IT-Dienstleister damit beauftragen, Ihre Anwendung zu entwickeln, oder einen anderen Dritten damit beauftragen, in Ihrem Namen auf die DHL Paket DE Abholen API zuzugreifen und/oder diese zu nutzen, haften Sie in vollem Umfang für alle Handlungen oder Unterlassungen dieser Dritten im Zusammenhang mit dem Zugriff auf und/oder der Nutzung der DHL Paket DE Abholen API.

      Diese rechtlichen Hinweise ersetzen und/oder ändern nicht die geltenden "Allgemeinen Geschäftsbedingungen von DHL Paket für Geschäftskunden", abrufbar unter https://www.dhl.de/de/geschaeftskunden/paket/rund-um-den-versand/agb.html, oder andere Versanddienstleistungsverträge, die für Ihre Paketsendungen gelten.

      Falls Sie als Drittsoftwareanbieter, Verkäufer, Marktplatzbetreiber oder anderweitig als Handelsvertreter im Auftrag von DHL und/oder den mit ihr verbundenen Unternehmen handeln, d.h. mit Zustimmung von DHL und/oder den mit ihr verbundenen Unternehmen, sind Sie verpflichtet, den Kunden (d.h. den jeweiligen Absender der Sendungen) auf die geltenden Versandbedingungen hinzuweisen.

      Sie dürfen die Services und/oder Daten, die Sie über die DHL Paket DE Abholen API erhalten, nur für die rechtmäßigen vertraglichen Zwecke und nur im Zusammenhang mit Ihren bzw. den DHL-Sendungen der Kunden nutzen.

      Für die Nutzung und/oder den Zugriff auf die DHL Paket DE Abholen API gelten die folgenden Voraussetzungen und/oder Einschränkungen:

      • Gültige Abrechnungsnummer
      • Gültiger Nutzername des Post & DHL Geschäftskundenportals (GKP)
      • Gültiges Passwort

      Bitte beachten Sie die folgenden zusätzlichen Hinweise und Empfehlungen:

      Die o.g. Bedingungen müssen für jeden teilnehmenden Händler (etwa auf einem Marktplatz oder im Rahmen einer Shopsoftware) konfigurierbar sein und eine entsprechende Dokumentation für den Versandkunden erstellt werden.

      1.0.3
      05.Jan.2023

      Erstes Release der neu erstellten DHL Paket DE Abholen API mit folgenden Änderungen im Vergleich zur alten API:

      Neue Services und Funktionen:

      • Abfrage der verfügbaren Abholorte für Ihren Benutzer bei Verwendung von /locations

      Wesentliche Änderungen im Vergleich zur ursprünglichen Pickup-API auf developer.dhl.de

      Aufgrund eines API-Modernisierungs- und Harmonisierungsprogramms werden die Post- und Paket-APIs einander immer ähnlicher.
      Wenn Sie die bisherige Paketabholen-API implementiert haben, beachten Sie bitte die folgenden Änderungen für die neue Version:

      • Änderungen im Requests
        • Umbenennung der Request-Business-Objekte
          • postCode in postalCode
          • Name3 wird gestrichen 
          • Zusatzzeichen in Hausnummern entfallen
          • CustomerReference wird auf 20 Zeichen gekürzt
          • streetName zu addressStreet
          • Hausnummer zu addressHouse
          • countryIso2Code zu country
          • totalWeight zu Objeck überarbeitet, Beispiel: {"uom": "kg", "wert": 20}
          • receiverAddress zu consignee
        • Umbenennung der Response-Business-Objekte
          • shipmentNumber zushipmentNo
      • Konsolidierung der GET-Methoden