Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Dhl Plug In API
version: v2.3.3
description: 'Operations tagged PlugIn 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: PlugIn
description: Ausschließlicher Dokumentationsbereich für anwendbare PlugIns, ohne jegliche Funktion. Die im Letter-Model (PlugInList) angegeben dynamischen Plugins sind je PlugIn mit ihrer PlugInList-Signatur als Methode dokumentiert. Die jeweiligen relevanten Schemas (Übergabe und Response) werden dort als ReturnCodes dokumentiert.
paths:
/api/PlugIn/Automover:
get:
tags:
- PlugIn
summary: Dokumentation des Automover Plugin
description: 'Die inhaltliche Dokumentation des Plugin mit seinen Parametern und Response Elementen ist im jeweiligen aufgeführten Schema zu finden.
Inhalt des Response-Bereich (Code):
Code 110: die Übergabesignatur des Automover PlugIn als Teil der PlugIn Liste im Letter Schemas
Code 111: Response des Automover PlugIn als Teil der PlugInFeedback Liste im LetterStatus Schemas
Bitte beachten Sie auch den FAQ-Bereich für zusätzliche Informationen zu diesem PlugIn.
Beispiel-Aufruf innerhalb der PlugInList des Letter Models:
"plugInList": [
{
"plugInName": "Automover",
"plugInModel": {
"useAutomover": true
}
}
]'
operationId: PlugIn_PlugInExample
responses:
'110':
description: Automover-PlugInModel, welches im LetterStatus übergeben werden kann
content:
application/json:
schema:
$ref: '#/components/schemas/Automover'
'111':
description: Automover-PlugInFeedbackModel, welches im LetterStatus zurückgemeldet werden kann
content:
application/json:
schema:
$ref: '#/components/schemas/AutomoverFeedback'
security:
- JWT: []
servers:
- url: https://api.epost.docuguide.com
/api/PlugIn/UploadManagement:
get:
tags:
- PlugIn
summary: Dokumentation des UploadManagement Plugin
description: 'Die inhaltliche Dokumentation des Plugin mit seinen Parametern und Response Elementen ist im jeweiligen aufgeführten Schema zu finden.
Inhalt des Response-Bereich (Code):
Code 110: die Übergabesignatur des UploadManagement PlugIn als Teil der PlugIn Liste im Letter Schemas
Code 111: Response des UploadManagement PlugIn als Teil der PlugInFeedback Liste im LetterStatus Schemas
Bitte beachten Sie auch den FAQ-Bereich für zusätzliche Informationen zu diesem PlugIn.
Beispiel-Aufruf innerhalb der PlugInList des Letter Models
(Mindestmengen-Versand und spätester Versand bei nicht erreichen am Freitag):
"plugInList": [
{
"plugInName": "UploadManagement",
"plugInModel": {
"UseMinimumQuantity": true,
"DueDayOfWeek": "Fr"
}
}
]'
operationId: PlugIn_PlugInExample2
responses:
'110':
description: UploadManagement-PlugInModel, welches im LetterStatus übergeben werden kann
content:
application/json:
schema:
$ref: '#/components/schemas/UploadManagement'
'111':
description: UploadManagement-PlugInFeedbackModel, welches im LetterStatus zurückgemeldet werden kann
content:
application/json:
schema:
$ref: '#/components/schemas/UploadManagementFeedback'
security:
- JWT: []
servers:
- url: https://api.epost.docuguide.com
/api/PlugIn/PremiumAdress:
get:
tags:
- PlugIn
summary: Dokumentation des PremiumAdress Plugin
description: 'Die inhaltliche Dokumentation des Plugin mit seinen Parametern und Response Elementen ist im jeweiligen aufgeführten Schema zu finden.
Inhalt des Response-Bereich (Code):
Code 110: die Übergabesignatur des PremiumAdress PlugIn als Teil der PlugIn Liste im Letter Schemas
Code 111: Response des PremiumAdress PlugIn als Teil der PlugInFeedback Liste im LetterStatus Schemas
Beispiel-Aufruf innerhalb der PlugInList des Letter Models
"plugInList": [
{
"plugInName": "PremiumAdress",
"plugInModel":
{
"productVariants": "basis"
}
}
]'
operationId: PlugIn_PlugInExample5
responses:
'110':
description: PremiumAdress-PlugInModel, welches im LetterStatus übergeben werden kann
content:
application/json:
schema:
$ref: '#/components/schemas/PremiumAdress'
'111':
description: PremiumAdress-PlugInFeedbackModel, welches im LetterStatus zurückgemeldet werden kann
content:
application/json:
schema:
$ref: '#/components/schemas/PremiumAdressFeedback'
security:
- JWT: []
servers:
- url: https://api.epost.docuguide.com
components:
schemas:
UploadManagementFeedback:
type: object
description: UploadManagementFeedback - Liefert PlugIn Informationen zum UploadManagement innerhalb eines LetterStatus
additionalProperties: false
required:
- useMinimumQuantity
properties:
useMinimumQuantity:
type: boolean
description: "Mindestmengen-Option:\n Info, ob die Mindestmengen-Option (true) oder lediglich ein Terminversand (false) verwendet wurde\n "
dueDays:
type:
- integer
- 'null'
description: "Stichtag-Option für Sendungsupload\n \n Angabe, in wie viel Tagen ab erfolgreicher Sendungsverarbeitung (Status 2 - ProcessedDate) der Stichtag erreicht ist.\n Diese Termin-Option darf nicht weiter als 31 Tage in der Zukunft liegen.\n Standard-Vorgabewert, sofern keine Stichtag-Option angegeben wurde: 1\n \n "
format: int32
dueDate:
type:
- string
- 'null'
description: "Stichtag-Optionen für Sendungsupload\n \n Angabe, zu welchen Datum (Zeitanteil wird ignoriert) der Stichtag für diese Sendung erreicht ist.\n Das Datum muss mindestens 1 Tag in der Zukunft liegen.\n Diese Termin-Option darf nicht weiter als 31 Tage in der Zukunft liegen.\n \n "
format: date-time
dueDayofWeek:
type:
- string
- 'null'
description: "Stichtag-Optionen für Sendungsupload\n \n Angabe, an welchem Wochentag der Stichtag für diese Sendung erreicht ist.\n \n Mögliche Angaben: Mo, Di, Mi, Do, Fr, Sa, So\n Es darf nur ein Wochentag-Kürzel angeben werden. Eine Übergabe mehrerer Wochentage ist nicht möglich.\n Entspricht die Angabe dem Wochentag der Sendungsverarbeitung vor 14:00 Uhr, gilt dieser Tag als Stichtag. \n Nach 14:00 Uhr gilt der entsprechende Tag der nächsten Woche.\n \n "
maxLength: 2
minLength: 2
AutomoverParameter:
type: object
description: Parameter für das Automover-PlugIn (Key-Value Pair)
additionalProperties: false
required:
- name
- value
properties:
name:
type: string
description: Parameter Kennzeichnung
maxLength: 50
minLength: 1
value:
type: string
description: Parameter Wert
minLength: 1
PremiumAdress:
type: object
description: "PremiumAdress Variante\n \n PREMIUMADRESS mit den angegebenen Produktvarianten zur Verarbeitung von Letters. \n Als Produktvarianten sind ausschließlich Basis und Report für nationale Sendungen, ausgenommen Einschreiben, verfügbar.\n \n \n Folgende Info kann zusätzlich durch dieses PlugIn gemeldet werden:\n \n I601 - PlugIn Info: {Platzhalter für Details}\n \n Folgende Warnung kann zusätzlich durch dieses PlugIn gemeldet werden:\n \n W601 - PlugIn Warnung: {Platzhalter für Details}\n \n Folgende Fehlercodes können zusätzlich durch dieses PlugIn gemeldet werden:\n \n 99 - Verarbeitungsfehler\n E601 - PremiumAdress: {Platzhalter für Fehlerdetails}\n \n "
additionalProperties: false
required:
- productVariants
properties:
productVariants:
type: string
description: Parameter Produktvarianten "Basic" oder "Report"
minLength: 1
PremiumAdressFeedback:
type: object
description: UploadManagementFeedback - Liefert PlugIn Informationen zum UploadManagement innerhalb eines LetterStatus
additionalProperties: false
required:
- productVariants
properties:
productVariants:
type: string
description: Parameter Produktvarianten "Basic" oder "Report"
minLength: 1
premiumAdressResult:
description: "PremiumAdressResult - Enthält alle Details einer PremiumAdress-Quittung. \nDiese kann je nach Zustell-Szenario zwischen 4-14 Werktage dauern, bis eine Rückmeldung vorliegt.\nDetails zu den folgenden Feldern entnehmen Sie bitte dem PREMIUMADRESS Handbuch"
oneOf:
- $ref: '#/components/schemas/PremiumAdressResult'
PremiumAdressResult:
type: object
description: "PremiumAdressResult - Enthält alles Details einer PremiumAdress-Quittung. \nDiese kann je nach Zustell-Szenario zwischen 4-14 Werktage dauern, bis eine Rückmeldung vorliegt.\nDetails zu den folgenden Feldern entnehmen Sie bitte dem PREMIUMADRESS Handbuch"
additionalProperties: false
properties:
sdgS:
type: integer
description: Parameter SdgS Kennung des Sendungsschicksales
format: int32
kd_Na1:
type:
- string
- 'null'
description: Parameter Kd_Na1 Vorname oder erste Zeile des Firmennamens auf der Originalsendung
maxLength: 50
minLength: 0
kd_Na2:
type:
- string
- 'null'
description: Parameter Kd_Na2 Nachname oder zweite Zeile des Firmennamens auf der Originalsendung
maxLength: 50
minLength: 0
kd_Na3:
type:
- string
- 'null'
description: Parameter Kd_Na3 Adresszusatz oder dritte Zeile des Firmennamens auf der Originalsendung
maxLength: 50
minLength: 0
kd_Na4:
type:
- string
- 'null'
description: Parameter Kd_Na4 Adresszusatz oder vierte Zeile des Firmennamens auf der Originalsendung
maxLength: 50
minLength: 0
kd_Str:
type:
- string
- 'null'
description: Parameter Kd_Str Original Anschrift Straße
maxLength: 50
minLength: 0
kd_HNr:
type:
- string
- 'null'
description: Parameter Kd_HNr Original Anschrift Hausnummer
maxLength: 20
minLength: 0
kd_PLZ:
type:
- string
- 'null'
description: Parameter Kd_PLZ Original Anschrift PLZ
maxLength: 5
minLength: 0
kd_Ort:
type:
- string
- 'null'
description: Parameter Kd_Ort Original Anschrift Ort
maxLength: 50
minLength: 0
kd_Postf:
type:
- string
- 'null'
description: Parameter Kd_Postf Original Anschrift Postfach
maxLength: 12
minLength: 0
e_Na1:
type:
- string
- 'null'
description: 'Parameter E_Na1 Ergebnisdatensatz Vorname oder erste Zeile des Firmennamens '
maxLength: 50
minLength: 0
e_Na2:
type:
- string
- 'null'
description: Parameter E_Na2 Ergebnisdatensatz Nachname oder zweite Zeile des Firmennamens
maxLength: 50
minLength: 0
e_Na3:
type:
- string
- 'null'
description: Parameter E_Na3 Ergebnisdatensatz Adresszusatz oder dritte Zeile des Firmennamens
maxLength: 50
minLength: 0
e_Na4:
type:
- string
- 'null'
description: Parameter E_Na4 Ergebnisdatensatz Adresszusatz oder vierte Zeile des Firmennamens
maxLength: 50
minLength: 0
e_Str:
type:
- string
- 'null'
description: Parameter E_Str Ergebnisdatensatz Straße
maxLength: 50
minLength: 0
e_HNr:
type:
- string
- 'null'
description: Parameter E_HNr Ergebnisdatensatz Hausnummer
maxLength: 20
minLength: 0
e_PLZ:
type:
- string
- 'null'
description: Parameter E_PLZ Ergebnisdatensatz PLZ
maxLength: 5
minLength: 0
e_Ort:
type:
- string
- 'null'
description: Parameter E_Ort Ergebnisdatensatz Ort
maxLength: 50
minLength: 0
e_Postf:
type:
- string
- 'null'
description: Parameter E_Postf Ergebnisdatensatz Postfach
maxLength: 12
minLength: 0
nsA_Na1:
type:
- string
- 'null'
description: 'Parameter NSA_Na1 Nachsendeauftrag Vorname oder erste Zeile des Firmennamens '
maxLength: 50
minLength: 0
nsA_Na2:
type:
- string
- 'null'
description: Parameter NSA_Na2 Nachsendeauftrag Nachname oder zweite Zeile des Firmennamens
maxLength: 50
minLength: 0
nsA_Na3:
type:
- string
- 'null'
description: Parameter NSA_Na3 Nachsendeauftrag Adresszusatz oder dritte Zeile des Firmennamens
maxLength: 50
minLength: 0
nsA_Na4:
type:
- string
- 'null'
description: Parameter NSA_Na4 Nachsendeauftrag Adresszusatz oder vierte Zeile des Firmennamens
maxLength: 50
minLength: 0
nsA_Str:
type:
- string
- 'null'
description: Parameter NSA_Str Nachsendeauftrag Straße
maxLength: 50
minLength: 0
nsA_HNr:
type:
- string
- 'null'
description: Parameter NSA_HNr Nachsendeauftrag Hausnummer
maxLength: 20
minLength: 0
nsA_PLZ:
type:
- string
- 'null'
description: Parameter NSA_PLZ Nachsendeauftrag PLZ
maxLength: 5
minLength: 0
nsA_Ort:
type:
- string
- 'null'
description: Parameter NSA_Ort Nachsendeauftrag Ort
maxLength: 50
minLength: 0
nsA_Land:
type:
- string
- 'null'
description: 'Parameter NSA_Land Nachsendeauftrag Land : Deutsche Schreibweise ausgeschrieben, z.B. „Österreich“. Handelt es sich um eine Inlandsadresse, bleibt das Feld leer.'
maxLength: 50
minLength: 0
nsA_Postf:
type:
- string
- 'null'
description: Parameter NSA_Postf Nachsendeauftrag Postfach
maxLength: 12
minLength: 0
nsA_PLZ_Postf:
type:
- string
- 'null'
description: Parameter NSA_PLZ_Postf Nachsendeauftrag PLZ zum Postfach
maxLength: 12
minLength: 0
nsA_Ort_Postf:
type:
- string
- 'null'
description: Parameter NSA_Ort_Postf Nachsendeauftrag Ort zum Postfach
maxLength: 50
minLength: 0
nsA_Land_Postf:
type:
- string
- 'null'
description: Parameter NSA_Land_Postf Nachsendeauftrag Land zum Postfach
maxLength: 50
minLength: 0
UploadManagement:
type: object
description: "UploadManagement-PlugIn zur Versand-Steuerung von Briefen\n \n Mindestmengen-Versand\n Der Mindestmengen-Versand dient zur automatischen Sammlung von mindestens 50 Sendungen über einen Zeitraum\n von 24 Stunden beginnend ab 14:00. Für terminlich relevante Sendungen kann eine Stichtag-Option genutzt werden,\n so dass diese Schreiben zum Stichtag/-zeitpunkt in das Druckzentrum übertragen werden.\n Der Mindestmengen-Versand wird über useMinimumQuantity = true aktiviert.\n Wird das UploadManagement-PlugIn nicht explizit mitgegeben, werden die Sendungen unverändert direkt dem \n Druckzentrum zugeführt.\n \n - Für Mindestmengen ist ein fester Wert von 50 Sendungen pro Tag vorgegeben.\n - Wird diese Mindestmenge vor 14:00 Uhr erreicht, werden gesammelte und alle weiteren Sendungen bis 14:00 Uhr \n in die Produktion überführt.\n - D.h. es werden Sendungen berücksichtigt, die vom Vortag 14:00 bis 14:00 Uhr erfolgreich verarbeitet wurden \n (Status 2 - ProcessedDate) \n - Wird die tägliche Mindestmenge bis 14:00 Uhr nicht erreicht, wird pro Sendung die hinterlegte \n Stichtag-/Terminoption (DueDays,DueDate, DueDayOfWeek) geprüft und ggf. versendet.\n - Sendungen mit TestFlag = True werden nicht berücksichtigt.\n - Einschreiben und Auslandsendungen werden bei der Zählung nicht berücksichtigt. \n Hier gilt nur die mögliche angegebene Terminoption.\n \n Terminversand\n Unabhängig von der Mindestmengen kann ein reiner Terminversand genutzt werden:\n Hierzu muss der Mindestmengen-Versand über useMinimumQuantity = false ausgeschaltet werden.\n Wird das UploadManagement-PlugIn nicht explizit mitgegeben, werden die Sendungen unverändert direkt dem Druckzentrum zugeführt.\n \n - Es darf nur eine der 3 Terminoptionen (DueDays,DueDate,DueDayofWeek) verwendet werden.\n - Wird keine Terminoption angegeben, wird die Option DueDays auf 1 gesetzt.\n - Ist der Mindestmengen-Versand deaktiviert (UseMinimumQuantity = false), gilt nur die Terminoption \n als Versand-Kriterium\n - Sendungen mit TestFlag = True werden nicht berücksichtigt.\n \n Folgende Info kann zusätzlich durch dieses PlugIn gemeldet werden:\n \n I601 - PlugIn Info: {Platzhalter für Details}\n \n Folgende Warnung kann zusätzlich durch dieses PlugIn gemeldet werden:\n \n W601 - PlugIn Warnung: {Platzhalter für Details}\n W622 - UploadManagement: Einschreiben und Auslandsendungen können nicht bei Mindestmengen-Versand \n berücksichtigt werden. Hier gilt nur die Terminoption.\n \n Folgende Fehlercodes können zusätzlich durch dieses PlugIn gemeldet werden:\n \n 99 - Verarbeitungsfehler\n E601 - UploadManagement: {Platzhalter für Fehlerdetails}\n E621 - UploadManagement: Es wurde mehr als eine Stichtag-Option angegeben\n E622 - UploadManagement: Die verwendete Termin-Option muss mindestens 1 Tag und nicht weiter \n als 31 Tage in der Zukunft liegen\n E700 - Abbruch des terminierten Versands durch Kunde\n \n "
additionalProperties: false
required:
- useMinimumQuantity
properties:
useMinimumQuantity:
type: boolean
description: "Mindestmengen-Option:\n \n Aktiv: Es wird regelmäßig in einem Zeitfenster ab 14:00 Uhr des Vortages bis 14:00 Uhr geprüft, ob eine fest vorgegebene\n und tägliche Mindestmenge von 50 Sendungen erreicht wurde. \n Ab dieser Menge werden die angesammelten (und alle folgenden) Sendungen für den Upload in das Druckzentrum \n freigegebenen und hochgeladen. Ausserhalb dieses Zeitfensters findet kein Sendungsupload statt.\n \n Nicht aktiv: Es wird nur die Stichtag-Option (DueDays, DueDate, DueDayOfWeek ) für einen Sendungsupload \n verwendet. Der Upload in das Druckzentrum findet im dem Fall am Stichtag vor 14:00 Uhr statt.\n "
dueDays:
type:
- integer
- 'null'
description: "Stichtag-Option für Sendungsupload\n \n Angabe, in wie viel Tagen ab erfolgreicher Sendungsverarbeitung (Status 2 - ProcessedDate) der Stichtag \n erreicht ist.\n Diese Termin-Option darf nicht weiter als 31 Tage in der Zukunft liegen.\n Standard-Vorgabewert, sofern keine Stichtag-Option angegeben wurde: 1\n \n "
format: int32
dueDate:
type:
- string
- 'null'
description: "Stichtag-Optionen für Sendungsupload\n \n Angabe, zu welchen Datum (Zeitanteil wird ignoriert) der Stichtag für diese Sendung erreicht ist.\n Das Datum muss mindestens 1 Tag in der Zukunft liegen.\n Diese Termin-Option darf nicht weiter als 31 Tage in der Zukunft liegen.\n \n "
format: date-time
dueDayofWeek:
type:
- string
- 'null'
description: "Stichtag-Optionen für Sendungsupload\n \n Angabe, an welchem Wochentag der Stichtag für diese Sendung erreicht ist.\n \n Mögliche Angaben: Mo, Di, Mi, Do, Fr, Sa, So\n Es darf nur ein Wochentag-Kürzel angeben werden. Eine Übergabe mehrerer Wochentage ist nicht möglich.\n Entspricht die Angabe dem Wochentag der Sendungsverarbeitung vor 14:00 Uhr, gilt dieser Tag als Stichtag. \n Nach 14:00 Uhr gilt der entsprechende Tag der nächsten Woche.\n \n "
maxLength: 2
minLength: 2
AutomoverFeedback:
type: object
description: AutomoverFeedback - Liefert PlugIn Informationen zum Automover innerhalb eines LetterStatus
additionalProperties: false
properties:
useAutomover:
type: boolean
description: 'Info, ob das Automover-Plugin verwendet wurde, oder ob JSON-Adressdaten in Kombination mit einem Deckblatt vorlagen. '
parameters:
type:
- array
- 'null'
description: Liste der übergebenen Automover-Parameter
items:
$ref: '#/components/schemas/AutomoverParameter'
jsonAddressDataUsed:
type: boolean
description: Wurden JSON-Adressdaten für die Positionierung übergeben, ist dieses Flag auf true.
Automover:
type: object
description: "Automover-PlugIn zur Positionierung oder Repositionierung von Adressdaten\n \n Regeln der Adressen-Platzierung nach E-POST Vorgabe\n \n A) Adressbereich mit bekannten Daten überschreiben\n Adressdaten sind bekannt und für Versender und Empfänger im JSON belegt\n (senderAdressLine1, senderStreet, senderZipCode, senderCity, addressLine1-5, zipCode, city)\n \n - Es wird der E-POST konforme Bereich für die Adressdaten auf der ersten Seite des übergebenen PDF geweißt.\n - Sender- und Empfängeradresse werden gemäß der übergebenen Daten auf der ersten Seite aufgebracht.\n - Ist zusätzlich die Option 'CoverLetter' aktiviert, wird diese Funktion nicht verwendet und ein Deckblatt erzeugt.\n \n B) ausgefüllter Adressbereich im PDF automatisch repositionieren\n Adressdaten (Versender und Empfänger) sind nur auf dem Dokument als erkennbarer Text vorhanden\n \n - Es wird in einem vorgegebenen Bereich (siehe Parameter searchAreaXYWH) nach Sender- und Empfängeradresse gesucht.\n - Es muss mindestens die Empfängeradresse vorhanden sein bzw. erkannt werden, damit die Repositionierung erfolgreich ist\n - Die Adressdaten für Versender und Empfänger aus dem JSON werden für die Suche im Dokument nicht berücksichtigt.\n - Bei der Repositionierung wird ein E-POST konformer Adressbereich durch eine überlagerte Weißfläche vorbereitet, \n auf der die erkannten Adressen E-POST konform platziert werden.\n - Schriftart, Farbe und Größe werden dabei nach E-POST Vorgabe angepasst: \n Senderadresse Schriftart Arial, Farbe Schwarz, Größe 6\n Empfängeradresse Schriftart Arial, Farbe Schwarz, Größe 9\n - die Adressfelder 'zipCode' und 'City' im LetterStatus-Objekt werden durch die erkannten Werte befüllt.\n - Eine Kombination mit Einschreiben (registeredLetter) und/oder der automatischen Erzeugung \n eines Deckblattes werden nicht unterstützt, da hierfür die notwendigen Metadaten explizit vorliegen müssen\n \n Behandlung von Pflichtfeldern im Letter-Model, wenn KEINE Adress-Metadaten vorhanden sind\n und die Adress-Repositionierung verwendet werden muss \n \n - addressLine1: Muss mit der Kennung *AUTOMOVER* befüllt werden\n - zipCode: Muss mit der Kennung *99999* befüllt werden\n - city: Muss mit der Kennung *AUTOMOVER* befüllt werden\n \n \n Folgende Info kann zusätzlich durch dieses PlugIn gemeldet werden:\n \n I601 - PlugIn Info: {Platzhalter für Details}\n I611 - Automover: Es wurde die Coverletter-Option in Verbindung mit aktivierter Adresspositionierung angegeben. Es wurde die Deckblatt-Option verwendet.\n \n Folgende Warnung kann zusätzlich durch dieses PlugIn gemeldet werden:\n \n W601 - PlugIn Warnung: {Platzhalter für Details}\n W611 - Automover: Es wurde keine Senderadresse mitgegeben\n \n Folgende Fehlercodes können zusätzlich durch dieses PlugIn gemeldet werden:\n \n 99 - Verarbeitungsfehler\n E601 - PlugIn Fehler: {Platzhalter für Fehlerdetails}\n E612 - Es konnte keine Empfängeradresse im Suchbereich ermittelt werden\n E613 - Es konnte keine gültige PLZ ermittelt werden\n E614 - In der PDF-Datei konnte kein Text gefunden werden. Ggf. handelt es sich um ein gescanntes Dokument \n oder ein Dokument, dessen Text nicht lesbar ist.\n E615 - Für Einschreiben muss ein Deckblatt (CoverLetter=true) bei einer Adress-Repositionierung verwendet werden\n \n "
additionalProperties: false
required:
- useAutomover
properties:
useAutomover:
type: boolean
description: Soll das Automover-PlugIn aktiv werden, ist dieses Flag auf true zu stellen
parameters:
type:
- array
- 'null'
description: "Liste von optionalen Automover-Parametern für die Repositionierung\n \n Key: 'searchAreaXYWH' Default-Value: '0,0,120,110' - Koordinaten in Millimeter, Ausgangspunkt Oben Links: 'X,Y,Breite,Höhe'\n Hierdurch wird der zu durchsuchende Bereich über Koordinaten vorgegeben. \n Dieser kann entsprechend geändert werden, falls dieser Bereich angepasst werden muss.\n \n Key: 'ShowSearchAreaOnTest' Default-Value: '0' - Bei Wert '1' wird der Suchbereich (searchAreaXYWH) über ein Rechteck visualisiert. Dies gilt nur für den Testmodus.\n \n \n "
items:
$ref: '#/components/schemas/AutomoverParameter'
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