DHL Client API

openapi: 3.2.0
info:
  title: Dhl Client API
  version: v2.3.3
  description: 'Operations tagged Client across 2 of this provider''s published API definitions: dhl-deutsche-post-hybrid-mail-shipments-e-post-post-parcel-germany-openapi.json, dhl-deutsche-post-hybrid-mail-shipments-e-post-post-parcel-germany-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.epost.docuguide.com
tags:
- name: Client
  description: 'Client-Bereich zum Anpassen von anmeldespezifischen Daten. Authentifizierung erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)'
paths:
  /api/Client/EMailRequest:
    post:
      tags:
      - Client
      summary: Anfrage SMS Code zur EMail Änderung
      description: 'Anfrage eines Sicherheitscodes per SMS, der zum ändern der EMail Adresse über ''SetMail'' verwendet wird. Die spätere zu übernehmende EMail Adresse wird hier bereits mitgegeben und gegen die in ''SetEMail'' übergebene EMail Adresse abgeglichen.


        Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header

        (Authorization: Bearer #token#)'
      operationId: Client_PostEMailRequest
      parameters:
      - name: email
        in: query
        description: Angabe der neuen EMail Adresse, für die der Code gültig sein soll
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      responses:
        '200':
          description: Erfolgreiche Codeanfrage. Es wird ein Sicherheitscode an die hinterlegte Rufnummer per SMS versendet, der 10 Minuten gültig ist.
        '401':
          description: Authorisierung ist fehlgeschlagen. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '400':
          description: Allgemeiner Fehler. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Zu häufige Abfragen innerhalb einer bestimmten Zeit. Die Mindestdauer zwischen den Abfragen darf 30 Sekunden nicht unterschreiten.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - JWT: []
    servers:
    - url: https://api.epost.docuguide.com
  /api/Client/SetEMail:
    post:
      tags:
      - Client
      summary: Änderung der EMail Adresse
      description: 'Änderung der EMail Adresse über einen zuvor anfgefragten Sicherheitscode per ''EMailRequest''. Die übergebene EMail Adresse wird gegen die zuvor im ''EMailRequest'' übergebene EMail Adresse auf Gleichheit geprüft.


        Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header

        (Authorization: Bearer #token#)'
      operationId: Client_PostSetEMail
      parameters:
      - name: email
        in: query
        description: Wiederholung der neuen EMail Adresse aus MailRequest
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: code
        in: query
        description: Änderungs-Code, der über EMailRequest angefordert wurde
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      responses:
        '200':
          description: Erfolgreiche Änderung der EMail Adresse. Es wurde eine Test EMail zur Bestätigung versendet.
        '401':
          description: Authorisierung ist fehlgeschlagen. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '400':
          description: Allgemeiner Fehler. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - JWT: []
    servers:
    - url: https://api.epost.docuguide.com
  /api/Client/MobileRequest:
    post:
      tags:
      - Client
      summary: Anfrage Sicherheitscode zur Rufnummer-Änderung
      description: 'Anfrage eines Sicherheitscodes per EMail, der zum ändern der Rufnummer über ''SetMobile'' verwendet wird. Die spätere zu übernehmende Rufnummer wird hier bereits mitgegeben und gegen die in ''SetMobile'' übergebene Rufnummer abgeglichen.


        Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header

        (Authorization: Bearer #token#)'
      operationId: Client_PostMobileRequest
      parameters:
      - name: mobile
        in: query
        description: Angabe der neuen Rufnummer, für die der Code gültig sein soll
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      responses:
        '200':
          description: Erfolgreiche Codeanfrage. Es wird ein Sicherheitscode an die hinterlegte EMail Adresse versendet, der 10 Minuten gültig ist.
        '401':
          description: Authorisierung ist fehlgeschlagen. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '400':
          description: Allgemeiner Fehler. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Zu häufige Abfragen innerhalb einer bestimmten Zeit. Die Mindestdauer zwischen den Abfragen darf 30 Sekunden nicht unterschreiten.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - JWT: []
    servers:
    - url: https://api.epost.docuguide.com
  /api/Client/SetMobile:
    post:
      tags:
      - Client
      summary: Änderung der Rufnummer
      description: 'Änderung der Rufnummer über einen zuvor anfgefragten Sicherheitscode per ''MobileRequest''. Die übergebene Rufnummer wird gegen die zuvor im ''MobileRequest'' übergebene Rufnummer auf Gleichheit geprüft.


        Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header

        (Authorization: Bearer #token#)'
      operationId: Client_PostSetMobile
      parameters:
      - name: mobile
        in: query
        description: Wiederholung der neuen Rufnummer aus MobileRequest
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: code
        in: query
        description: Änderungs-Code, der über MobileRequest angefordert wurde
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      responses:
        '200':
          description: Erfolgreiche Änderung der Rufnummer. Es wurde eine Test SMS zur Bestätigung versendet.
        '401':
          description: Authorisierung ist fehlgeschlagen. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '400':
          description: Allgemeiner Fehler. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - JWT: []
    servers:
    - url: https://api.epost.docuguide.com
  /api/Client/TestEMail:
    post:
      tags:
      - Client
      summary: Bestätigungsinformation an hinterlegte EMail Adresse
      description: 'An die im System hinterlegte EMail Adresse wird eine Test EMail als Bestätigungsinformation versendet.


        Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header

        (Authorization: Bearer #token#)'
      operationId: Client_PostTestEMail
      responses:
        '200':
          description: Es wurde eine Test EMail an die hinterlegte EMail Adresse versendet.
        '401':
          description: Authorisierung ist fehlgeschlagen. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '400':
          description: Allgemeiner Fehler. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Zu häufige Abfragen innerhalb einer bestimmten Zeit. Die Mindestdauer zwischen den Abfragen darf 30 Sekunden nicht unterschreiten.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - JWT: []
    servers:
    - url: https://api.epost.docuguide.com
  /api/Client/TestMobile:
    post:
      tags:
      - Client
      summary: Bestätigungsinformation an die hinterlegte Rufnummer
      description: 'An die im System hinterlegte Rufnummer wird eine Test SMS als Bestätigungsinformation versendet.


        Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header

        (Authorization: Bearer #token#)'
      operationId: Client_PostTestMobile
      responses:
        '200':
          description: Es wurde eine Test SMS an die hinterlegte Rufnummer versendet.
        '401':
          description: Authorisierung ist fehlgeschlagen. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '400':
          description: Allgemeiner Fehler. Gibt ein Error-Objekt zurück
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Zu häufige Abfragen innerhalb einer bestimmten Zeit. Die Mindestdauer zwischen den Abfragen darf 30 Sekunden nicht unterschreiten.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - JWT: []
    servers:
    - url: https://api.epost.docuguide.com
components:
  schemas:
    Error:
      type: object
      description: "Error-Objekt - Liefert Fehlercodes und Details bei entsprechenden Rückmeldungen über die API.\n\nAufstellung der Fehler-Codes pro Typ:\n\n\nError: Fehler aufgetreten, Handlungsbedarf, Verarbeitungsabbruch \n  \n  E001 - Ungültige Zugangsdaten - Bitte überprüfen Sie Ihre Anmeldedaten\n  \n  E002 - Ungültige Zugangsdaten - VendorSubID ungültig\n  \n  E003 - Zu viele SMS Anfragen - Es wurden innerhalb kurzer Zeit zu viele SMS-Codes angefordert. Die Anfrage über diese Kennung ist für 15 min blockiert.\n \n  E004 - Diese EKP wurde von der Deutsche Post AG gesperrt\n\n  E101 - Ungültiges Token - Abgelaufen\n  \n  E201 - Ungültige Statusabfrage - Es wurde keine Sendung über dieses Suchkriterium gefunden\n  \n  E203 - Adress-Metadaten: Abweichungen festgestellt {Platzhalter für Fehlerdetails}\n  \n  E301 - Kein PDF-Format erkannt\n  \n  E302 - Erkannte Verletzung des DVF Sperrbereich\n  \n  E303 - Maximale Dateigröße von 20 MB überschritten\n  \n  E304 - Maximale Seitenanzahl von 94 Seiten überschritten\n  \n  E305 - Ungültiger Ländercode: {Platzhalter für Fehlerdetails}\n  \n  E306 - Ungültiges Format der Empfängeradresse erkannt: {Platzhalter für Fehlerdetails}\n  \n  E307 - 1. Seite im Querformat eingeliefert - Dateiname: {Platzhalter für Fehlerdetails}\n  \n  E308 - Kein DinA4 Format - Dateiname: {Platzhalter für Fehlerdetails}\n  \n  E309 - Dublette bei eingelieferten Dateinamen erkannt - {Platzhalter für Fehlerdetails}\n  \n  E311 - Unzulässige Kombination: Einschreiben und Ausland\n  \n  E312 - Unzulässige Kombination: Dublex + Einschreiben\n  \n  E313 - Verletzung des Letter-Schemas: {Platzhalter für Fehlerdetails}\n  \n  E314 - Maximale Deckblatt-Dateigröße von 1 MB überschritten\n  \n  E315 - Fehler in Sendungsverarbeitung: {Platzhalter für Fehlerdetails}\n  \n  E316 - Fehler bei Sendungsupload: {Platzhalter für Fehlerdetails}\n  \n  E317 - Unzulässiges Einschreiben-Format in Feld RegisteredLetter: {Platzhalter für Fehlerdetails}  \n  \n  E318 - Ablehnung in Druckzentrum: {Platzhalter für Fehlerdetails}  \n  \n  E319 - EKP ist nicht für das Druckzentrum freigegeben. Ein Live-Versand ist aktuell noch nicht möglich.\n\n  E320 - Die maximal zulässige Menge an Testsendungen pro Tag wurde erreicht. Es sind heute keine weiteren Testsendungen möglich\n    \n  E321 - (Überholt) Es wurden nicht alle notwendigen Rückschein-Adressfelder für Einschreiben per Rückschein angegeben\n\n  E322 - Zu hohe Abfragefrequenz von Letter-Status Anfragen. Die Mindestdauer zwischen 2 Statusabfragen liegt bei 5 Sekunden. \n\n  E323 - Kein Inhalt im Empfängerbereich der PDF erkannt (Weiße Fläche) \n\n  E399 - Allgemeiner Fehler: {Platzhalter für Fehlerdetails} \n  \n  E501 - API-Status: Inaktiv {Platzhalter für Fehlerdetails}\n            \n  E601 - PlugIn Fehler: {Platzhalter für Fehlerdetails} \n  \n  E900 - Unspezifizierter Fehler: {Platzhalter für Fehlerdetails} \n\nWarnungen: Fehler aufgetreten, möglicher Handlungsbedarf, kein Verarbeitungsabbruch\n \n  W101 - PDF/A Konvertierungswarnungen: {Platzhalter für Details}\n  \n  W201 - Überschreitung Adressbereich: {Platzhalter für Details}\n  \n  W202 - Überschreitung Sperrfläche Links: Dieser Bereich wird im Druckzentrum geweißt \n  \n  W203 - Adress-Metadaten: Abweichungen festgestellt {Platzhalter für Fehlerdetails}\n  \n  W220 - Die angegeben Daten zum Rückschein von Einschreiben werden mit dem 01.10.2022 nur noch automatisch aus dem Sichtfenster des Briefes ermittelt. Dies gilt insbesondere für die Rücksendeadresse aus der im Sichtfenster ermittelbaren Absenderzeile. Mögliche explizite Angaben werden ab diesem Zeitpunkt nicht mehr verwendet.\n  \n  W301 - Senderadresse nicht vorhanden\n   \n  W501 - API-Status: Wartungsankündigung {Platzhalter für Details}\n\n  W601 - PlugIn Warnung: {Platzhalter für Details} \n\n\nInfos: Reine Information, kein Handlungsbedarf\n  \n  I101 - Zusatzoption: PDF -> PDFA Konvertierung\n  \n  I501 - API-Status: OK\n  \n  I601 - PlugIn Info: {Platzhalter für Details} \n  \n  I701 - Track And Trace Statusmeldung: {Platzhalter für Details}  \n  \n  I751 - Statusmeldung zum Zielgebiet: {Platzhalter für Details}\n  \n  "
      additionalProperties: false
      required:
      - level
      - code
      - description
      properties:
        level:
          type: string
          description: 'Art der Meldung: ''Info'',''Warning'',''Error'''
          minLength: 1
        code:
          type: string
          description: 'Eindeutige Kennung der Meldung (z.B. E101). '
          minLength: 1
        description:
          type: string
          description: Beschreibung der Meldung (z.B. 'Ungültige Sendungsnummer')
          minLength: 1
        date:
          type:
          - string
          - 'null'
          description: Zeitpunkt der Meldung
          format: date-time
  securitySchemes:
    JWT:
      type: apiKey
      description: "Bitte JWT eingeben, welcher durch die Login-Methode zurückgeliefert wurde: \n\n                    Bearer {JWT}.\n\n                    "
      name: Authorization
      in: header
x-refined-from:
- dhl-deutsche-post-hybrid-mail-shipments-e-post-post-parcel-germany-openapi.json
- dhl-deutsche-post-hybrid-mail-shipments-e-post-post-parcel-germany-openapi.json