E-POSTBUSINESS API Virtual Sandbox

Automated electronic document submission for physical mail delivery services.

The E-POSTBUSINESS API enables the electronic submission of documents for physical delivery as letters. It supports PDF/A-1b document processing, automated address positioning (Automover), and integration with additional services like Dialogpost and PREMIUMADRESS. The API provides methods for document upload, status tracking, and campaign management, requiring a valid E-POST user contract for production access.

Use this hosted sandbox to simulate E-POSTBUSINESS API APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to validate PDF/A-1b document formatting, test address positioning via the Automover feature, verify status callback logic for document processing, and simulate campaign finalization workflows before integrating with the production E-POST mailing infrastructure.

E-POSTBUSINESS API virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate E-POSTBUSINESS API responses instantly.

`https://dhl-epostbusiness.mock.beeceptor.com`

Campaign(12 operations)

POST

/api/Campaign/CostEstimate

Diese Vorschau-Methode dient zur Beispielberechnung. Die bereitzustellenden Kampagne-Daten stellen nicht die finalen Kampagne-Daten dar, sondern dienen zur Evaluierung der Netto-Gesamtkosten in Abhängigkeit der Adressmenge. Bitte beachten Sie, dass auch in der Beispielrechnung der Versandkosten-A

Request Payload

{
  "addressCity": "voluptate dolore eiusmod esse ipsum",
  "addressCompany1": "sit non",
  "addressCompany2": null,
  "addressCompany3": null,
  "addressCompany4": null,
  "addressStreet": "tempor qui dolor nulla anim",
  "addressZipCode": "de",
  "campaignAddressList": null,
  "campaignName": "esse cupidatat incididunt sint nisi",
  "data": "incididunt eu deserunt",
  "isDuplex": false,
  "noOfPages": -294274022,
  "palDate": "1951-02-02T17:36:24.0Z",
  "quantity": 490134882,
  "senderLine": "velit id nisi dolor deserunt",
  "userEMail": "aute ullamco nisi velit culpa",
  "userFirstName": "culpa",
  "userLastName": "",
  "userPhone": "in tempor anim nostrud elit",
  "userSalutation": null,
  "userTitle": "ut",
  "useSenderLine": true,
  "vendorSystemInformation": "et consequat do anim occaecat"
}

Response Payload

Error generating example

{
  "code": "incididunt minim enim",
  "date": "1902-06-18T05:07:49.0Z",
  "description": "aute culpa ex consectetur",
  "level": "officia magna laboris Duis culpa"
}

{
  "code": "ullamco consequat",
  "date": null,
  "description": "do esse ut",
  "level": "velit Excepteur irure aliquip Duis"
}

{
  "code": "occaecat ut",
  "date": null,
  "description": "elit eiusmod",
  "level": "et dolor"
}

POST

/api/Campaign/SampleRequest

Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)

Request Payload

{
  "addressCity": "exerci",
  "addressCompany1": "qui",
  "addressCompany2": null,
  "addressCompany3": null,
  "addressCompany4": null,
  "addressStreet": null,
  "addressZipCode": "occae",
  "campaignAddressList": null,
  "campaignName": "",
  "data": "eu fugiat consectetur",
  "isDuplex": false,
  "noOfPages": -439584650,
  "palDate": "1956-08-31T14:37:03.0Z",
  "quantity": -1538211134,
  "senderLine": null,
  "userEMail": "elit",
  "userFirstName": "in minim",
  "userLastName": "non minim",
  "userPhone": "in qui et fugiat veniam",
  "userSalutation": null,
  "userTitle": "aliq",
  "useSenderLine": false,
  "vendorSystemInformation": null
}

Response Payload

[
  {
    "fileName": "anim minim deserunt Excepteur incididunt",
    "letterID": 1488643211194549
  },
  {
    "fileName": "ut nostrud adipisicing reprehenderit",
    "letterID": -1092146882741995
  },
  {
    "fileName": "Excepteur in",
    "letterID": -6043311230280651
  }
]

{
  "code": "sint",
  "date": "1934-03-06T16:39:13.0Z",
  "description": "officia aliquip reprehenderit cillum consequat",
  "level": "reprehenderit pariatur occaecat Duis sunt"
}

{
  "code": "proident reprehenderit deserunt",
  "date": null,
  "description": "tempor commodo officia id",
  "level": "dolore velit ut id aliquip"
}

{
  "code": "minim",
  "date": "1912-01-05T22:13:57.0Z",
  "description": "in eiusmod aliquip",
  "level": "sit est ullamco ex"
}

POST

/api/Campaign/SampleData

Der Abruf der beispielhaft generierten Werbemittel erfolgt unter Angabe der vorher bereitgestellten Identifier. Das Ergebnis der Generierungen und Fehlersituationen, bspw. Schablonenverletzungen oder Problemanschriften können in den bereitgestellten PDF-Dokumenten validiert und korrigiert werden.

Request Payload

[
  {
    "fileName": "veniam aute ut",
    "letterID": 4511498034761533
  }
]

Response Payload

[
  {
    "campaignID": -6722903290084639,
    "data": "anim nostrud aliquip voluptate dolore",
    "errorList": [
      {
        "code": "in ad est voluptate",
        "date": "1919-03-23T07:28:08.0Z",
        "description": "cupidatat esse fugiat adipisicing enim",
        "level": "enim"
      },
      {
        "code": "Ut occaecat",
        "date": "1943-04-23T18:06:17.0Z",
        "description": "id proident adipisicing in",
        "level": "et voluptate exercitation"
      },
      {
        "code": "magna laborum nisi",
        "date": null,
        "description": "in",
        "level": "Duis"
      },
      {
        "code": "laboris veniam",
        "date": null,
        "description": "Excepteur ea aute tempor quis",
        "level": "culpa aute dolor sit pariatur"
      },
      {
        "code": "eiusmod",
        "date": "1957-05-11T10:19:05.0Z",
        "description": "ullamco pariatur in ea",
        "level": "Lorem in"
      }
    ],
    "letterID": 3296464682886457,
    "position": -229757717,
    "statusDetails": null,
    "statusID": 1307214882
  },
  {
    "campaignID": 109640239327905,
    "data": "consectetur mollit",
    "errorList": [
      {
        "code": "Ut nostrud laboris dolore minim",
        "date": "1930-11-18T09:34:58.0Z",
        "description": "sint et eiusmod cupidatat",
        "level": "quis dolor aliquip Ut sit"
      },
      {
        "code": "fugiat laborum mollit Excepteur ipsum",
        "date": null,
        "description": "anim",
        "level": "consectetur ex"
      }
    ],
    "letterID": -8771495433110103,
    "position": 667503225,
    "statusDetails": null,
    "statusID": 123825735
  },
  {
    "campaignID": 1178893317166521,
    "data": "nostrud",
    "errorList": null,
    "letterID": -7312576759098875,
    "position": 521595420,
    "statusDetails": "et",
    "statusID": -413066304
  }
]

{
  "code": "fugiat eiusmod incididunt",
  "date": "1927-07-21T05:56:40.0Z",
  "description": "ad laborum amet cupidatat Excepteur",
  "level": "nulla"
}

{
  "code": "Ut",
  "date": null,
  "description": "esse incididunt Lorem in",
  "level": "pariatur incididunt aliquip laboris do"
}

{
  "code": "commodo consequat",
  "date": null,
  "description": "laboris",
  "level": "eu enim"
}

POST

/api/Campaign/Open

Die konkrete Kampagne mit dem finalen Werbemittel, den Adress-, Versand- und Rechnungsdaten wird neu erzeugt und ihre ID bereitgestellt. Eine nachträgliche Änderung ist nicht möglich, ein Abbruch (Cancel) der betroffenen Kampagne und eine Neueröffnung (Open) Kampagne mit den korrekten Daten bildet

Request Payload

{
  "addressCity": "sunt labo",
  "addressCompany1": "E",
  "addressCompany2": null,
  "addressCompany3": "consectetur nisi Excepteu",
  "addressCompany4": "mollit",
  "addressStreet": null,
  "addressZipCode": "sed ",
  "campaignAddressList": [
    {
      "addressLine1": "cupidatat et ex pariatur",
      "addressLine2": null,
      "addressLine3": null,
      "addressLine4": "culpa pariatur",
      "addressLine5": null,
      "addressLine6": "ut sunt cupidatat enim laborum",
      "countryCode": "exercitation",
      "zipCode": "qui fugiat"
    }
  ],
  "campaignName": "amet irure",
  "data": "in",
  "isDuplex": false,
  "noOfPages": -1559260842,
  "palDate": "1903-01-03T17:58:58.0Z",
  "quantity": 1791550964,
  "senderLine": "aliqua eiusmod veniam",
  "userEMail": "incididunt",
  "userFirstName": "dolore eiusmod dolore",
  "userLastName": "nostrud non adipisicing id",
  "userPhone": "ex",
  "userSalutation": null,
  "userTitle": null,
  "useSenderLine": true,
  "vendorSystemInformation": "nisi irure et"
}

Response Payload

8546331732616565

{
  "code": "cillum dolore reprehenderit",
  "date": null,
  "description": "mollit qui ex pariatur ullamco",
  "level": "consequat in cupidatat occaecat aliquip"
}

{
  "code": "fugiat nulla",
  "date": null,
  "description": "dolor enim sit qui nostrud",
  "level": "eu mollit labore aute nisi"
}

POST

/api/Campaign/{id}/ConfirmRequest

Zur Überprüfung des übergebenen Werbemittels und Adressen der konkreten Kampagne sind 5 Beispiel Dokumente zu generieren, wobei ohne die Angabe von 5 Adresspositionen in der Adressliste die ersten 5 Positionen automatisch gewählt und die jeweiligen Identifier bereitgestellt werden. Dieser Aufruf

Query Parameter Name	Example
`addressPositions`	No example

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "laboris cillum",
  "date": "1967-06-10T13:56:04.0Z",
  "description": "Lorem in aute",
  "level": "adipisicing incididunt ullamco culpa ipsum"
}

{
  "code": "do qui anim nulla",
  "date": null,
  "description": "non cillum est in",
  "level": "consectetur incididunt dolor est"
}

{
  "code": "aute deserunt elit dolore sunt",
  "date": null,
  "description": "enim fugiat",
  "level": "dolor irure fugiat non pariatur"
}

GET

/api/Campaign/{id}/ConfirmData

Der Abruf der durch die letzte ConfirmRequest-Abfrage der konkreten Kampagne generierten Dokumente erfolgt über die konkrete Kampagne ID, muss mindestens einmal ausgeführt werden und kann nach der Finalisierung nicht mehr aufgerufen werden. Authentifizierung und Validierung der Abfrage erfolgt üb

Request Payload

Response Payload

[
  {
    "campaignID": -1008331150045247,
    "data": null,
    "errorList": null,
    "letterID": -6849348611422579,
    "position": 1831092750,
    "statusDetails": "ut aute elit",
    "statusID": 1971972108
  }
]

{
  "code": "do ullamco",
  "date": null,
  "description": "cupidatat",
  "level": "labore"
}

{
  "code": "in",
  "date": "1960-02-20T01:18:32.0Z",
  "description": "eiusmod tempor quis",
  "level": "pariatur"
}

{
  "code": "adipisicing",
  "date": "1915-02-16T01:49:32.0Z",
  "description": "Duis cillum nostrud qui ipsum",
  "level": "in exercitation Ut"
}

POST

/api/Campaign/{id}/FinalizeInfo

Die zur konkreten Kampagne ID zugehörigen Vertragsdaten, Geschäftsbedingungen und netto Preise werden mit einem Timestamp zur Freigabe bereitgestellt. Dies muss mindestens einmal ausgeführt werden und kann nach der Finalisierung nicht mehr aufgerufen werden. Authentifizierung und Validierung der

Request Payload

Response Payload

{
  "addressCity": "consequa",
  "addressCompany1": "ad",
  "addressCompany2": null,
  "addressCompany3": "consectetur",
  "addressCompany4": null,
  "addressStreet": "in mollit est",
  "addressZipCode": "id cu",
  "campaignID": -8133998098820143,
  "campaignName": null,
  "ekp": "magna id f",
  "finalizeInfoDate": "1921-11-16T20:15:44.0Z",
  "grossTotalPrice": -10672980.533642784,
  "isColor": false,
  "isDuplex": false,
  "noOfPages": -2099888992,
  "palDate": "1914-01-17T02:40:16.0Z",
  "postagePrice": null,
  "printPrice": null,
  "quantity": -1113602871,
  "senderLine": null,
  "tax": null,
  "termsOfContract": "sunt",
  "termsOfContractUrl": "ea",
  "totalPrice": null,
  "userEMail": "cupidatat ut",
  "useSenderLine": false
}

{
  "code": "incididunt cillum id commodo",
  "date": "1934-01-08T03:08:17.0Z",
  "description": "irure elit tempor labore",
  "level": "nulla qui"
}

{
  "code": "pariatur tempor ullamco",
  "date": null,
  "description": "adipisicing elit ut dolor amet",
  "level": "in sit nisi ut enim"
}

{
  "code": "consectetur nulla culpa Ut aliquip",
  "date": null,
  "description": "est Lorem sit Excepteur officia",
  "level": "voluptate mollit consectetur aliquip nulla"
}

POST

/api/Campaign/{id}/Finalize

Die konkreten Kampagne mit ihrer ID wird final beauftragt und es erfolgt die vollständige Übergabe an die Produktion. Voraussetzung hierzu ist die Übergabe der Response aus Campaign/{id}/FinalizeInfo - INNERHALB VON 3 TAGEN - und die vorausgehenden Aufrufe von SampleRequest und SampleData. Die Me

Request Payload

{
  "addressCity": "in",
  "addressCompany1": "labore ",
  "addressCompany2": "ipsum amet sunt quis",
  "addressCompany3": null,
  "addressCompany4": "fugiat anim aute consequat",
  "addressStreet": null,
  "addressZipCode": "Lo",
  "campaignID": -3629291333551803,
  "campaignName": "velit",
  "ekp": "mollit lab",
  "finalizeInfoDate": "1942-02-24T05:52:40.0Z",
  "grossTotalPrice": null,
  "isColor": true,
  "isDuplex": false,
  "noOfPages": 344223728,
  "palDate": "1908-02-02T22:41:08.0Z",
  "postagePrice": null,
  "printPrice": 91221885.77482286,
  "quantity": 1992364676,
  "senderLine": "fugiat",
  "tax": null,
  "termsOfContract": null,
  "termsOfContractUrl": "dolore nostrud id eiusmod",
  "totalPrice": null,
  "userEMail": "laborum pariatur veniam",
  "useSenderLine": false
}

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "esse adipisicing",
  "date": null,
  "description": "eiusmod Lorem deserunt",
  "level": "aute"
}

{
  "code": "deserunt exercitation ullamco velit",
  "date": null,
  "description": "ut consectetur ex commodo est",
  "level": "elit"
}

{
  "code": "est tempor Duis ipsum",
  "date": "1957-10-04T11:58:01.0Z",
  "description": "deserunt reprehenderit do culpa",
  "level": "dolore id"
}

POST

/api/Campaign/{id}/Cancel

Die konkrete Kampagne kann solange abgebrochen werden, wie keine Finalisierung stattfand. Sie wird im Status als solches signalisiert. Authentifizierung und Validierung der Abfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "adipisicing pariatur Duis Excepteur velit",
  "date": null,
  "description": "enim",
  "level": "ad"
}

{
  "code": "incididunt est in ea nisi",
  "date": null,
  "description": "mollit pariatur exercitation eu do",
  "level": "ut dolore"
}

{
  "code": "in aliqua cupidatat occaecat",
  "date": "1967-05-10T01:59:01.0Z",
  "description": "adipisicing officia",
  "level": "pariatur sed amet elit cillum"
}

GET

/api/Campaign/{id}/Status

Der aktuelle Status der konkreten Kampagne inkl. möglicher Fehler kann abgerufen werden. Ausgewählte Metadaten stehen nur für 90 Tage nach der Finalisierung zur Verfügung, die übrigen Statusinformationen sind maximal 400 Tage abrufbar. Authentifizierung und Validierung der Abfrage erfolgt über Be

Request Payload

Response Payload

Error generating example

{
  "code": "Ut dolor",
  "date": null,
  "description": "minim cupidatat",
  "level": "occaecat Lorem"
}

{
  "code": "qui",
  "date": null,
  "description": "in",
  "level": "Duis id mollit"
}

{
  "code": "ut Duis nisi quis consectetur",
  "date": null,
  "description": "cillum ut sint",
  "level": "proident cillum"
}

GET

/api/Campaign/Date

Die Statusdaten der Kampagnen über den angegebenen Zeitraum werden bereitgestellt, wobei ausgewählte Metadaten nur für 90 Tage nach der Finalisierung zur Verfügung stehen. Die übrigen Statusinformationen sind maximal 400 Tage abrufbar. Authentifizierung und Validierung der Abfrage erfolgt über Be

Query Parameter Name	Example
`fromDate`	`1924-01-29T19:57:42.0Z`
`tillDate`	`1939-07-06T18:03:01.0Z`

Request Payload

Response Payload

Error generating example

{
  "code": "nostrud in adipisicing sed est",
  "date": "1897-12-20T10:03:52.0Z",
  "description": "Excepteur Lorem Ut",
  "level": "aute esse exercitation"
}

{
  "code": "ad eiusmod fugiat",
  "date": null,
  "description": "velit pariatur deserunt minim sunt",
  "level": "velit ut"
}

{
  "code": "dolor est nostrud irure exercitation",
  "date": "1895-10-06T22:48:59.0Z",
  "description": "ullamco amet ea Lorem",
  "level": "Lorem sed aliquip"
}

POST

/api/Campaign/StatusQuery

Die Statusdaten der Kampagnen werden über eine übergebene Liste von KampagnenIDs bereitgestellt, wobei ausgewählte Metadaten nur für 90 Tage nach der Finalisierung zur Verfügung stehen. Die übrigen Statusinformationen sind maximal 400 Tage abrufbar. Authentifizierung und Validierung der Abfrage e

Request Payload

[
  -6600202922568711
]

Response Payload

Error generating example

{
  "code": "sint ullamco ad enim ex",
  "date": null,
  "description": "aute Lorem",
  "level": "quis"
}

{
  "code": "exercitation nulla",
  "date": null,
  "description": "ex consequat ad eiusmod eu",
  "level": "et amet eu aliquip incididunt"
}

{
  "code": "et elit aliqua magna commodo",
  "date": null,
  "description": "officia incididunt mollit Duis",
  "level": "et"
}

{
  "code": "in",
  "date": "1954-12-04T05:34:51.0Z",
  "description": "Ut enim ipsum",
  "level": "dolore consectetur"
}

Client(6 operations)

POST

/api/Client/EMailRequest

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 übe

Query Parameter Name	Example
`email`	`ut`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "adipisicing",
  "date": "1916-07-25T09:13:28.0Z",
  "description": "voluptate sit aliqua anim",
  "level": "Lorem"
}

{
  "code": "ipsum sed ut",
  "date": "1942-04-29T08:57:29.0Z",
  "description": "ea dolor aliqua esse dolor",
  "level": "non aliqua"
}

{
  "code": "qui anim fugiat incididunt",
  "date": null,
  "description": "ea commodo aliqua",
  "level": "amet officia"
}

POST

/api/Client/SetEMail

Ä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

Query Parameter Name	Example
`email`	`Excepteur Lorem`
`code`	`mollit minim et amet in`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "amet proident",
  "date": "1937-09-17T01:16:27.0Z",
  "description": "pariatur nisi incididunt id minim",
  "level": "et aliqua ex laborum"
}

{
  "code": "non",
  "date": null,
  "description": "in",
  "level": "veniam ullamco anim enim minim"
}

POST

/api/Client/MobileRequest

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 Beare

Query Parameter Name	Example
`mobile`	`sit do aliquip eu`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "irure aute",
  "date": "1920-08-14T11:28:53.0Z",
  "description": "officia nostrud",
  "level": "magna velit consequat deserunt qui"
}

{
  "code": "labore",
  "date": null,
  "description": "eiusmod",
  "level": "non culpa"
}

{
  "code": "laborum id",
  "date": "1894-06-12T07:52:09.0Z",
  "description": "nostrud ad ea",
  "level": "labore"
}

POST

/api/Client/SetMobile

Ä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 (Authori

Query Parameter Name	Example
`mobile`	No example
`code`	No example

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "fugiat esse",
  "date": "1894-04-13T01:28:53.0Z",
  "description": "id",
  "level": "reprehenderit irure"
}

{
  "code": "Excepteur id labore fugiat minim",
  "date": null,
  "description": "ad",
  "level": "esse"
}

POST

/api/Client/TestEMail

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#)

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "sunt id velit eu",
  "date": "1963-02-19T13:42:02.0Z",
  "description": "dolor in",
  "level": "Ut in deserunt"
}

{
  "code": "fugiat aute minim Duis dolor",
  "date": "1958-07-23T02:50:43.0Z",
  "description": "voluptate esse laborum adipisicing",
  "level": "reprehenderit"
}

{
  "code": "laboris",
  "date": null,
  "description": "consequat reprehenderit",
  "level": "quis"
}

POST

/api/Client/TestMobile

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#)

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "code": "consequat dolore mollit",
  "date": "1943-09-22T14:01:31.0Z",
  "description": "incididunt dolor laborum anim mollit",
  "level": "consectetur est ea"
}

{
  "code": "ea",
  "date": null,
  "description": "adipisicing sit consectetur Excepteur",
  "level": "elit Excepteur"
}

{
  "code": "aute dolor qui irure ut",
  "date": "1935-06-06T22:42:24.0Z",
  "description": "reprehenderit tempor veniam Duis anim",
  "level": "aliquip incididunt"
}

Letter(12 operations)

GET

/api/Letter/{letterID}

Statusabfrage einer bestimmten Sendung über die eindeutige Sendungs-ID. Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)

Request Payload

Response Payload

{
  "batchID": 12345,
  "city": "pariatur",
  "costCenter": null,
  "country": null,
  "coverLetter": true,
  "createdDate": "1899-10-24T10:01:50.0Z",
  "custom1": "RE0136645",
  "custom2": null,
  "custom3": null,
  "custom4": null,
  "custom5": null,
  "destinationAreaStatus": "aute id ad",
  "destinationAreaStatusDate": "1939-09-16T07:52:19.0Z",
  "errorList": null,
  "fileName": "voluptate dolor",
  "frankierID": "eu dolore nulla veniam",
  "isColor": false,
  "isDuplex": true,
  "letterID": 43556780,
  "noOfPages": -629015057,
  "plugInFeedbackList": null,
  "printFeedbackDate": null,
  "printUploadDate": "1892-08-26T19:08:06.0Z",
  "processedDate": null,
  "registeredLetter": "dolor cillum id aute",
  "registeredLetterID": "Duis consequat sunt",
  "registeredLetterStatus": null,
  "registeredLetterStatusDate": "1965-01-19T11:11:32.0Z",
  "statusDetails": "Einlieferung in Druckzentrum",
  "statusID": -1419817658,
  "subVendorID": null,
  "testEMail": null,
  "testFlag": true,
  "testShowRestrictedArea": true,
  "vendorSystemInformation": "deserunt",
  "zipCode": "dolor qui tempor adipisicing ipsum"
}

{
  "code": "ullamco eiusmod pariatur qui proident",
  "date": "1906-02-17T02:28:01.0Z",
  "description": "irure officia exercitation sit",
  "level": "esse laboris in sint"
}

{
  "code": "velit",
  "date": null,
  "description": "labore incididunt Ut",
  "level": "officia fugiat laborum in"
}

{
  "code": "cillum",
  "date": null,
  "description": "cillum nulla ad dolor pariatur",
  "level": "irure et"
}

{
  "code": "enim laboris dolore ad",
  "date": "1905-10-01T20:02:37.0Z",
  "description": "incididunt reprehenderit qui",
  "level": "sit Duis ut"
}

GET

/api/Letter/TestResult

Abfrage des PDF-Resultats einer bestimmten Testsendung über die eindeutige Sendungs-ID. Diese Abfrage ist nur für Test-Einlieferungen möglich. Das PDF-Resultat wird als Base64-String bereitgestellt und ist nach einer technisch erfolgreichen Verarbeitung (ProcessedDate) 48 Std lang verfügbar. Aut

Query Parameter Name	Example
`letterID`	`-5857612836281643`

Request Payload

Response Payload

{
  "data": "Ut quis laboris magna minim",
  "fileName": null,
  "letterID": -687662601827867
}

{
  "code": "culpa proident Ut sunt ullamco",
  "date": "1952-09-07T06:20:36.0Z",
  "description": "minim dolore est labore",
  "level": "pariatur"
}

{
  "code": "deserunt",
  "date": "1924-12-29T01:47:38.0Z",
  "description": "ut sint eiusmod Ut ea",
  "level": "sunt"
}

{
  "code": "nulla occaecat officia dolor in",
  "date": null,
  "description": "consectetur elit",
  "level": "sint ea"
}

{
  "code": "Ut",
  "date": null,
  "description": "labore sint pariatur",
  "level": "Excepteur Ut veniam sit"
}

GET

/api/Letter/Batch

Statusabfrage eines bestimmten Stapellaufs (BatchID) Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)

Query Parameter Name	Example
`batchId`	`1235461695`
`onlyIssues`	`true`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": "aute",
    "costCenter": null,
    "country": null,
    "coverLetter": false,
    "createdDate": "1910-10-20T09:40:08.0Z",
    "custom1": "RE0136645",
    "custom2": "Duis mollit",
    "custom3": "ea ex elit et aute",
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1914-03-30T06:50:17.0Z",
    "errorList": null,
    "fileName": "cillum dolore",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -2097413183,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "laboris aliquip es"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "commodo labore"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "nostrud sit ut"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "magna"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": "cupidatat proident",
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1897-05-03T04:07:29.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1890253281,
    "subVendorID": null,
    "testEMail": "in",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": "reprehenderit aute"
  },
  {
    "batchID": 12345,
    "city": "sunt deserunt aliquip",
    "costCenter": "veniam ",
    "country": null,
    "coverLetter": false,
    "createdDate": "1962-12-16T06:13:37.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "custom5": "qui nulla ea enim Duis",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "non eu",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1845433668,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "quis"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "esse non aliqua aute minim"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "anim"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "qui"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": "1901-11-12T22:44:18.0Z",
    "registeredLetter": "mollit velit ut",
    "registeredLetterID": null,
    "registeredLetterStatus": "consectetur",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1144701552,
    "subVendorID": "fugiat laboris consequat",
    "testEMail": "et in pariatur incididunt",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "Ut laboris ullamco aute dolor",
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "",
    "country": null,
    "coverLetter": false,
    "createdDate": "1921-10-08T01:07:27.0Z",
    "custom1": "RE0136645",
    "custom2": "occaecat Ut",
    "custom3": null,
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": "fugiat eu",
    "destinationAreaStatusDate": "1927-08-10T11:41:35.0Z",
    "errorList": [
      {
        "code": "pariatur sit qui",
        "date": null,
        "description": "exercitation ullamco",
        "level": "et incididunt sunt laborum"
      },
      {
        "code": "aute do consequat in non",
        "date": "1903-03-01T01:28:34.0Z",
        "description": "Lorem pariatur officia laboris proident",
        "level": "laboris culpa cillum quis"
      },
      {
        "code": "ex mollit aute esse",
        "date": null,
        "description": "in dolor",
        "level": "cupidatat"
      }
    ],
    "fileName": "ut in pariatur quis aute",
    "frankierID": "do",
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -357749111,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1964-08-31T21:58:06.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": "culpa",
    "registeredLetterStatus": "culpa aliqua",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 808951874,
    "subVendorID": "cupidatat quis dolor aliqua ex",
    "testEMail": "do cupidatat Duis",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "reprehenderit nisi anim ",
    "zipCode": "cupidatat"
  },
  {
    "batchID": 12345,
    "city": "esse",
    "costCenter": "d",
    "country": "est sint commodo",
    "coverLetter": true,
    "createdDate": "1951-01-09T16:49:03.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "Lorem occaecat esse aliquip ut",
    "custom4": "mollit in magna ad",
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "quis proident",
        "date": "1944-02-18T11:52:02.0Z",
        "description": "adipisicing ut minim qui laboris",
        "level": "est proident in velit in"
      },
      {
        "code": "veniam do nisi minim ut",
        "date": null,
        "description": "qui veniam",
        "level": "nulla laborum veniam"
      }
    ],
    "fileName": "ut reprehenderi",
    "frankierID": "aliquip reprehenderit et eiusmod",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 913785083,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "nulla esse quis"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1424495489,
    "subVendorID": null,
    "testEMail": "nostrud sint ad velit",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": "labore aute ut"
  },
  {
    "batchID": 12345,
    "city": "in",
    "costCenter": null,
    "country": null,
    "coverLetter": false,
    "createdDate": "1948-03-13T02:56:46.0Z",
    "custom1": "RE0136645",
    "custom2": "sit occaecat",
    "custom3": null,
    "custom4": "Duis ullamco",
    "custom5": "officia anim et consectetur sit",
    "destinationAreaStatus": "eiusmod enim voluptate aliqua reprehenderit",
    "destinationAreaStatusDate": "1933-01-02T18:17:40.0Z",
    "errorList": [
      {
        "code": "ut esse ea reprehenderit dolore",
        "date": "1911-04-07T08:19:03.0Z",
        "description": "quis fugiat do nostrud pariatur",
        "level": "Lorem"
      },
      {
        "code": "adipisicing sunt elit commodo",
        "date": "1963-07-04T08:20:22.0Z",
        "description": "sint id culpa tempor",
        "level": "dolore cupidatat tempor"
      },
      {
        "code": "nulla ipsum veniam",
        "date": "1912-08-19T04:55:52.0Z",
        "description": "voluptate tempor sed nulla",
        "level": "ea tempor aliqua"
      }
    ],
    "fileName": "dolor fugiat eiusmod",
    "frankierID": "irure labore ipsum amet",
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 751744586,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "nisi enim"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "ut nisi Duis"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": "1899-01-19T06:29:02.0Z",
    "processedDate": "1961-09-22T02:04:29.0Z",
    "registeredLetter": null,
    "registeredLetterID": "consectetur anim cupidatat",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1789158683,
    "subVendorID": "dolor fugiat",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "nostrud officia sunt magna"
  }
]

{
  "code": "labore non magna",
  "date": null,
  "description": "incididunt elit id magna",
  "level": "qui non velit cupidatat consequat"
}

{
  "code": "dolor in",
  "date": "1892-12-31T03:59:25.0Z",
  "description": "sed aliquip ut ea",
  "level": "ut elit cillum commodo"
}

{
  "code": "Lorem mollit",
  "date": null,
  "description": "occaecat culpa eiusmod",
  "level": "quis anim mollit"
}

{
  "code": "magna do reprehenderit mollit elit",
  "date": null,
  "description": "eiusmod",
  "level": "nisi sunt"
}

GET

/api/Letter/Custom1

Statusabfrage von Sendungen über eine benutzerdefinierte Kennung (Custom1) Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)

Query Parameter Name	Example
`custom1`	No example
`onlyIssues`	`false`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": "irure quis occaecat Ut reprehenderit",
    "costCenter": null,
    "country": "commodo cillum",
    "coverLetter": true,
    "createdDate": "1959-03-06T12:28:15.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "in ullamco Ut qui",
    "custom4": "amet dolore",
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1922-11-24T16:58:37.0Z",
    "errorList": null,
    "fileName": "labore",
    "frankierID": "ut cupidatat",
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 2020393452,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "cillum ut"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "sunt aliqua amet"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "ut magna velit enim"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": "1904-06-13T11:36:31.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1900-10-28T02:15:37.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 834376342,
    "subVendorID": "sint adipisicing pariatur in minim",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "esse Duis tempor quis",
    "zipCode": "qui ad ex exercitation"
  },
  {
    "batchID": 12345,
    "city": "non",
    "costCenter": "",
    "country": "sed eu",
    "coverLetter": true,
    "createdDate": "1918-01-25T10:18:47.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": "nisi minim",
    "custom5": "occaecat in dolor",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "laborum velit",
        "date": "1896-11-06T14:29:34.0Z",
        "description": "in dolor irure",
        "level": "dolor mollit Excepteur exercitation tempor"
      },
      {
        "code": "amet occaecat",
        "date": "1895-04-07T17:48:31.0Z",
        "description": "magna reprehenderit est",
        "level": "ut"
      },
      {
        "code": "cupidatat cillum ex aliquip",
        "date": "1942-04-25T20:29:15.0Z",
        "description": "amet non do proident tempor",
        "level": "do in"
      },
      {
        "code": "eu ipsum",
        "date": null,
        "description": "dolore elit",
        "level": "commodo dolor consectetur velit"
      },
      {
        "code": "commodo cillum dolor exercitation ad",
        "date": null,
        "description": "ex",
        "level": "anim"
      }
    ],
    "fileName": "cupidatat laboris i",
    "frankierID": "sunt consequat do",
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 62558965,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "nostrud"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "fugiat deserunt"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "Duis occaeca"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "sed adipisicing"
      }
    ],
    "printFeedbackDate": "1890-09-17T02:25:38.0Z",
    "printUploadDate": null,
    "processedDate": "1896-03-31T09:05:11.0Z",
    "registeredLetter": "commodo nulla occaecat",
    "registeredLetterID": "velit dolore officia",
    "registeredLetterStatus": "in aute esse",
    "registeredLetterStatusDate": "1892-11-02T17:26:56.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1486291161,
    "subVendorID": "irure do incididunt anim",
    "testEMail": "incididunt sunt ut enim Ut",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "ex fugi",
    "zipCode": "dolore nulla"
  },
  {
    "batchID": 12345,
    "city": "anim dolor eu",
    "costCenter": "la",
    "country": "in dolor consequat",
    "coverLetter": true,
    "createdDate": "1935-10-28T01:46:08.0Z",
    "custom1": "RE0136645",
    "custom2": "deserunt",
    "custom3": "laborum nulla veniam ut",
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": "ipsum non eiusmod consectetur dolore",
    "destinationAreaStatusDate": "1921-08-13T15:26:59.0Z",
    "errorList": null,
    "fileName": "culpa reprehenderit eiusmod aliquip ex",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 1726783887,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1957-05-09T17:55:41.0Z",
    "printUploadDate": null,
    "processedDate": "1963-01-27T11:48:05.0Z",
    "registeredLetter": null,
    "registeredLetterID": "Lorem cillum nostrud fugiat",
    "registeredLetterStatus": "Duis deserunt aliquip ad",
    "registeredLetterStatusDate": "1900-04-01T10:59:50.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -417668348,
    "subVendorID": null,
    "testEMail": "id aute mollit est exercitation",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "exercitation",
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "ut",
    "country": "velit",
    "coverLetter": false,
    "createdDate": "1959-09-25T23:20:04.0Z",
    "custom1": "RE0136645",
    "custom2": "ipsum",
    "custom3": null,
    "custom4": "aliquip",
    "custom5": "commodo irure dolor sed",
    "destinationAreaStatus": "ad amet",
    "destinationAreaStatusDate": "1892-10-25T03:34:44.0Z",
    "errorList": [
      {
        "code": "adipisicing in",
        "date": null,
        "description": "nulla",
        "level": "adipisicing"
      },
      {
        "code": "dolore occaecat aliquip",
        "date": "1917-03-10T09:05:52.0Z",
        "description": "pariatur non",
        "level": "proident cupidatat"
      },
      {
        "code": "voluptate sunt ex",
        "date": "1942-09-04T02:09:36.0Z",
        "description": "elit culpa magna",
        "level": "in ad ex"
      },
      {
        "code": "ut nostrud",
        "date": "1965-10-27T12:18:20.0Z",
        "description": "in aute elit nostrud",
        "level": "labore et"
      }
    ],
    "fileName": "sunt et in nulla eiusmod",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 1338043517,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "adipisicing eu Duis"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "in officia ip"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "aute"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "Lorem ea aliqua aliquip"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "reprehenderit in"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": "1948-01-01T09:37:43.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -406622485,
    "subVendorID": "et reprehenderit elit veniam",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "aute dolor in voluptate",
    "zipCode": "officia aute veniam exercitation ad"
  }
]

{
  "code": "anim est",
  "date": "1955-09-18T08:32:01.0Z",
  "description": "eiusmod irure",
  "level": "Excepteur quis officia in ex"
}

{
  "code": "laboris ea voluptate",
  "date": "1903-05-22T22:25:56.0Z",
  "description": "id proident deserunt anim",
  "level": "exercitation in aute"
}

{
  "code": "aliquip aliqua",
  "date": null,
  "description": "irure ut occaecat mollit",
  "level": "ullamco in"
}

{
  "code": "dolore esse",
  "date": null,
  "description": "esse sunt",
  "level": "Ut"
}

GET

/api/Letter/Date

Statusabfrage von Sendungen innerhalb eines bestimmten Zeitfensters. Der maximale Zeitraum für Datumsabfragen beträgt 400 Tage rückwirkend. Hierzu wird das Einlieferungsdatum der Sendungen verwendet (Letterstatus: CreateDate) Authentifizierung und Validierung der Sendungsabfrage erfolgt über Beare

Query Parameter Name	Example
`fromDate`	`1899-01-08T09:59:13.0Z`
`tillDate`	`1953-01-16T16:15:32.0Z`
`onlyIssues`	`true`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": "laborum",
    "costCenter": null,
    "country": null,
    "coverLetter": true,
    "createdDate": "1964-07-02T06:41:39.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "id in qui sunt Duis",
    "custom4": "qui deserunt dolore labore",
    "custom5": "culpa fugiat Excepteur",
    "destinationAreaStatus": "reprehenderit do nostrud",
    "destinationAreaStatusDate": "1943-07-24T04:47:38.0Z",
    "errorList": [
      {
        "code": "laboris est eiusmod deserunt",
        "date": "1924-04-27T04:26:45.0Z",
        "description": "sit eiusmod amet sed in",
        "level": "et adipisicing officia"
      },
      {
        "code": "amet dolore officia minim sed",
        "date": "1934-01-31T09:57:05.0Z",
        "description": "Ut officia dolore",
        "level": "quis"
      },
      {
        "code": "quis nisi cillum aliquip",
        "date": "1907-10-15T03:42:26.0Z",
        "description": "tempor velit",
        "level": "cupidatat ut nostrud adipisicing"
      },
      {
        "code": "incididunt esse",
        "date": "1936-06-13T15:02:50.0Z",
        "description": "laboris nisi in veniam ea",
        "level": "ex"
      }
    ],
    "fileName": "quis incididunt",
    "frankierID": null,
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 1861217284,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "laborum nostrud dolor adipisicing"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "ut s"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": "consectetur magna cupidatat in qui",
    "registeredLetterID": null,
    "registeredLetterStatus": "sint",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 468379925,
    "subVendorID": null,
    "testEMail": "sunt ullamco in ea cillum",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "Excepteur non",
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "id in",
    "country": "eiusmod minim",
    "coverLetter": false,
    "createdDate": "1940-01-06T16:13:54.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": "in sit dolor est elit",
    "custom5": null,
    "destinationAreaStatus": "ut in irure mollit",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "irure id pariatur",
        "date": null,
        "description": "consequat commodo fugiat esse pariatur",
        "level": "sint id enim"
      },
      {
        "code": "qui officia aute",
        "date": null,
        "description": "Ut voluptate",
        "level": "ullamco anim culpa sunt consequat"
      },
      {
        "code": "deserunt",
        "date": "1934-10-15T19:28:48.0Z",
        "description": "qui",
        "level": "esse incididunt aliqua tempor"
      },
      {
        "code": "ex consectetur in",
        "date": null,
        "description": "magna eu sunt",
        "level": "consectetur"
      },
      {
        "code": "Lorem ex commodo",
        "date": "1926-04-17T04:50:32.0Z",
        "description": "culpa dolor Lorem cillum",
        "level": "proident sed amet"
      }
    ],
    "fileName": "fugiat occaecat",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 622337373,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "minim est non enim deserunt"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "ea sed Lorem aute"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "magna eiusmod ut Lorem"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "aute exercitation"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "officia exercitation elit consectetur"
      }
    ],
    "printFeedbackDate": "1965-12-04T17:48:35.0Z",
    "printUploadDate": null,
    "processedDate": "1892-09-15T15:49:22.0Z",
    "registeredLetter": null,
    "registeredLetterID": "reprehenderit cillum magna Lorem est",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1677457677,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "id fugiat ",
    "zipCode": "incididunt minim culpa Duis ipsum"
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": null,
    "country": null,
    "coverLetter": false,
    "createdDate": "1969-03-15T21:55:01.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": "aliquip nostrud officia proident ut",
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1891-05-16T19:26:09.0Z",
    "errorList": [
      {
        "code": "labore tempor",
        "date": "1890-02-25T10:28:48.0Z",
        "description": "adipisicing Ut pariatur",
        "level": "ipsum officia cillum laboris"
      },
      {
        "code": "eiusmod ad qui sunt incididunt",
        "date": "1903-11-18T17:36:49.0Z",
        "description": "cupidatat cillum sit",
        "level": "quis proident eiusmod"
      }
    ],
    "fileName": "nisi exercitation sit",
    "frankierID": null,
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 177554518,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1940-02-04T16:06:18.0Z",
    "printUploadDate": "1893-06-05T01:46:01.0Z",
    "processedDate": null,
    "registeredLetter": "irure aliquip do reprehenderit Duis",
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -994170663,
    "subVendorID": null,
    "testEMail": "cillum laborum tempor voluptate non",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "do non dolor ipsum incididunt",
    "zipCode": null
  }
]

{
  "code": "aliqua irure",
  "date": null,
  "description": "irure",
  "level": "laborum"
}

{
  "code": "anim ut nulla",
  "date": "1891-01-20T03:13:01.0Z",
  "description": "sit aliqua eiusmod",
  "level": "et Ut occaecat voluptate consequat"
}

{
  "code": "incididunt laborum",
  "date": "1901-01-16T14:32:27.0Z",
  "description": "in non",
  "level": "ad ut pariatur Ut reprehenderit"
}

{
  "code": "cupidatat in adipisicing non eu",
  "date": "1967-04-15T21:23:52.0Z",
  "description": "in dolor nisi",
  "level": "sit in voluptate do"
}

GET

/api/Letter/Open

Statusabfrage aller offenen LIVE-Sendungen (LetterStatus 1,2,3 und TestFlag=false). Versendete und fehlerhafte Briefe (LetterStatus 4,99) werden hierbei nicht zurückgegeben. Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #to

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "in",
    "country": "fugiat tempor",
    "coverLetter": false,
    "createdDate": "1957-11-04T04:34:49.0Z",
    "custom1": "RE0136645",
    "custom2": "reprehenderit Excepteur",
    "custom3": null,
    "custom4": "officia amet",
    "custom5": "dolore labore aute aliqua",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1926-09-03T10:34:26.0Z",
    "errorList": null,
    "fileName": "in consectetur nulla est in",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 117127217,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": "1941-12-18T02:12:45.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1930-09-27T21:56:55.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1661117389,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "et non"
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": null,
    "country": null,
    "coverLetter": true,
    "createdDate": "1947-02-22T15:35:24.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "amet quis",
    "custom4": "velit",
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1937-10-07T06:15:21.0Z",
    "errorList": null,
    "fileName": "do eu aliqua exercitation",
    "frankierID": "sint est do",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1012222685,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1937-11-17T23:36:40.0Z",
    "printUploadDate": null,
    "processedDate": "1913-09-20T13:18:13.0Z",
    "registeredLetter": null,
    "registeredLetterID": "aute ut reprehenderit magna sint",
    "registeredLetterStatus": "aliquip",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -616173102,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "eiusmod",
    "zipCode": "do"
  }
]

{
  "code": "non ad",
  "date": null,
  "description": "occaecat Ut veniam do",
  "level": "sit"
}

{
  "code": "Ut fugiat magna",
  "date": null,
  "description": "aute quis fugiat cupidatat",
  "level": "dolor proident"
}

{
  "code": "dolore",
  "date": null,
  "description": "ad dolor ut",
  "level": "nulla"
}

{
  "code": "sed in ut",
  "date": null,
  "description": "anim",
  "level": "laborum"
}

GET

/api/Letter/Registered

Statusabfrage von Einschreiben über einen bestimmten Zeitraum. Der maximale Zeitraum für Datumsabfragen beträgt 400 Tage rückwirkend. Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)

Query Parameter Name	Example
`fromDate`	`1962-02-16T11:11:17.0Z`
`tillDate`	`1914-01-21T20:50:19.0Z`
`onlyOpen`	`false`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": "tempor",
    "costCenter": "e",
    "country": null,
    "coverLetter": true,
    "createdDate": "1952-05-01T01:17:39.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "aliqua occaecat",
    "custom4": null,
    "custom5": "ex aute occaecat",
    "destinationAreaStatus": "dolor sint",
    "destinationAreaStatusDate": "1922-11-27T13:50:26.0Z",
    "errorList": null,
    "fileName": "incididunt fugiat dolor in",
    "frankierID": null,
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -473243092,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": "1923-09-30T01:21:12.0Z",
    "processedDate": "1898-07-01T03:14:02.0Z",
    "registeredLetter": null,
    "registeredLetterID": "in Duis",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -828264106,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": null
  }
]

{
  "code": "cillum tempor qui",
  "date": null,
  "description": "amet reprehenderit exercitation",
  "level": "mollit quis"
}

{
  "code": "ipsum dolore incididunt voluptate et",
  "date": null,
  "description": "eu",
  "level": "elit"
}

{
  "code": "cillum",
  "date": "1902-09-26T22:01:29.0Z",
  "description": "amet",
  "level": "quis consequat in id eu"
}

{
  "code": "commodo mollit ex",
  "date": "1948-12-01T12:55:01.0Z",
  "description": "enim laboris",
  "level": "incididunt adipisicing tempor id"
}

GET

/api/Letter/PremiumAdressFeedback

Statusabfrage von PremiumAdress-PlugIN Feedback über einen bestimmten Zeitraum. Der maximale Zeitraum für Datumsabfragen beträgt 400 Tage rückwirkend. Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token#)

Query Parameter Name	Example
`fromDate`	`1918-12-23T08:41:21.0Z`
`tillDate`	`1944-09-23T20:13:47.0Z`
`onlyFeedback`	`true`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": "qui magna Excepteur dolor",
    "costCenter": "exercita",
    "country": "laborum mollit",
    "coverLetter": false,
    "createdDate": "1914-02-19T04:44:44.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "nostrud aute",
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": "sit do",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "laborum mollit magna occaecat",
        "date": "1918-07-27T03:16:18.0Z",
        "description": "Excepteur commodo ea",
        "level": "deserunt ad"
      }
    ],
    "fileName": "ex dolor eiusmod et",
    "frankierID": "voluptate nostrud nulla",
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 771416460,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "irure id"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "eu quis pariatur commodo dolor"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "exercitation Duis ut"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "Excepteur sed"
      }
    ],
    "printFeedbackDate": "1901-12-07T18:57:47.0Z",
    "printUploadDate": "1969-11-03T05:55:51.0Z",
    "processedDate": "1890-10-03T10:17:08.0Z",
    "registeredLetter": "dolore ea cupidatat aute sunt",
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1945-08-31T01:55:11.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1666112480,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "esse inc",
    "country": "est ipsum tempor laboris",
    "coverLetter": true,
    "createdDate": "1897-05-18T04:01:18.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "custom5": "id",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1952-11-29T15:51:23.0Z",
    "errorList": [
      {
        "code": "magna pariatur",
        "date": null,
        "description": "consectetur ipsum minim dolor dolor",
        "level": "velit ut Lorem tempor"
      },
      {
        "code": "aliqua",
        "date": null,
        "description": "ad",
        "level": "occaecat enim deserunt dolore incididunt"
      },
      {
        "code": "consequat amet cupidatat irure",
        "date": "1951-05-19T03:45:19.0Z",
        "description": "Excepteur aute Lorem",
        "level": "fugiat sunt Duis nisi"
      },
      {
        "code": "ex deserunt qui",
        "date": "1945-11-30T21:14:31.0Z",
        "description": "veniam dolore",
        "level": "elit"
      }
    ],
    "fileName": "eiusmod ex",
    "frankierID": "adipisicing ex Duis nisi aute",
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -1530199972,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": "1933-12-12T16:37:12.0Z",
    "processedDate": "1910-10-20T01:06:57.0Z",
    "registeredLetter": "voluptate dolor ea",
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -818020757,
    "subVendorID": null,
    "testEMail": "ut dolor tempor in commodo",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "eiusmod dolor anim nostrud ex",
    "zipCode": "deserunt velit enim"
  },
  {
    "batchID": 12345,
    "city": "exercitation nulla ad",
    "costCenter": null,
    "country": null,
    "coverLetter": false,
    "createdDate": "1929-03-19T18:23:48.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": "ad",
    "custom5": null,
    "destinationAreaStatus": "elit",
    "destinationAreaStatusDate": "1913-10-20T14:31:18.0Z",
    "errorList": null,
    "fileName": "consectetur eu qui",
    "frankierID": "est ut consectetur esse",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1988982113,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": "1901-03-23T09:32:27.0Z",
    "registeredLetter": "aliqua Lorem deserunt",
    "registeredLetterID": null,
    "registeredLetterStatus": "est",
    "registeredLetterStatusDate": "1929-06-22T01:42:32.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1753810670,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "mollit",
    "zipCode": "veniam"
  }
]

{
  "code": "id",
  "date": "1911-05-07T17:47:36.0Z",
  "description": "voluptate eiusmod nisi deserunt",
  "level": "ut aliquip"
}

{
  "code": "consectetur",
  "date": "1961-11-05T23:40:01.0Z",
  "description": "eu enim irure sed",
  "level": "anim ut est"
}

{
  "code": "qui pariatur est",
  "date": null,
  "description": "dolor non esse cupidatat",
  "level": "qui minim velit"
}

{
  "code": "dolore Lorem",
  "date": null,
  "description": "mollit reprehenderit Excepteur non",
  "level": "dolore irure cupidatat ut"
}

POST

/api/Letter/StatusQuery

Statusabfrage durch eine übergegebene Liste der eindeutigen Sendungs-IDs (letterIDs). Zur Validierung der Verarbeitung kann auf die fehlerhaften Schreiben (status = 99) mit onlyIssues eingeschränkt werden. Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Hea

Query Parameter Name	Example
`onlyIssues`	`false`

Request Payload

[
  6615237861364129
]

Response Payload

[
  {
    "batchID": 12345,
    "city": "adipisicing veniam",
    "costCenter": null,
    "country": "esse deserunt",
    "coverLetter": false,
    "createdDate": "1946-08-06T06:35:48.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": "quis mollit",
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "sint dolor minim nulla",
    "frankierID": null,
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 1754853686,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1911-04-26T07:59:22.0Z",
    "printUploadDate": "1919-12-10T01:32:27.0Z",
    "processedDate": "1915-11-28T06:03:03.0Z",
    "registeredLetter": null,
    "registeredLetterID": "enim velit anim",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1895-12-21T17:42:13.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1770449289,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "occaecat",
    "zipCode": "ullamco commodo"
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "anim cu",
    "country": "labore minim quis dolor",
    "coverLetter": false,
    "createdDate": "1938-03-30T14:28:17.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "ex consectetur do magna",
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": "ut",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "dolore",
        "date": "1958-01-06T11:27:59.0Z",
        "description": "Ut consequat in",
        "level": "esse quis voluptate non"
      },
      {
        "code": "quis id in commodo voluptate",
        "date": "1896-06-13T03:10:23.0Z",
        "description": "ullamco occaecat labore sed nostrud",
        "level": "magna amet tempor"
      },
      {
        "code": "enim cillum deserunt mollit",
        "date": "1933-02-08T23:55:10.0Z",
        "description": "aliqua dolor nulla in reprehenderit",
        "level": "aliqua velit dolor sunt"
      },
      {
        "code": "laboris irure anim aute",
        "date": "1961-06-28T01:02:39.0Z",
        "description": "et Lorem esse aliquip sed",
        "level": "et cillum mollit qui"
      }
    ],
    "fileName": "esse incididunt ad ipsum labore",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -947308755,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "Lorem consequat labore est"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "tempor adipisicing consectetur"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "consectetur ipsum minim pariatur incididunt"
      }
    ],
    "printFeedbackDate": "1911-04-29T21:53:12.0Z",
    "printUploadDate": "1944-08-03T11:24:36.0Z",
    "processedDate": "1927-02-04T05:12:53.0Z",
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -234211151,
    "subVendorID": "in cillum",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "labore consectetur",
    "zipCode": "laboris ipsum irure"
  },
  {
    "batchID": 12345,
    "city": "irure magna ex",
    "costCenter": "pariatu",
    "country": "sunt nostrud",
    "coverLetter": true,
    "createdDate": "1895-08-26T03:22:32.0Z",
    "custom1": "RE0136645",
    "custom2": "dolore culpa dolor",
    "custom3": "sit labore",
    "custom4": "minim occaecat aliqua fugiat consequat",
    "custom5": null,
    "destinationAreaStatus": "esse",
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "sunt",
    "frankierID": "cillum reprehenderit exercitation",
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -1634966527,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": "voluptate mollit",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1918-05-02T01:28:57.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1236866576,
    "subVendorID": "dolore",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "et reprehenderit voluptate eiusmod pariatur",
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "velit dolore commodo adipisicing",
    "costCenter": "dolore s",
    "country": "veniam qui",
    "coverLetter": false,
    "createdDate": "1910-08-30T02:07:59.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "custom5": "mollit nisi irure",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "id Lorem",
    "frankierID": "consequat aliquip incididunt minim elit",
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -1026036768,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "exercitation ad ipsum laboris"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": "1966-09-07T06:46:07.0Z",
    "processedDate": "1897-05-06T17:40:48.0Z",
    "registeredLetter": null,
    "registeredLetterID": "nisi",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1943-12-31T21:37:33.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 968785835,
    "subVendorID": null,
    "testEMail": "aliqua quis Excepteur",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "minim",
    "costCenter": null,
    "country": null,
    "coverLetter": true,
    "createdDate": "1939-09-18T14:48:13.0Z",
    "custom1": "RE0136645",
    "custom2": "sunt",
    "custom3": null,
    "custom4": "magna",
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "ad eu",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -549794640,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "dolore esse cupidatat aliqua"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "id nisi elit"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "enim "
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "sint"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "elit minim"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": "1893-11-18T06:15:59.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": "et ut",
    "registeredLetterStatus": "nostrud elit esse eiusmod labore",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1794648914,
    "subVendorID": null,
    "testEMail": "occaecat ullamco amet eiusmod",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "voluptate Lorem"
  }
]

{
  "code": "laborum sunt",
  "date": "1929-03-07T09:12:23.0Z",
  "description": "amet eiusmod in aute",
  "level": "eu eiusmod"
}

{
  "code": "laborum",
  "date": null,
  "description": "dolor dolore",
  "level": "enim fugiat"
}

{
  "code": "consequat",
  "date": "1933-01-10T05:28:14.0Z",
  "description": "commodo",
  "level": "incididunt"
}

{
  "code": "amet dolore",
  "date": null,
  "description": "ad velit consectetur",
  "level": "ex eu labore proident id"
}

POST

/api/Letter

Einlieferung von einer oder mehreren Sendungen, wobei eine Gruppierung von mehreren Uploads über die individuelle batchID möglich ist. Die einzuliefernden PDF-Dateien dürfen pro Sendung 20 MB bzw. mehrere Sendungen per Request 300 MB nicht überschreiten. Im Erfolgsfall der Einlieferung wird zu je

Request Payload

[
  {
    "addressLine1": "irure nulla",
    "addressLine2": "proident est Ut exercitation",
    "addressLine3": null,
    "addressLine4": "id dolore non",
    "addressLine5": "et in sunt tempor",
    "batchID": 12345,
    "city": "Rubyboro",
    "costCenter": "l",
    "country": null,
    "coverData": null,
    "coverLetter": true,
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "ex laborum irure n",
    "custom4": "Lorem",
    "custom5": null,
    "data": "quis nulla",
    "fileName": "gleefully_clearly.[object Object]",
    "isColor": false,
    "isDuplex": false,
    "plugInList": null,
    "registeredLetter": null,
    "registeredLetterAdressLine1": null,
    "registeredLetterAdressLine2": "non sint nisi deserunt anim",
    "registeredLetterAdressLine3": null,
    "registeredLetterCity": "veniam ipsum magna",
    "registeredLetterZipCode": null,
    "senderAdressLine1": "ullamc",
    "senderAdressLineComplete": "ad ipsum",
    "senderCity": null,
    "senderStreet": null,
    "senderZipCode": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": "sit"
  },
  {
    "addressLine1": "sit voluptate",
    "addressLine2": null,
    "addressLine3": "nulla ad dolore magna Ut",
    "addressLine4": "occaecat reprehenderit do nulla",
    "addressLine5": null,
    "batchID": 12345,
    "city": "Laurynhaven",
    "costCenter": "a",
    "country": null,
    "coverData": "veniam",
    "coverLetter": false,
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "laborum",
    "custom4": "dolore occaecat consequat minim Lorem",
    "custom5": null,
    "data": "eu qui cupidatat occaecat fugiat",
    "fileName": "robust_outflank.[object Object]",
    "isColor": true,
    "isDuplex": false,
    "plugInList": [
      {
        "plugInModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "esse ut et adipisicing qui"
      },
      {
        "plugInModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "dolor officia dolor et nulla"
      }
    ],
    "registeredLetter": "sit ipsum qui",
    "registeredLetterAdressLine1": "in mollit nostrud velit ad",
    "registeredLetterAdressLine2": "eiusmod d",
    "registeredLetterAdressLine3": "officia id enim tempor labore",
    "registeredLetterCity": "minim nostrud ea",
    "registeredLetterZipCode": null,
    "senderAdressLine1": "Lorem",
    "senderAdressLineComplete": null,
    "senderCity": null,
    "senderStreet": null,
    "senderZipCode": "Ut u",
    "testEMail": "tempor",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": "consequat qui "
  },
  {
    "addressLine1": "adipisi",
    "addressLine2": null,
    "addressLine3": "est",
    "addressLine4": null,
    "addressLine5": "deserunt",
    "batchID": 12345,
    "city": "Bayerport",
    "costCenter": null,
    "country": null,
    "coverData": null,
    "coverLetter": true,
    "custom1": "RE0136645",
    "custom2": "mollit deserunt e",
    "custom3": "id sint est voluptat",
    "custom4": null,
    "custom5": null,
    "data": "fugiat proident irure",
    "fileName": "innocent.[object Object]",
    "isColor": false,
    "isDuplex": true,
    "plugInList": null,
    "registeredLetter": null,
    "registeredLetterAdressLine1": null,
    "registeredLetterAdressLine2": null,
    "registeredLetterAdressLine3": "aliquip sunt dolore Lorem",
    "registeredLetterCity": null,
    "registeredLetterZipCode": null,
    "senderAdressLine1": null,
    "senderAdressLineComplete": null,
    "senderCity": null,
    "senderStreet": null,
    "senderZipCode": "ut",
    "testEMail": "exercitation",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "pariatur "
  },
  {
    "addressLine1": "reprehenderit in",
    "addressLine2": "velit deserunt pariatur laboris dolore",
    "addressLine3": "fugiat",
    "addressLine4": null,
    "addressLine5": null,
    "batchID": 12345,
    "city": "Petaluma",
    "costCenter": "eiusmo",
    "country": null,
    "coverData": "esse in",
    "coverLetter": true,
    "custom1": "RE0136645",
    "custom2": "non",
    "custom3": "elit magna proident",
    "custom4": "occaecat exerc",
    "custom5": null,
    "data": "enim cillum dolore adipisicing anim",
    "fileName": "hourly_calculus.[object Object]",
    "isColor": true,
    "isDuplex": false,
    "plugInList": null,
    "registeredLetter": "ut",
    "registeredLetterAdressLine1": null,
    "registeredLetterAdressLine2": null,
    "registeredLetterAdressLine3": "ad sit",
    "registeredLetterCity": null,
    "registeredLetterZipCode": "commodo Ut",
    "senderAdressLine1": "mollit qui voluptate",
    "senderAdressLineComplete": "occaecat laborum velit incididunt nisi",
    "senderCity": null,
    "senderStreet": "qui aliqua",
    "senderZipCode": "minim dolore mollit irure",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "dolore"
  },
  {
    "addressLine1": "irure reprehenderit nulla nisi Except",
    "addressLine2": null,
    "addressLine3": "voluptate aliqua dolor",
    "addressLine4": "cillum non incididunt anim",
    "addressLine5": null,
    "batchID": 12345,
    "city": "Bellflower",
    "costCenter": "laborum",
    "country": null,
    "coverData": "ullamco",
    "coverLetter": true,
    "custom1": "RE0136645",
    "custom2": "dolor veniam magna Ut irure",
    "custom3": "aliquip adipisicing commodo",
    "custom4": "eiusmod sit incididunt commodo in",
    "custom5": null,
    "data": "tempor",
    "fileName": "destock.[object Object]",
    "isColor": true,
    "isDuplex": false,
    "plugInList": [
      {
        "plugInModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "est"
      },
      {
        "plugInModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "aute aliquip"
      }
    ],
    "registeredLetter": "qui exercitatio",
    "registeredLetterAdressLine1": "Duis",
    "registeredLetterAdressLine2": null,
    "registeredLetterAdressLine3": null,
    "registeredLetterCity": "ullamco dolore",
    "registeredLetterZipCode": "ex deserunt labor",
    "senderAdressLine1": "cupidatat sunt u",
    "senderAdressLineComplete": null,
    "senderCity": "deserunt",
    "senderStreet": "qui sun",
    "senderZipCode": null,
    "testEMail": "eiusmod ut magna eu",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "fugiat dolore mollit amet incididunt",
    "zipCode": "Duis"
  }
]

Response Payload

[
  {
    "fileName": "adipisicing ",
    "letterID": 2450921878249357
  }
]

{
  "code": "Ut dolore",
  "date": null,
  "description": "sint fugiat",
  "level": "adipisicing"
}

{
  "code": "ea aute culpa cillum deserunt",
  "date": "1895-08-02T10:01:25.0Z",
  "description": "quis dolor velit non",
  "level": "culpa ipsum exercitation"
}

POST

/api/Letter/CancelQueued

Abbruch von Sendungen, die ausschlieslich über das Upload-Management Plugin eingeliefert wurden und noch nicht den Mindestmengenversand oder Terminversand erreicht haben. Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #token

Request Payload

[
  2827020613381909,
  -7069722288149151,
  -6242656406039947,
  -5674716785466443
]

Response Payload

[
  {
    "letterID": -4660029421403419,
    "message": "aute magna ",
    "successful": false
  },
  {
    "letterID": -4869273925398795,
    "message": "ea id nisi",
    "successful": true
  },
  {
    "letterID": 2235613706703945,
    "message": "elit sunt non",
    "successful": false
  },
  {
    "letterID": 4476008025441505,
    "message": "Duis eiusmod et dolore commodo",
    "successful": false
  }
]

{
  "code": "dolor",
  "date": null,
  "description": "cillum culpa ut ipsum",
  "level": "voluptate Ut"
}

{
  "code": "nostrud reprehenderit et eu",
  "date": null,
  "description": "dolor ipsum minim tempor adipisicing",
  "level": "pariatur aliquip incididunt id labore"
}

POST

/api/Letter/ReleaseQueued

Vorziehen von Sendungen, die ausschlieslich über das Upload-Management Plugin eingeliefert wurden und noch nicht den Mindestmengenversand oder Terminversand erreicht haben. Authentifizierung und Validierung der Sendungsabfrage erfolgt über Bearer-Token im Http-Header (Authorization: Bearer #tok

Request Payload

[
  -2231355463397783,
  8411565662504513,
  4454081141961885,
  -6998803120639195,
  -2550501971317643
]

Response Payload

[
  {
    "letterID": -4795720338100275,
    "message": "exercitation consectetur",
    "successful": false
  }
]

{
  "code": "laboris dolore consequat occaecat",
  "date": "1962-11-12T05:08:51.0Z",
  "description": "eiusmod anim",
  "level": "cupidatat sunt quis"
}

{
  "code": "labore proident",
  "date": null,
  "description": "ad occaecat",
  "level": "ullamco pariatur"
}

Login(4 operations)

POST

/api/Login

Anfrage eines gültigen JWT (JSON Web Token) für den Zugriff auf die weiteren Controller der E-POSTBUSINESS API. Beispiel-Anfrage: POST { "vendorID": "12345", "ekp": "1234567890", "secret": "77831f6f-d39b-4d5b-a5ae-b4006f894179", "password": "56789"

Request Payload

{
  "ekp": "elit culpa",
  "password": "mollit nostrud laboris offic",
  "secret": "cupidatat Ut anim",
  "tokenDuration": 79772081,
  "vendorID": "aliquip",
  "vendorSubID": "exercitation"
}

Response Payload

{
  "token": "Ut aute ipsum"
}

{
  "code": "labore enim adipisicing ipsum",
  "date": "1945-08-24T19:46:15.0Z",
  "description": "Duis dolor in anim",
  "level": "anim occaecat"
}

{
  "code": "irure qui laborum",
  "date": "1891-06-21T12:47:24.0Z",
  "description": "esse",
  "level": "in culpa ullamco magna"
}

{
  "code": "mollit Lorem non",
  "date": null,
  "description": "est",
  "level": "mollit consequat ullamco"
}

POST

/api/Login/smsRequest

Anfrage eines zeitlich begrenzten SMS-Code zur Verifizierung einer Passwortvergabe/änderung bzw. zur Aktivierung. Beispiel-Anfrage: POST { "vendorID": "12345", "ekp": "56789" }

Request Payload

{
  "ekp": "tempor lab",
  "vendorID": "reprehenderit anim"
}

Response Payload

in

{
  "code": "dolor nisi dolore ea irure",
  "date": null,
  "description": "dolor velit magna nulla in",
  "level": "amet reprehenderit ut"
}

{
  "code": "deserunt",
  "date": null,
  "description": "eu laborum quis labore",
  "level": "commodo veniam non cupidatat nisi"
}

{
  "code": "non",
  "date": "1930-11-22T18:17:34.0Z",
  "description": "anim exercitation veniam labore",
  "level": "minim adipisicing"
}

POST

/api/Login/setPassword

Speichert ein benutzerdefiniertes Passwort in der E-POSTBUSINESS API. Liefert bei Erfolg einen Sicherheitsschlüssel der E-POSTBUSINESS API (secret) zurück, welcher für die Login-Methode erforderlich ist und aktiviert die E-POSTBUSINESS API. Beispiel-Anfrage: POST { "ven

Request Payload

{
  "ekp": "deseruntvo",
  "newPassword": "voluptate",
  "smsCode": "volupt",
  "vendorID": "ipsum"
}

Response Payload

GET

/api/Login/HealthCheck

Abfrage des Verfügbarkeitsstatus der E-POSTBUSINESS API und Bereitstelllung von Wartungsfenstern, sowie möglicher Störungen.

Request Payload

Response Payload

{
  "code": "minim fugiat",
  "date": "1903-12-24T08:39:05.0Z",
  "description": "cupidatat Duis labore minim quis",
  "level": "est mollit"
}

{
  "code": "irure",
  "date": null,
  "description": "minim dolor officia cillum",
  "level": "fugiat"
}

{
  "code": "Duis mollit ad",
  "date": null,
  "description": "cillum qui consectetur",
  "level": "dolore"
}

PlugIn(3 operations)

GET

/api/PlugIn/Automover

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 Automo

Request Payload

Response Payload

{
  "parameters": null,
  "useAutomover": true
}

{
  "jsonAddressDataUsed": false,
  "parameters": [
    {
      "name": "reprehenderit incididunt irure",
      "value": "nisi qui ullamco sint commodo"
    }
  ],
  "useAutomover": true
}

GET

/api/PlugIn/UploadManagement

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

Request Payload

Response Payload

{
  "dueDate": "1969-07-23T15:32:54.0Z",
  "dueDayofWeek": null,
  "dueDays": null,
  "useMinimumQuantity": true
}

{
  "dueDate": null,
  "dueDayofWeek": null,
  "dueDays": null,
  "useMinimumQuantity": false
}

GET

/api/PlugIn/PremiumAdress

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 Pr

Request Payload

Response Payload

{
  "productVariants": "fugiat laboris aliqua Lorem"
}

{
  "premiumAdressResult": {
    "e_HNr": null,
    "e_Na1": null,
    "e_Na2": null,
    "e_Na3": null,
    "e_Na4": null,
    "e_Ort": null,
    "e_PLZ": "eiusm",
    "e_Postf": "sed occ",
    "e_Str": "laborum",
    "kd_HNr": "nostrud conse",
    "kd_Na1": "ips",
    "kd_Na2": null,
    "kd_Na3": "ut id eu commodo sed",
    "kd_Na4": null,
    "kd_Ort": "dolore nulla nisi",
    "kd_PLZ": "qui",
    "kd_Postf": "labori",
    "kd_Str": null,
    "nsA_HNr": null,
    "nsA_Land": null,
    "nsA_Land_Postf": null,
    "nsA_Na1": null,
    "nsA_Na2": null,
    "nsA_Na3": null,
    "nsA_Na4": "sint dolor culpa ad irure",
    "nsA_Ort": "aliqua",
    "nsA_Ort_Postf": "ex quis aute incididunt commodo",
    "nsA_PLZ": null,
    "nsA_PLZ_Postf": null,
    "nsA_Postf": null,
    "nsA_Str": "ea rep",
    "sdgS": 687269810
  },
  "productVariants": "sint incididunt esse officia"
}

Vendor(5 operations)

GET

/api/Vendor/LetterDetailsByDay

Anzahl versendeter Briefe (LetterStatus 4 'Verarbeitung im Druckzentrum'), gruppiert nach Sendungsdetails pro Tag. Es können maximal 400 Tage rückwirkend abgerufen werden. Hierzu wird das Druckdatum der Sendungen verwendet (Letterstatus: PrintFeedbackDate), welches auch für die Ermittlung der Abrec

Query Parameter Name	Example
`fromDate`	`1957-05-13T10:41:07.0Z`
`tillDate`	`1953-06-15T20:19:24.0Z`

Request Payload

Response Payload

[
  {
    "country": null,
    "ekp": "tempor qui",
    "isColor": false,
    "isDuplex": false,
    "letterCount": -1293942544,
    "printFeedbackDate": "1890-09-14T13:41:53.0Z",
    "registeredLetter": null,
    "vendorID": null
  },
  {
    "country": "voluptate enim ut nostrud",
    "ekp": "ipsum",
    "isColor": true,
    "isDuplex": true,
    "letterCount": 847529107,
    "printFeedbackDate": "1947-03-21T07:16:37.0Z",
    "registeredLetter": "velit nostrud",
    "vendorID": null
  },
  {
    "country": "deserunt",
    "ekp": null,
    "isColor": false,
    "isDuplex": false,
    "letterCount": 1970698946,
    "printFeedbackDate": "1946-07-31T09:21:46.0Z",
    "registeredLetter": null,
    "vendorID": null
  }
]

{
  "code": "nulla eiusmod",
  "date": null,
  "description": "minim qui",
  "level": "ipsum Lorem et id irure"
}

{
  "code": "commodo dolore",
  "date": "1960-10-15T08:18:31.0Z",
  "description": "nostrud Ut in",
  "level": "magna eu in"
}

{
  "code": "ad",
  "date": null,
  "description": "minim dolore consequat",
  "level": "et"
}

GET

/api/Vendor/CampaignDetails

Liste von CampaignStatus-Objekten über einen bestimmten Zeitraum. Es können maximal 400 Tage rückwirkend abgerufen werden. Hierzu wird das Erstelldatum einer Kampagne verwendet (CampaignStatus: 1 - initalized). Personenbezogene Kampagnen-Metadaten sind in dieser Liste ausgeblendet. Authentifizieru

Query Parameter Name	Example
`fromDate`	`1908-01-23T23:41:42.0Z`
`tillDate`	`1906-04-21T16:22:56.0Z`

Request Payload

Response Payload

Error generating example

{
  "code": "est",
  "date": null,
  "description": "in Ut nulla",
  "level": "do Excepteur mollit reprehenderit in"
}

{
  "code": "nisi in",
  "date": "1900-06-10T03:15:30.0Z",
  "description": "non ut adipisicing",
  "level": "deserunt laboris voluptate"
}

{
  "code": "ut dolore",
  "date": "1927-04-01T11:47:11.0Z",
  "description": "nulla nisi sint consequat",
  "level": "deserunt irure minim ullamco occaecat"
}

GET

/api/Vendor/LetterDetailsByDayAsCsv

Anzahl versendeter Briefe (LetterStatus 4 'Verarbeitung im Druckzentrum'), gruppiert nach Sendungsdetails pro Tag. Die Rückgabe erfolgt der CSV-Datei. Es können maximal 400 Tage rückwirkend abgerufen werden. Hierzu wird das Druckdatum der Sendungen verwendet (Letterstatus: PrintFeedbackDate), welch

Query Parameter Name	Example
`fromDate`	`1947-05-04T01:30:08.0Z`
`tillDate`	`1911-06-29T02:48:23.0Z`

Request Payload

Response Payload

Binary Content
(application/octet-stream)

{
  "code": "in non laborum voluptate ea",
  "date": null,
  "description": "dolore esse ex incididunt fugiat",
  "level": "enim do"
}

{
  "code": "enim",
  "date": "1920-10-03T13:27:47.0Z",
  "description": "occaecat adipisicing in fugiat",
  "level": "officia Ut eiusmod quis"
}

{
  "code": "ut Ut magna",
  "date": "1930-07-13T13:52:18.0Z",
  "description": "ullamco Duis deserunt",
  "level": "anim eiusmod in laboris deserunt"
}

GET

/api/Vendor/LettersWithError

Abruf eines LetterStatus-Arrays mit allen Kunden-Sendungen (ohne personenbezogene Daten), die in der Verarbeitung auf Fehler gelaufen sind (LetterStatus=99). Es werden nur Sendungen ohne Testflag berücksichtigt. Hierzu wird das Einlieferungsdatum der Sendungen (Letterstatus: CreateDate) verwendet.

Query Parameter Name	Example
`fromDate`	`1926-08-17T16:18:25.0Z`
`tillDate`	`1891-10-21T21:05:25.0Z`
`hideEKP`	`true`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "id occae",
    "country": "aute in",
    "coverLetter": true,
    "createdDate": "1921-10-11T02:04:15.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "veniam in",
    "custom4": null,
    "custom5": "enim cupidatat in",
    "destinationAreaStatus": "ea reprehenderit Ut consectetur",
    "destinationAreaStatusDate": "1925-11-17T07:38:17.0Z",
    "errorList": [
      {
        "code": "reprehenderit Duis ullamco in",
        "date": null,
        "description": "enim magna",
        "level": "laboris tempor"
      },
      {
        "code": "mollit do eu",
        "date": null,
        "description": "irure",
        "level": "ut reprehenderit"
      },
      {
        "code": "in",
        "date": null,
        "description": "ea magna laboris",
        "level": "ut"
      },
      {
        "code": "ea velit",
        "date": "1936-08-29T02:44:05.0Z",
        "description": "proident",
        "level": "ut et do labore"
      },
      {
        "code": "eu",
        "date": null,
        "description": "in ut minim",
        "level": "mollit laboris tempor"
      }
    ],
    "fileName": "ea ad",
    "frankierID": null,
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -341770407,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "ullamco"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "Lorem eiusmod nostrud nulla et"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "et do"
      }
    ],
    "printFeedbackDate": "1962-08-01T19:58:51.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": "ullamco",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1924-12-22T04:54:17.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 824084495,
    "subVendorID": null,
    "testEMail": "eiusmod",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "eiusmod pariatur ullamco in mollit",
    "zipCode": "eiusmod"
  },
  {
    "batchID": 12345,
    "city": "sed ut velit aliquip voluptate",
    "costCenter": null,
    "country": null,
    "coverLetter": false,
    "createdDate": "1946-07-10T21:25:03.0Z",
    "custom1": "RE0136645",
    "custom2": "veniam occaecat do voluptate sint",
    "custom3": "irure Excepteur minim mollit Lorem",
    "custom4": "elit Duis ut aute commodo",
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "sit aute pariatur",
        "date": "1942-08-30T04:24:39.0Z",
        "description": "ad",
        "level": "incididunt nostrud exercitation deserunt aute"
      }
    ],
    "fileName": "ullamco magna dolore",
    "frankierID": null,
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 1061557567,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1930-01-15T06:27:01.0Z",
    "printUploadDate": "1934-07-02T19:21:01.0Z",
    "processedDate": null,
    "registeredLetter": "labore non Ut",
    "registeredLetterID": null,
    "registeredLetterStatus": "commodo dolor proident aliquip Duis",
    "registeredLetterStatusDate": "1936-05-02T21:27:18.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1076223144,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "magna labore",
    "zipCode": "Duis"
  },
  {
    "batchID": 12345,
    "city": "irure",
    "costCenter": "",
    "country": null,
    "coverLetter": false,
    "createdDate": "1953-11-01T12:51:20.0Z",
    "custom1": "RE0136645",
    "custom2": "non esse veniam",
    "custom3": null,
    "custom4": "irure exercitation anim sit",
    "custom5": null,
    "destinationAreaStatus": "dolor et",
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "minim occaecat",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1154814303,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "amet fugiat occaecat adipisicing"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": "1905-02-17T19:03:10.0Z",
    "processedDate": "1931-04-19T13:02:51.0Z",
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": "ex laborum deserunt",
    "registeredLetterStatusDate": "1968-05-24T17:59:44.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1281756902,
    "subVendorID": null,
    "testEMail": "aliqua Excepteur",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "culpa officia",
    "zipCode": "dolore adipisicing in quis"
  },
  {
    "batchID": 12345,
    "city": "id ex",
    "costCenter": "cillum ",
    "country": "ut non in fugiat",
    "coverLetter": true,
    "createdDate": "1900-04-07T09:36:10.0Z",
    "custom1": "RE0136645",
    "custom2": "occaecat do esse sit amet",
    "custom3": null,
    "custom4": null,
    "custom5": "laborum ea aliqua",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1951-06-04T07:12:58.0Z",
    "errorList": null,
    "fileName": "aliquip sed",
    "frankierID": "magna aute culpa velit veniam",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 1761377063,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1969-10-08T10:42:53.0Z",
    "printUploadDate": "1898-01-16T12:01:44.0Z",
    "processedDate": "1963-07-29T10:47:01.0Z",
    "registeredLetter": null,
    "registeredLetterID": "Excepteur Lorem eu",
    "registeredLetterStatus": "sit",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1783547696,
    "subVendorID": "sunt pariatur",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "pariatur officia ad labore in",
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "labore do sed laboris",
    "costCenter": null,
    "country": "mollit consectetur reprehenderit laborum",
    "coverLetter": false,
    "createdDate": "1907-05-07T15:16:10.0Z",
    "custom1": "RE0136645",
    "custom2": "nisi incididunt",
    "custom3": "sint nisi",
    "custom4": "consequat",
    "custom5": null,
    "destinationAreaStatus": "irure ex dolore",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "nulla exercitation in magna enim",
        "date": "1934-09-16T20:05:52.0Z",
        "description": "cillum amet dolore ut sint",
        "level": "Lorem"
      },
      {
        "code": "minim laboris fugiat incididunt",
        "date": null,
        "description": "anim ut labore do",
        "level": "dolor est"
      },
      {
        "code": "voluptate",
        "date": "1890-03-26T17:55:45.0Z",
        "description": "occaecat nulla",
        "level": "dolor"
      },
      {
        "code": "culpa proident in eiusmod",
        "date": "1924-12-09T03:47:09.0Z",
        "description": "irure labore laboris",
        "level": "Lorem Excepteur cillum amet Ut"
      },
      {
        "code": "cillum",
        "date": null,
        "description": "quis",
        "level": "eu mollit sunt"
      }
    ],
    "fileName": "nostrud minim officia nisi",
    "frankierID": "ad commodo laborum proident",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1429721704,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": "1916-04-09T10:45:01.0Z",
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": "sit labore voluptate consectetur adipisicing",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1453501126,
    "subVendorID": "minim anim",
    "testEMail": "tempor cupidatat quis esse",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "reprehenderit in"
  }
]

{
  "code": "quis magna sit eiusmod ad",
  "date": null,
  "description": "sit commodo nulla id",
  "level": "eu ut"
}

{
  "code": "ullamco velit enim fugiat",
  "date": "1898-04-25T16:16:12.0Z",
  "description": "in aliqua cillum adipisicing",
  "level": "tempor labore"
}

{
  "code": "dolore aliqua veniam eu",
  "date": "1922-08-31T02:43:10.0Z",
  "description": "culpa ut occaecat cillum",
  "level": "commodo tempor"
}

POST

/api/Vendor/SetContactInformations

Ändern der Kontaktdaten für den technischen und fachlichen Ansprechpartner. Diese Kontaktdaten sind komplett unabhängig von Login Daten aus dem Client-Pfad (bspw. /api/Client/SetEMail , /api/Client/SetMobile). Diese Vendor-spezifischen Informationen sind der eigenen Kundennummer (EKP) und VendorI

Query Parameter Name	Example
`technicalContact`	`esse in nisi`
`technicalPhone`	No example
`technicalEmail`	No example
`businessContact`	No example
`businessPhone`	`nulla`
`businessEmail`	`eu sunt nostrud`

Request Payload

Response Payload

mollit nulla ut laborum

{
  "code": "occaecat cillum irure",
  "date": null,
  "description": "sit consectetur",
  "level": "Ut aliquip"
}

{
  "code": "esse quis elit id",
  "date": null,
  "description": "ut ea do tempor est",
  "level": "id"
}

Service Homepage: developer.dhl.com/api-reference/deutsche-post-hybrid-mail-shipments-e-post-post-parcel-germany#reference-docs-section

dhllogisticsmailepostdocument-processing