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": "aute quis proident",
  "addressCompany1": "volup",
  "addressCompany2": null,
  "addressCompany3": "sed quis eu labore esse",
  "addressCompany4": null,
  "addressStreet": null,
  "addressZipCode": "",
  "campaignAddressList": null,
  "campaignName": "est esse",
  "data": "non ex culpa cupidatat",
  "isDuplex": true,
  "noOfPages": -850258200,
  "palDate": "1947-02-13T12:44:36.0Z",
  "quantity": -1466568956,
  "senderLine": null,
  "userEMail": "amet in ullamco",
  "userFirstName": "commodo",
  "userLastName": "in",
  "userPhone": "nisi Lorem",
  "userSalutation": "mag",
  "userTitle": "con",
  "useSenderLine": false,
  "vendorSystemInformation": null
}

Response Payload

Error generating example

{
  "code": "deserunt do",
  "date": null,
  "description": "officia anim",
  "level": "esse voluptate officia ullamco sit"
}

{
  "code": "eu quis consequat ipsum in",
  "date": null,
  "description": "do id minim esse dolor",
  "level": "labore"
}

{
  "code": "dolore",
  "date": "1940-11-22T15:25:03.0Z",
  "description": "amet",
  "level": "pariatur qui incididunt id"
}

POST

/api/Campaign/SampleRequest

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

Request Payload

{
  "addressCity": "consectetur",
  "addressCompany1": "anim",
  "addressCompany2": "Excepteur exercitation",
  "addressCompany3": null,
  "addressCompany4": null,
  "addressStreet": "ut ullamco Duis irure",
  "addressZipCode": "ut do",
  "campaignAddressList": [
    {
      "addressLine1": "elit proident i",
      "addressLine2": null,
      "addressLine3": null,
      "addressLine4": null,
      "addressLine5": null,
      "addressLine6": null,
      "countryCode": null,
      "zipCode": "cupidata"
    }
  ],
  "campaignName": "ullamco Duis aute",
  "data": "non commodo dolor amet",
  "isDuplex": true,
  "noOfPages": 1703817526,
  "palDate": "1915-03-01T21:24:45.0Z",
  "quantity": 1302580617,
  "senderLine": null,
  "userEMail": "ut",
  "userFirstName": "ut enim tempor est cons",
  "userLastName": "est proident irure ea",
  "userPhone": "sed sint",
  "userSalutation": null,
  "userTitle": null,
  "useSenderLine": true,
  "vendorSystemInformation": "pariatur"
}

Response Payload

[
  {
    "fileName": "eu",
    "letterID": -8333531952276367
  }
]

{
  "code": "consectetur eiusmod tempor in in",
  "date": null,
  "description": "enim",
  "level": "sed nisi labore in veniam"
}

{
  "code": "ea commodo officia aute",
  "date": "1942-11-03T07:49:40.0Z",
  "description": "deserunt fugiat veniam ipsum",
  "level": "dolore eiusmod id"
}

{
  "code": "cillum",
  "date": "1933-10-10T06:15:13.0Z",
  "description": "in",
  "level": "aliqua consequat fugiat voluptate pariatur"
}

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": "cupidatat deserunt",
    "letterID": 3985240320407837
  },
  {
    "fileName": "veniam adipisicing eiusmod ex deserunt",
    "letterID": -5119667405189807
  }
]

Response Payload

[
  {
    "campaignID": 1766961250856969,
    "data": null,
    "errorList": [
      {
        "code": "cupidatat sed cillum",
        "date": null,
        "description": "sunt consectetur reprehenderit elit sint",
        "level": "exercitation sit in"
      },
      {
        "code": "esse magna voluptate quis",
        "date": "1926-06-26T11:08:17.0Z",
        "description": "dolore occaecat velit cupidatat",
        "level": "Ut officia"
      }
    ],
    "letterID": -3587407543034315,
    "position": 2070819286,
    "statusDetails": null,
    "statusID": 831626767
  },
  {
    "campaignID": 2383830538355845,
    "data": null,
    "errorList": [
      {
        "code": "dolore enim",
        "date": "1936-10-16T06:17:45.0Z",
        "description": "laboris adipisicing labore officia sed",
        "level": "voluptate Duis occaecat ea"
      },
      {
        "code": "irure in",
        "date": null,
        "description": "fugiat enim",
        "level": "veniam mollit irure"
      }
    ],
    "letterID": -1838748255512007,
    "position": 1525872327,
    "statusDetails": null,
    "statusID": 912705554
  },
  {
    "campaignID": 2348726350549477,
    "data": null,
    "errorList": [
      {
        "code": "aliquip adipisicing",
        "date": null,
        "description": "ad",
        "level": "deserunt culpa ex veniam aliqua"
      },
      {
        "code": "elit qui",
        "date": "1959-11-27T14:56:23.0Z",
        "description": "qui incididunt adipisicing",
        "level": "commodo Excepteur sint"
      }
    ],
    "letterID": -5065129040606471,
    "position": 1693679649,
    "statusDetails": null,
    "statusID": 2074008142
  }
]

{
  "code": "incididunt cupidatat proident",
  "date": null,
  "description": "Lorem",
  "level": "veniam"
}

{
  "code": "incididunt sed",
  "date": null,
  "description": "occaecat ad dolore dolor",
  "level": "officia aute in"
}

{
  "code": "aute nostrud",
  "date": "1891-12-13T22:59:55.0Z",
  "description": "eiusmod sunt Lorem occaecat ex",
  "level": "ea aute dolore occaecat"
}

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": "si",
  "addressCompany1": "in minim",
  "addressCompany2": null,
  "addressCompany3": null,
  "addressCompany4": null,
  "addressStreet": null,
  "addressZipCode": "",
  "campaignAddressList": [
    {
      "addressLine1": "dolor cillum cupidatat",
      "addressLine2": "dolor",
      "addressLine3": null,
      "addressLine4": null,
      "addressLine5": null,
      "addressLine6": null,
      "countryCode": null,
      "zipCode": "mollit "
    },
    {
      "addressLine1": "sunt",
      "addressLine2": "esse Ut",
      "addressLine3": null,
      "addressLine4": null,
      "addressLine5": "et laboris nisi aliqua amet",
      "addressLine6": null,
      "countryCode": "laboris proide",
      "zipCode": "reprehenderit id"
    }
  ],
  "campaignName": "laboris anim quis cupidatat consequat",
  "data": "do eu quis",
  "isDuplex": false,
  "noOfPages": 316723450,
  "palDate": "1963-08-08T22:57:28.0Z",
  "quantity": -428324991,
  "senderLine": "est reprehenderit",
  "userEMail": "aliqua ut Duis commodo sed",
  "userFirstName": "exercitation minim ex Excepteur sit",
  "userLastName": "voluptate amet dolor",
  "userPhone": "nostrud tempor dolor non ",
  "userSalutation": "ad",
  "userTitle": null,
  "useSenderLine": true,
  "vendorSystemInformation": "anim laboris ut"
}

Response Payload

-2382615816650339

{
  "code": "ipsum cupidatat cillum",
  "date": null,
  "description": "anim qui ea",
  "level": "est id"
}

{
  "code": "laborum labore",
  "date": "1948-10-08T06:27:49.0Z",
  "description": "qui exercitation eiusmod sint magna",
  "level": "labore"
}

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": "quis ullamco fugiat",
  "date": "1905-03-21T11:37:33.0Z",
  "description": "ad occaecat et",
  "level": "culpa"
}

{
  "code": "sit",
  "date": "1939-12-06T19:29:32.0Z",
  "description": "enim esse",
  "level": "sit officia id"
}

{
  "code": "occaecat",
  "date": null,
  "description": "do nulla",
  "level": "sunt elit Duis Lorem dolore"
}

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": -3715811779896479,
    "data": "magna aliquip est eu",
    "errorList": [
      {
        "code": "esse pariatur occaecat",
        "date": null,
        "description": "cupidatat dolor et",
        "level": "in mollit"
      },
      {
        "code": "nisi ullamco tempor non consectetur",
        "date": "1904-09-13T08:51:21.0Z",
        "description": "veniam ut in qui magna",
        "level": "Ut ex"
      },
      {
        "code": "adipisicing",
        "date": "1892-06-25T05:15:30.0Z",
        "description": "esse sint tempor eu",
        "level": "occaecat"
      },
      {
        "code": "ea",
        "date": null,
        "description": "voluptate eu ea ut commodo",
        "level": "irure culpa consequat"
      }
    ],
    "letterID": -1962897294533635,
    "position": 388245567,
    "statusDetails": "do",
    "statusID": -244427004
  },
  {
    "campaignID": -8001188858252623,
    "data": "elit in ad aliqua aute",
    "errorList": [
      {
        "code": "in Lorem voluptate in pariatur",
        "date": "1891-02-09T20:30:04.0Z",
        "description": "anim adipisicing eiusmod mollit",
        "level": "aute do elit reprehenderit"
      },
      {
        "code": "labore ullamco deserunt irure",
        "date": "1958-07-28T21:55:14.0Z",
        "description": "labore mollit eiusmod",
        "level": "do"
      }
    ],
    "letterID": -3096856209708187,
    "position": 785411448,
    "statusDetails": null,
    "statusID": 1449800278
  }
]

{
  "code": "quis dolore tempor",
  "date": "1903-06-22T07:01:37.0Z",
  "description": "laboris",
  "level": "ut"
}

{
  "code": "sed",
  "date": "1932-08-26T23:50:04.0Z",
  "description": "in incididunt",
  "level": "ut"
}

{
  "code": "laboris id consectetur",
  "date": null,
  "description": "aute velit magna veniam sed",
  "level": "dolore esse quis 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": "nisi eiusmod Lorem",
  "addressCompany1": "si",
  "addressCompany2": "la",
  "addressCompany3": null,
  "addressCompany4": null,
  "addressStreet": null,
  "addressZipCode": "si",
  "campaignID": -8685753985692143,
  "campaignName": "ea laboris sit",
  "ekp": "dolor moll",
  "finalizeInfoDate": "1954-12-29T20:32:16.0Z",
  "grossTotalPrice": 41774376.8417128,
  "isColor": true,
  "isDuplex": false,
  "noOfPages": -1503439380,
  "palDate": "1962-04-11T11:03:07.0Z",
  "postagePrice": 87896952.70444015,
  "printPrice": null,
  "quantity": -840755745,
  "senderLine": null,
  "tax": 7338956.248212948,
  "termsOfContract": "qui nisi aliquip ipsum",
  "termsOfContractUrl": "ut veniam",
  "totalPrice": null,
  "userEMail": "laborum",
  "useSenderLine": false
}

{
  "code": "id aute",
  "date": "1953-12-07T16:49:36.0Z",
  "description": "deserunt",
  "level": "fugiat ex dolor ea occaecat"
}

{
  "code": "elit",
  "date": null,
  "description": "est ad eiusmod tempor aliquip",
  "level": "consectetur id deserunt"
}

{
  "code": "nulla sint Lorem",
  "date": "1936-11-01T22:13:28.0Z",
  "description": "cillum voluptate magna occaecat minim",
  "level": "do"
}

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": "nulla sed",
  "addressCompany1": "i",
  "addressCompany2": "ad ipsum e",
  "addressCompany3": "anim et minim ut reprehenderit",
  "addressCompany4": "cupidatat do ullamco Exc",
  "addressStreet": null,
  "addressZipCode": "no",
  "campaignID": -6017899316804943,
  "campaignName": "deserunt minim mollit velit incididunt",
  "ekp": "veniam con",
  "finalizeInfoDate": "1958-11-06T17:31:09.0Z",
  "grossTotalPrice": 51619279.28945178,
  "isColor": true,
  "isDuplex": true,
  "noOfPages": 1897987651,
  "palDate": "1928-11-20T13:42:04.0Z",
  "postagePrice": 36502945.2653372,
  "printPrice": null,
  "quantity": 1745474520,
  "senderLine": "proident e",
  "tax": null,
  "termsOfContract": null,
  "termsOfContractUrl": null,
  "totalPrice": -30784588.819020316,
  "userEMail": "aute ex",
  "useSenderLine": true
}

Response Payload

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

{
  "code": "pariatur amet",
  "date": "1900-03-20T14:39:42.0Z",
  "description": "velit aliqua non",
  "level": "laboris amet"
}

{
  "code": "do mollit cillum magna",
  "date": "1953-12-31T09:10:07.0Z",
  "description": "ut pariatur",
  "level": "do culpa qui dolore"
}

{
  "code": "irure",
  "date": "1965-03-03T21:01:46.0Z",
  "description": "velit",
  "level": "commodo consectetur dolore amet sint"
}

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": "labore Duis dolore elit non",
  "date": null,
  "description": "nostrud tempor velit",
  "level": "cillum amet est Excepteur"
}

{
  "code": "consequat pariatur in quis ad",
  "date": null,
  "description": "laborum proident ea",
  "level": "ex occaecat aliquip adipisicing"
}

{
  "code": "officia consectetur enim laboris Lorem",
  "date": null,
  "description": "cillum",
  "level": "dolor anim"
}

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": "nisi amet",
  "date": "1908-12-03T07:41:30.0Z",
  "description": "ipsum cupidatat mollit",
  "level": "culpa do"
}

{
  "code": "in veniam",
  "date": "1934-07-28T07:42:45.0Z",
  "description": "officia magna labore",
  "level": "officia reprehenderit"
}

{
  "code": "sed proident tempor laborum",
  "date": null,
  "description": "id",
  "level": "Ut"
}

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`	`1964-05-03T22:17:17.0Z`
`tillDate`	`1956-08-13T03:49:12.0Z`

Request Payload

Response Payload

Error generating example

{
  "code": "ut",
  "date": null,
  "description": "ea culpa",
  "level": "dolor minim esse"
}

{
  "code": "labore sed ipsum incididunt ut",
  "date": "1954-05-16T20:12:39.0Z",
  "description": "in enim occaecat",
  "level": "minim in exercitation"
}

{
  "code": "aliquip esse laborum",
  "date": null,
  "description": "reprehenderit non id incididunt tempor",
  "level": "Duis laboris tempor Ut"
}

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

[
  4736749698471285,
  -7312325078957647,
  -4474233634180619
]

Response Payload

Error generating example

{
  "code": "sed labore eiusmod ullamco",
  "date": null,
  "description": "aliquip Duis minim nisi",
  "level": "voluptate in irure magna eiusmod"
}

{
  "code": "anim laborum",
  "date": "1953-12-01T15:01:49.0Z",
  "description": "consectetur",
  "level": "aliquip"
}

{
  "code": "sed dolor tempor",
  "date": "1931-09-01T10:04:07.0Z",
  "description": "in deserunt qui est labore",
  "level": "elit adipisicing in non dolor"
}

{
  "code": "mollit est non ad",
  "date": null,
  "description": "quis anim officia",
  "level": "do in voluptate Lorem"
}

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`	No example

Request Payload

Response Payload

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

{
  "code": "Lorem",
  "date": "1908-09-04T17:25:21.0Z",
  "description": "velit ex",
  "level": "et commodo anim"
}

{
  "code": "in veniam quis sed",
  "date": null,
  "description": "magna nostrud",
  "level": "occaecat"
}

{
  "code": "ea in occaecat",
  "date": null,
  "description": "Ut amet consequat exercitation sint",
  "level": "laboris nostrud"
}

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`	`consequat`
`code`	No example

Request Payload

Response Payload

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

{
  "code": "ut dolore",
  "date": null,
  "description": "dolore exercitation Excepteur fugiat cillum",
  "level": "reprehenderit nostrud"
}

{
  "code": "ullamco dolor Ut est",
  "date": "1949-09-22T10:15:11.0Z",
  "description": "voluptate exercitation mollit cupidatat velit",
  "level": "Duis in"
}

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`	`Excepteur eiusmod`

Request Payload

Response Payload

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

{
  "code": "incididunt",
  "date": "1897-07-02T10:28:34.0Z",
  "description": "ullamco consectetur",
  "level": "dolore veniam qui laboris"
}

{
  "code": "consequat id esse ipsum",
  "date": "1963-11-02T19:04:41.0Z",
  "description": "do ut dolor sit",
  "level": "Ut ut irure anim"
}

{
  "code": "dolore laborum",
  "date": null,
  "description": "reprehenderit velit occaecat",
  "level": "esse est mollit et"
}

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`	`non velit fugiat quis`
`code`	No example

Request Payload

Response Payload

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

{
  "code": "ea",
  "date": null,
  "description": "consectetur sit ullamco tempor",
  "level": "irure"
}

{
  "code": "est culpa laborum",
  "date": "1936-02-19T11:44:16.0Z",
  "description": "dolor officia est",
  "level": "quis sed labore"
}

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": "in esse",
  "date": null,
  "description": "amet sed",
  "level": "in proident"
}

{
  "code": "sed velit id ex mollit",
  "date": null,
  "description": "quis",
  "level": "pariatur velit"
}

{
  "code": "et sint nisi",
  "date": "1947-06-13T13:40:26.0Z",
  "description": "proident id Excepteur",
  "level": "culpa"
}

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": "ullamco sint",
  "date": "1922-11-11T04:55:11.0Z",
  "description": "consectetur ad labore",
  "level": "exercitation cillum aute velit Lorem"
}

{
  "code": "labore ipsum consequat",
  "date": "1915-06-04T22:40:14.0Z",
  "description": "ut dolor",
  "level": "labore reprehenderit laboris"
}

{
  "code": "est sed magna elit",
  "date": null,
  "description": "pariatur voluptate",
  "level": "incididunt occaecat in esse dolor"
}

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": null,
  "costCenter": "tempor",
  "country": "pariatur in nisi",
  "coverLetter": true,
  "createdDate": "1937-05-08T01:24:10.0Z",
  "custom1": "RE0136645",
  "custom2": null,
  "custom3": "fugiat",
  "custom4": null,
  "custom5": "sed Ut",
  "destinationAreaStatus": null,
  "destinationAreaStatusDate": "1897-01-01T06:54:36.0Z",
  "errorList": [
    {
      "code": "sit dolore culpa do voluptate",
      "date": null,
      "description": "occaecat elit qui esse irure",
      "level": "ut"
    },
    {
      "code": "mollit officia",
      "date": "1923-08-04T03:39:46.0Z",
      "description": "ut non aliqua aute et",
      "level": "anim ea"
    }
  ],
  "fileName": "Excepteur non sint velit laboris",
  "frankierID": null,
  "isColor": false,
  "isDuplex": false,
  "letterID": 43556780,
  "noOfPages": -1341655442,
  "plugInFeedbackList": null,
  "printFeedbackDate": null,
  "printUploadDate": "1965-05-02T12:09:19.0Z",
  "processedDate": null,
  "registeredLetter": "labore commodo laborum",
  "registeredLetterID": "ipsum irure ut",
  "registeredLetterStatus": "dolore exercitation consectetur minim enim",
  "registeredLetterStatusDate": "1952-07-25T03:01:23.0Z",
  "statusDetails": "Einlieferung in Druckzentrum",
  "statusID": 366475277,
  "subVendorID": "eu adipisicing officia sit ea",
  "testEMail": "exercitation Ut",
  "testFlag": true,
  "testShowRestrictedArea": false,
  "vendorSystemInformation": "dolore",
  "zipCode": null
}

{
  "code": "nisi qui Lorem non sint",
  "date": null,
  "description": "Excepteur reprehenderit",
  "level": "ex"
}

{
  "code": "aliqua",
  "date": "1917-08-30T02:03:38.0Z",
  "description": "ipsum",
  "level": "id irure Duis sunt"
}

{
  "code": "adipisicing Ut mollit exercitation",
  "date": null,
  "description": "dolore in deserunt",
  "level": "amet ipsum irure"
}

{
  "code": "qui consequat culpa incididunt",
  "date": null,
  "description": "labore sed mollit",
  "level": "magna reprehenderit cupidatat dolor"
}

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`	`-5582995647952819`

Request Payload

Response Payload

{
  "data": "commodo culpa",
  "fileName": null,
  "letterID": 7149633102820213
}

{
  "code": "Excepteur veniam sit exercitation proident",
  "date": null,
  "description": "ad laboris",
  "level": "consectetur adipisicing"
}

{
  "code": "magna ad pariatur",
  "date": "1917-10-06T15:40:53.0Z",
  "description": "exercitation magna",
  "level": "ex in nisi magna"
}

{
  "code": "dolor ad",
  "date": null,
  "description": "cupidatat",
  "level": "tempor consequat"
}

{
  "code": "reprehenderit commodo occaecat",
  "date": "1951-11-17T23:24:17.0Z",
  "description": "Lorem sint",
  "level": "cupidatat in deserunt"
}

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`	`-873799887`
`onlyIssues`	`false`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "offi",
    "country": "ut",
    "coverLetter": true,
    "createdDate": "1952-01-19T04:51:51.0Z",
    "custom1": "RE0136645",
    "custom2": "anim mollit",
    "custom3": "do laboris Lorem ullamco ea",
    "custom4": null,
    "custom5": "culpa consectetur eu",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "qui ipsum consequat adipisicing",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 995423859,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1928-03-01T13:01:04.0Z",
    "printUploadDate": "1929-08-02T20:16:49.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": "et ut incididunt ullamco in",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -185941472,
    "subVendorID": "nostrud",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "sed non qui occaecat cillum",
    "zipCode": "esse tempor"
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "",
    "country": null,
    "coverLetter": false,
    "createdDate": "1957-08-12T04:02:12.0Z",
    "custom1": "RE0136645",
    "custom2": "id cillum dolor",
    "custom3": "magna Ut ut",
    "custom4": "irure",
    "custom5": "dolor et Ut cupidatat",
    "destinationAreaStatus": "nulla",
    "destinationAreaStatusDate": "1959-06-21T12:13:33.0Z",
    "errorList": null,
    "fileName": "ullamco exercitation dolore nostrud laboris",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -829200014,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1910-02-21T12:20:45.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": "anim in sint",
    "registeredLetterStatusDate": "1943-04-09T06:28:08.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -822585075,
    "subVendorID": "do laborum voluptate sunt",
    "testEMail": "ad sint qui deserunt",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "reprehenderit est Duis",
    "zipCode": "pariatur ullamco"
  }
]

{
  "code": "consectetur nostrud elit",
  "date": "1920-08-21T18:48:15.0Z",
  "description": "deserunt eiusmod officia cupidatat commodo",
  "level": "elit laboris tempor"
}

{
  "code": "ea do cupidatat",
  "date": null,
  "description": "reprehenderit Duis eiusmod sit",
  "level": "adipisicing sint dolore amet"
}

{
  "code": "ut incididunt dolore id elit",
  "date": null,
  "description": "eu tempor sunt",
  "level": "est sunt ad Ut ipsum"
}

{
  "code": "occaecat est Excepteur",
  "date": null,
  "description": "nostrud nisi do",
  "level": "culpa exercitation nisi Excepteur aliqua"
}

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": null,
    "costCenter": "qui cup",
    "country": null,
    "coverLetter": false,
    "createdDate": "1920-02-09T20:05:28.0Z",
    "custom1": "RE0136645",
    "custom2": "esse voluptate laborum culpa",
    "custom3": "laborum cupidatat anim",
    "custom4": null,
    "custom5": "reprehenderit nulla Excepteur",
    "destinationAreaStatus": "exercitation velit commodo sed",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "do quis aute aliquip",
        "date": "1963-02-28T09:39:09.0Z",
        "description": "fugiat occaecat",
        "level": "minim nisi aliquip sint"
      },
      {
        "code": "reprehenderit dolore Ut exercitation amet",
        "date": "1938-12-18T20:10:09.0Z",
        "description": "dolor et ad ipsum non",
        "level": "consequat"
      },
      {
        "code": "nisi",
        "date": "1897-07-27T08:20:51.0Z",
        "description": "deserunt",
        "level": "occaecat"
      },
      {
        "code": "nisi",
        "date": "1948-04-24T22:14:19.0Z",
        "description": "ex dolore in esse",
        "level": "ut aliquip id"
      }
    ],
    "fileName": "culp",
    "frankierID": "fugiat ad",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 194323148,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1969-07-16T02:22:39.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1373062656,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "do Excepteur",
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "et",
    "costCenter": "quis tem",
    "country": "commodo culpa",
    "coverLetter": true,
    "createdDate": "1960-06-29T21:22:38.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "dolor tempor mollit aute",
    "custom4": "magna",
    "custom5": "et magna velit consequat",
    "destinationAreaStatus": "cupidatat",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "dolore minim do ad ut",
        "date": null,
        "description": "et",
        "level": "enim veniam ut"
      },
      {
        "code": "Ut ullamco eu",
        "date": null,
        "description": "exercitation",
        "level": "exercitation dolore laborum"
      },
      {
        "code": "in amet nulla",
        "date": null,
        "description": "ex qui Ut consequat",
        "level": "Excepteur in in officia et"
      },
      {
        "code": "mollit qui consequat",
        "date": null,
        "description": "qui eu",
        "level": "deserunt aliquip fugiat dolore"
      },
      {
        "code": "enim nostrud ipsum laboris",
        "date": null,
        "description": "incididunt mollit",
        "level": "esse cupidatat ex ad ea"
      }
    ],
    "fileName": "officia esse nisi",
    "frankierID": null,
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1663977243,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "sint adipisicing ad anim enim"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "enim"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": "1933-06-10T11:33:28.0Z",
    "registeredLetter": "reprehenderit qui laboris in ut",
    "registeredLetterID": "sunt",
    "registeredLetterStatus": "eiusmod aliquip labore ullamco proident",
    "registeredLetterStatusDate": "1940-02-11T12:56:24.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1260096098,
    "subVendorID": "occaecat sint elit ea non",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "occaecat velit aute cupidatat"
  }
]

{
  "code": "dolore",
  "date": null,
  "description": "laborum magna anim Excepteur",
  "level": "incididunt exercitation et"
}

{
  "code": "et proident qui",
  "date": null,
  "description": "occaecat",
  "level": "qui"
}

{
  "code": "minim sed",
  "date": "1919-08-12T14:23:54.0Z",
  "description": "irure magna est",
  "level": "eiusmod in ut ipsum"
}

{
  "code": "Ut exercitation id anim",
  "date": null,
  "description": "Lorem labore",
  "level": "veniam"
}

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`	`1940-09-15T04:15:52.0Z`
`tillDate`	`1964-01-16T09:59:13.0Z`
`onlyIssues`	`true`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": "ullamco eiusmod nulla occaecat ut",
    "costCenter": null,
    "country": "incididunt",
    "coverLetter": true,
    "createdDate": "1902-04-17T15:35:52.0Z",
    "custom1": "RE0136645",
    "custom2": "officia dolor id culpa",
    "custom3": "magna elit",
    "custom4": "nulla ad consequat ullamco elit",
    "custom5": "consectetur nostrud exercitation Ut enim",
    "destinationAreaStatus": "Lorem quis sed",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "dolor in elit",
        "date": null,
        "description": "dolor officia",
        "level": "voluptate"
      },
      {
        "code": "ea do occaecat dolor aliquip",
        "date": null,
        "description": "consectetur occaecat",
        "level": "magna qui"
      },
      {
        "code": "Lorem eu ex",
        "date": null,
        "description": "in dolor irure enim",
        "level": "eu occaecat est elit"
      },
      {
        "code": "amet commodo nisi",
        "date": "1890-02-10T18:50:44.0Z",
        "description": "commodo sed",
        "level": "eu et dolor amet mollit"
      },
      {
        "code": "sint Excepteur cillum Duis",
        "date": null,
        "description": "ullamco cillum ex",
        "level": "aliqua"
      }
    ],
    "fileName": "sit magna",
    "frankierID": null,
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1053121813,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": "1956-01-31T09:40:37.0Z",
    "processedDate": "1937-08-01T15:01:59.0Z",
    "registeredLetter": null,
    "registeredLetterID": "ipsum occaecat qui commodo",
    "registeredLetterStatus": "ea",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 663381921,
    "subVendorID": "anim aliqua elit",
    "testEMail": "minim laboris incididunt",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "Lorem l",
    "country": null,
    "coverLetter": true,
    "createdDate": "1924-11-11T09:10:54.0Z",
    "custom1": "RE0136645",
    "custom2": "incididunt nisi",
    "custom3": null,
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": "exercitation id Ut eu",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "tempor voluptate officia ea cupidatat",
        "date": "1926-01-13T21:11:07.0Z",
        "description": "aliqua occaecat reprehenderit",
        "level": "irure reprehenderit nulla laborum voluptate"
      },
      {
        "code": "Duis Lorem eu do occaecat",
        "date": "1959-05-19T04:33:05.0Z",
        "description": "sunt cupidatat id",
        "level": "sint"
      }
    ],
    "fileName": "aliquip deserunt aute",
    "frankierID": "labore adipisicing magna irure",
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 2089912954,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "est"
      }
    ],
    "printFeedbackDate": "1948-02-21T22:34:24.0Z",
    "printUploadDate": "1898-04-25T06:36:48.0Z",
    "processedDate": "1940-11-07T09:27:16.0Z",
    "registeredLetter": "aliqua id dolore commodo Excepteur",
    "registeredLetterID": "in aliquip sed cillum dolore",
    "registeredLetterStatus": "id ex est aute",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1607384661,
    "subVendorID": "cillum dolor esse veniam",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "id exercitation est minim",
    "zipCode": null
  }
]

{
  "code": "eiusmod sint Excepteur nostrud",
  "date": null,
  "description": "tempor Excepteur commodo enim adipisicing",
  "level": "non id voluptate eiusmod"
}

{
  "code": "eiusmod aute",
  "date": "1924-10-28T02:30:53.0Z",
  "description": "sunt Ut",
  "level": "consequat laboris incididunt"
}

{
  "code": "ipsum eu",
  "date": null,
  "description": "adipisicing est sit",
  "level": "cillum consectetur in culpa"
}

{
  "code": "aliqua eu reprehenderit",
  "date": "1947-09-21T03:58:09.0Z",
  "description": "non pariatur",
  "level": "tempor non in amet"
}

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": null,
    "country": "sint ea",
    "coverLetter": true,
    "createdDate": "1941-11-29T09:11:02.0Z",
    "custom1": "RE0136645",
    "custom2": "dolore non quis",
    "custom3": "consequat ex culpa nisi qui",
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "consequat officia",
        "date": null,
        "description": "in",
        "level": "Duis minim adipisicing Excepteur"
      },
      {
        "code": "ipsum non",
        "date": "1911-04-22T21:49:23.0Z",
        "description": "irure ullamco",
        "level": "sed in"
      },
      {
        "code": "eu dolore et",
        "date": "1939-01-18T15:14:03.0Z",
        "description": "sit sint incididunt qui",
        "level": "sint commodo"
      }
    ],
    "fileName": "ex",
    "frankierID": null,
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -1720193596,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "commodo amet"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "tempor e"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "dolore Duis nulla sunt"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "culpa laborum ea"
      }
    ],
    "printFeedbackDate": "1912-03-30T23:49:31.0Z",
    "printUploadDate": "1891-09-24T09:13:54.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": "officia proident enim cillum magna",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1937-07-20T08:58:48.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 246696278,
    "subVendorID": null,
    "testEMail": "ipsum laborum aute tempor",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "id in eu laboris amet",
    "costCenter": null,
    "country": null,
    "coverLetter": false,
    "createdDate": "1956-11-25T22:19:09.0Z",
    "custom1": "RE0136645",
    "custom2": "ipsum Excepteur irure sed in",
    "custom3": "enim",
    "custom4": null,
    "custom5": "aute",
    "destinationAreaStatus": "aute non amet",
    "destinationAreaStatusDate": "1959-09-23T17:56:39.0Z",
    "errorList": null,
    "fileName": "mollit",
    "frankierID": "mollit consectetur eiusmod adipisicing consequat",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 1319412413,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "magna sed"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "labore nisi et anim cupidatat"
      }
    ],
    "printFeedbackDate": "1948-12-28T07:09:24.0Z",
    "printUploadDate": null,
    "processedDate": "1949-07-04T07:39:22.0Z",
    "registeredLetter": "dolor mollit",
    "registeredLetterID": null,
    "registeredLetterStatus": "sint laborum do",
    "registeredLetterStatusDate": "1958-01-04T12:13:24.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1455127673,
    "subVendorID": null,
    "testEMail": "aute qui veniam",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "nostru",
    "country": null,
    "coverLetter": false,
    "createdDate": "1892-01-30T07:06:52.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": "do dolore id",
    "custom5": "sit",
    "destinationAreaStatus": "officia reprehenderit in sed et",
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "nisi",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -26065470,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "enim eiusmod"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "deserunt"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": "Lorem pariatur voluptate",
    "registeredLetterID": null,
    "registeredLetterStatus": "aute",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1351986935,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "est esse laboris",
    "zipCode": "ad nisi est"
  }
]

{
  "code": "dolor minim",
  "date": null,
  "description": "nulla",
  "level": "Ut exercitation minim nisi Lorem"
}

{
  "code": "mollit fugiat dolor reprehenderit deserunt",
  "date": "1898-02-21T06:12:29.0Z",
  "description": "esse in ipsum amet",
  "level": "sed"
}

{
  "code": "nulla incididunt consequat",
  "date": null,
  "description": "commodo aute",
  "level": "in sunt"
}

{
  "code": "magna ipsum Lorem",
  "date": "1955-06-06T15:01:03.0Z",
  "description": "pariatur incididunt nulla",
  "level": "in Ut ad incididunt"
}

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`	`1940-09-01T17:08:50.0Z`
`tillDate`	`1900-02-18T14:06:19.0Z`
`onlyOpen`	`true`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": null,
    "costCenter": null,
    "country": "consequat fugiat ullamco in",
    "coverLetter": false,
    "createdDate": "1920-07-17T12:38:12.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "custom5": "et",
    "destinationAreaStatus": "enim dolor eiusmod in",
    "destinationAreaStatusDate": "1953-03-30T01:51:01.0Z",
    "errorList": [
      {
        "code": "culpa",
        "date": "1892-02-02T01:43:32.0Z",
        "description": "sunt amet",
        "level": "laboris"
      },
      {
        "code": "quis nulla",
        "date": "1925-06-21T05:13:04.0Z",
        "description": "amet non labore",
        "level": "eiusmod cillum"
      }
    ],
    "fileName": "anim occaecat elit Duis laborum",
    "frankierID": null,
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 257125325,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": "1929-10-19T03:16:46.0Z",
    "processedDate": "1968-06-29T05:28:16.0Z",
    "registeredLetter": "cillum esse minim qui",
    "registeredLetterID": null,
    "registeredLetterStatus": "reprehenderit nisi",
    "registeredLetterStatusDate": "1951-04-21T04:03:24.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -29293597,
    "subVendorID": "dolore ad ut sed eiusmod",
    "testEMail": "elit eu in sed est",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "do",
    "zipCode": "Excepteur dolore consequat"
  },
  {
    "batchID": 12345,
    "city": "fugiat officia",
    "costCenter": "sit ",
    "country": "in pariatur cillum est ea",
    "coverLetter": true,
    "createdDate": "1930-08-21T21:35:40.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "proident",
    "custom4": null,
    "custom5": "veniam cillum anim velit",
    "destinationAreaStatus": "esse cillum dolor id",
    "destinationAreaStatusDate": "1950-02-23T21:05:21.0Z",
    "errorList": null,
    "fileName": "Ut mollit non enim",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1400578203,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1891-03-10T07:47:42.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": "do ipsum",
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1968-07-02T06:17:54.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1095024783,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "qui aute Ut ea incididunt",
    "zipCode": "aliqua consectetur in"
  }
]

{
  "code": "veniam",
  "date": "1944-11-07T04:18:25.0Z",
  "description": "irure cillum in sed id",
  "level": "qui"
}

{
  "code": "dolor eiusmod Duis",
  "date": "1960-01-04T18:28:28.0Z",
  "description": "in irure voluptate ipsum incididunt",
  "level": "occaecat consectetur laborum mollit amet"
}

{
  "code": "nostrud non minim",
  "date": null,
  "description": "enim proident ipsum",
  "level": "occaecat veniam"
}

{
  "code": "in consequat Excepteur",
  "date": "1955-02-12T08:28:02.0Z",
  "description": "tempor eiusmod fugiat quis",
  "level": "ea ex"
}

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`	`1945-06-24T15:20:52.0Z`
`tillDate`	`1964-01-21T23:09:27.0Z`
`onlyFeedback`	`true`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": "laborum sunt mollit esse laboris",
    "costCenter": null,
    "country": null,
    "coverLetter": true,
    "createdDate": "1941-01-11T01:51:52.0Z",
    "custom1": "RE0136645",
    "custom2": "veniam ex mollit dolor exercitation",
    "custom3": null,
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "consequat Ut Lorem",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 564170632,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "labore"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "et in proident"
      }
    ],
    "printFeedbackDate": "1960-05-06T03:20:14.0Z",
    "printUploadDate": "1941-08-29T12:40:03.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1961-01-12T06:06:34.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1603058664,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "veniam laboris fugiat sint",
    "zipCode": "sed qui"
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "dolore e",
    "country": null,
    "coverLetter": false,
    "createdDate": "1914-02-03T07:41:33.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": "ad dolore proident ullamco",
    "custom4": null,
    "custom5": "cupidatat sed in aliqua",
    "destinationAreaStatus": "elit",
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "commodo",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": -109198464,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "velit fugiat deserunt sed"
      }
    ],
    "printFeedbackDate": "1965-04-12T12:35:31.0Z",
    "printUploadDate": "1929-05-28T08:24:06.0Z",
    "processedDate": "1894-05-30T13:18:26.0Z",
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": "laboris magna in in et",
    "registeredLetterStatusDate": "1922-02-26T22:18:01.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 489527180,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "dolor id dolore sed sunt"
  },
  {
    "batchID": 12345,
    "city": "sint",
    "costCenter": null,
    "country": "cupidatat in Ut nostrud",
    "coverLetter": false,
    "createdDate": "1904-08-23T02:10:05.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": "in",
    "custom5": null,
    "destinationAreaStatus": "reprehenderit veniam dolor irure ad",
    "destinationAreaStatusDate": "1957-10-05T03:01:19.0Z",
    "errorList": [
      {
        "code": "qui",
        "date": "1946-06-04T06:51:10.0Z",
        "description": "adipisicing amet",
        "level": "aute incididunt"
      },
      {
        "code": "commodo aliqua",
        "date": null,
        "description": "deserunt ea non Ut",
        "level": "Ut labore aliqua et in"
      },
      {
        "code": "ea consequat",
        "date": "1965-09-12T16:43:55.0Z",
        "description": "et deserunt laborum amet fugiat",
        "level": "eiusmod veniam dolor pariatur"
      }
    ],
    "fileName": "sit",
    "frankierID": "in",
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 771723363,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "ea"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "fugiat"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "ea consectetur cupidatat ex"
      }
    ],
    "printFeedbackDate": "1965-11-21T02:01:45.0Z",
    "printUploadDate": null,
    "processedDate": "1895-10-06T17:40:08.0Z",
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1900-10-22T18:49:56.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 803166609,
    "subVendorID": null,
    "testEMail": "sit dolor cupidatat",
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "Lorem ipsum aliqua aliquip",
    "costCenter": "r",
    "country": "voluptate Ut est",
    "coverLetter": false,
    "createdDate": "1893-05-19T11:22:05.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": "eu",
    "custom5": "Excepteur elit mollit pariatur quis",
    "destinationAreaStatus": "pariatur magna",
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "Lorem laborum aute amet",
    "frankierID": "in ipsum dolor sint",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1394294203,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": "1904-03-11T14:45:32.0Z",
    "processedDate": "1908-06-30T01:02:39.0Z",
    "registeredLetter": "pariatur dolor",
    "registeredLetterID": "non dolore in cillum enim",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1906-03-04T22:38:15.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 1790543276,
    "subVendorID": "veniam fugiat occaecat",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "irure ea non"
  },
  {
    "batchID": 12345,
    "city": null,
    "costCenter": "",
    "country": null,
    "coverLetter": false,
    "createdDate": "1962-10-18T14:17:04.0Z",
    "custom1": "RE0136645",
    "custom2": "mollit sint consectetur",
    "custom3": null,
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1929-07-11T17:40:14.0Z",
    "errorList": null,
    "fileName": "Lorem nostrud in cillum ad",
    "frankierID": null,
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -556313164,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1893-01-24T19:34:08.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 654542839,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": "labore amet enim",
    "zipCode": null
  }
]

{
  "code": "nisi",
  "date": "1967-03-16T03:50:11.0Z",
  "description": "consequat",
  "level": "id Duis"
}

{
  "code": "adipisicing est sit",
  "date": "1962-08-13T16:55:26.0Z",
  "description": "pariatur consequat qui proident",
  "level": "exercitation irure do deserunt"
}

{
  "code": "amet est id cupidatat",
  "date": null,
  "description": "incididunt",
  "level": "ad et dolore"
}

{
  "code": "officia labore culpa",
  "date": "1934-08-05T10:53:19.0Z",
  "description": "consectetur est do dolore",
  "level": "non irure eiusmod officia minim"
}

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`	`true`

Request Payload

[
  3541908942918533,
  2545502110450589,
  -8825869855006795,
  -2208178463794507,
  -4474773665810051
]

Response Payload

[
  {
    "batchID": 12345,
    "city": "ut",
    "costCenter": "elit ",
    "country": null,
    "coverLetter": false,
    "createdDate": "1953-02-25T03:19:28.0Z",
    "custom1": "RE0136645",
    "custom2": "in ut magna fugiat aliqua",
    "custom3": null,
    "custom4": "amet",
    "custom5": "occaecat",
    "destinationAreaStatus": "reprehenderit sit adipisicing id magna",
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "consequat consectetur officia proident nulla",
    "frankierID": "mollit est et non dolore",
    "isColor": true,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 976502136,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1913-09-27T18:35:15.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": null,
    "registeredLetterStatus": "nostrud est ullamco Ut",
    "registeredLetterStatusDate": "1900-06-18T08:37:44.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -781714511,
    "subVendorID": "aute velit minim",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": true,
    "vendorSystemInformation": null,
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "adipisicing",
    "costCenter": null,
    "country": "labore culpa dolore ad",
    "coverLetter": false,
    "createdDate": "1954-09-06T10:25:42.0Z",
    "custom1": "RE0136645",
    "custom2": "labore cupidatat",
    "custom3": "Excepteur nulla commodo tempor ad",
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": null,
    "fileName": "est laborum",
    "frankierID": "quis ullamco eu",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": 192710761,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "deserunt mollit aliqua occaecat eu"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "sed sint dolor aliqua"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "magna"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "sunt"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "culpa"
      }
    ],
    "printFeedbackDate": "1939-02-09T10:18:44.0Z",
    "printUploadDate": null,
    "processedDate": "1909-09-14T07:40:35.0Z",
    "registeredLetter": "est",
    "registeredLetterID": "in sed do",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -738810218,
    "subVendorID": "deserunt",
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "dolor minim id"
  },
  {
    "batchID": 12345,
    "city": "veniam",
    "costCenter": null,
    "country": "ullamco",
    "coverLetter": true,
    "createdDate": "1949-04-14T04:50:17.0Z",
    "custom1": "RE0136645",
    "custom2": null,
    "custom3": null,
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": "officia eiusmod consequat sed",
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "dolore",
        "date": null,
        "description": "ut ipsum eiusmod",
        "level": "culpa voluptate qui"
      },
      {
        "code": "laborum exercitation",
        "date": null,
        "description": "ut mollit",
        "level": "labore proident"
      },
      {
        "code": "Ut id ea",
        "date": "1961-11-27T08:36:32.0Z",
        "description": "cillum occaecat",
        "level": "cupidatat eu"
      },
      {
        "code": "velit sit labore id aliqua",
        "date": null,
        "description": "amet minim",
        "level": "occaecat Lorem"
      }
    ],
    "fileName": "ut exercitation",
    "frankierID": "qui cupidatat ipsum voluptate in",
    "isColor": false,
    "isDuplex": true,
    "letterID": 43556780,
    "noOfPages": -1006755564,
    "plugInFeedbackList": [
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "minim Ut"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "d"
      },
      {
        "plugInFeedbackModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "in occaecat"
      }
    ],
    "printFeedbackDate": null,
    "printUploadDate": "1910-11-20T11:15:31.0Z",
    "processedDate": null,
    "registeredLetter": null,
    "registeredLetterID": "deserunt tempor",
    "registeredLetterStatus": null,
    "registeredLetterStatusDate": "1897-02-20T19:56:22.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -112390400,
    "subVendorID": null,
    "testEMail": null,
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "et labore incididunt sit ex",
    "zipCode": "commodo deserunt enim aliqua"
  }
]

{
  "code": "dolore",
  "date": "1965-03-01T23:40:49.0Z",
  "description": "Lorem qui nostrud in incididunt",
  "level": "sunt"
}

{
  "code": "id amet culpa",
  "date": null,
  "description": "ut Duis",
  "level": "magna nulla qui fugiat nisi"
}

{
  "code": "est",
  "date": null,
  "description": "pariatur sed officia",
  "level": "Duis pariatur veniam ut ea"
}

{
  "code": "sit aliquip dolore voluptate Lorem",
  "date": null,
  "description": "dolore ullamco",
  "level": "dolor Ut"
}

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": "in nisi",
    "addressLine2": "ex Lorem veniam Duis ut",
    "addressLine3": "anim",
    "addressLine4": null,
    "addressLine5": "sint enim non id",
    "batchID": 12345,
    "city": "Tyler",
    "costCenter": "inci",
    "country": null,
    "coverData": null,
    "coverLetter": false,
    "custom1": "RE0136645",
    "custom2": "sit velit aliqua",
    "custom3": null,
    "custom4": "adipisicing ut mollit commodo cupidatat",
    "custom5": "magna",
    "data": "dolor consequat sint quis",
    "fileName": "certainly_illusion_alert.[object Object]",
    "isColor": true,
    "isDuplex": true,
    "plugInList": [
      {
        "plugInModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "proident exercitation dolore"
      },
      {
        "plugInModel": {
          "description": "Mit Daten angereichertes PlugIn-Model im JSON Format",
          "nullable": true
        },
        "plugInName": "amet id magna"
      }
    ],
    "registeredLetter": "velit",
    "registeredLetterAdressLine1": "irure Duis",
    "registeredLetterAdressLine2": "esse ad ea dolore",
    "registeredLetterAdressLine3": null,
    "registeredLetterCity": null,
    "registeredLetterZipCode": "eiusmod",
    "senderAdressLine1": null,
    "senderAdressLineComplete": null,
    "senderCity": "culpa",
    "senderStreet": null,
    "senderZipCode": "nulla eiusmod",
    "testEMail": "est aute eiusmod",
    "testFlag": false,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": null,
    "zipCode": "ea "
  }
]

Response Payload

[
  {
    "fileName": "magna",
    "letterID": -6150255323395535
  },
  {
    "fileName": "eu reprehenderit quis nostrud",
    "letterID": 1376303119637165
  },
  {
    "fileName": "ipsum cupidatat veniam est in",
    "letterID": 4445621139245705
  }
]

{
  "code": "esse eu quis est labore",
  "date": null,
  "description": "non exercitation",
  "level": "sed"
}

{
  "code": "cillum est consectetur dolore",
  "date": "1909-05-25T09:08:16.0Z",
  "description": "qui velit ut",
  "level": "ea nostrud aute cillum elit"
}

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

[
  -7994746594034511
]

Response Payload

[
  {
    "letterID": -553072312891415,
    "message": "aliqua sint Ut laboris cupidatat",
    "successful": false
  },
  {
    "letterID": -2440136766196991,
    "message": "id veniam non",
    "successful": true
  },
  {
    "letterID": -51511475073551,
    "message": "dolor nisi qui",
    "successful": false
  },
  {
    "letterID": 1606955797932461,
    "message": "sunt eu nisi ea",
    "successful": false
  },
  {
    "letterID": -1714144619834691,
    "message": "fugiat eu nostrud elit co",
    "successful": true
  }
]

{
  "code": "dolore laborum laboris tempor",
  "date": "1929-07-31T01:32:55.0Z",
  "description": "ut consequat exercitation nulla",
  "level": "laborum"
}

{
  "code": "cillum",
  "date": null,
  "description": "exercitation",
  "level": "irure labore minim sunt ut"
}

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

[
  -3194701155460111,
  1634905469159297,
  4661132649267977,
  -3855057181685395,
  -6892996058372027
]

Response Payload

[
  {
    "letterID": -8825877842147959,
    "message": "aliqua sunt",
    "successful": false
  },
  {
    "letterID": -4050427544204027,
    "message": "incididunt",
    "successful": true
  },
  {
    "letterID": -6031039420920471,
    "message": "elit amet et",
    "successful": false
  }
]

{
  "code": "mollit",
  "date": "1941-11-14T11:29:36.0Z",
  "description": "in et ea",
  "level": "incididunt aliquip ea Excepteur"
}

{
  "code": "dolor dolor in deserunt ea",
  "date": "1908-08-28T05:46:17.0Z",
  "description": "tempor commodo dolor",
  "level": "mollit nostrud eu id"
}

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": "Lorem amet",
  "password": "ullamco",
  "secret": "quis",
  "tokenDuration": -645190251,
  "vendorID": "eiusmod",
  "vendorSubID": null
}

Response Payload

{
  "token": "commodo elit aliquip"
}

{
  "code": "anim consectetur est ea",
  "date": "1956-02-24T20:15:38.0Z",
  "description": "cillum",
  "level": "dolor fugiat nulla ea"
}

{
  "code": "in enim",
  "date": "1959-11-08T01:34:10.0Z",
  "description": "consequat elit sunt cupidatat minim",
  "level": "in dolore culpa enim"
}

{
  "code": "Excepteur tempor in",
  "date": null,
  "description": "qui ut commodo",
  "level": "id laboris deserunt ex aliqua"
}

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": "Duis nisi ",
  "vendorID": "elit non"
}

Response Payload

sunt ut

{
  "code": "sed",
  "date": "1911-10-01T10:49:26.0Z",
  "description": "adipisicing Duis nulla deserunt",
  "level": "Excepteur elit"
}

{
  "code": "pariatur nulla Excepteur commodo eu",
  "date": "1922-02-18T04:35:37.0Z",
  "description": "dolore Ut culpa Lorem ut",
  "level": "dolore mollit est ipsum nulla"
}

{
  "code": "enim",
  "date": "1896-01-19T19:58:12.0Z",
  "description": "enim sit elit do",
  "level": "id Duis Excepteur"
}

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": "exercitati",
  "newPassword": "mollit non laborum",
  "smsCode": "irure ",
  "vendorID": "sit"
}

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": "culpa proident",
  "date": "1932-08-28T16:48:29.0Z",
  "description": "anim ullamco sunt nostrud",
  "level": "ullamco dolor do deserunt qui"
}

{
  "code": "Duis sunt",
  "date": "1968-07-28T09:10:39.0Z",
  "description": "dolore aliquip Lorem",
  "level": "ullamco magna reprehenderit minim"
}

{
  "code": "laboris ipsum",
  "date": null,
  "description": "enim ut",
  "level": "ut nostrud esse pariatur et"
}

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": true,
  "parameters": [
    {
      "name": "pariatur eiusmod deserunt",
      "value": "nostrud occaecat velit exercitation"
    },
    {
      "name": "con",
      "value": "et qui enim tempor"
    },
    {
      "name": "nostrud cillum exercitation ipsum ad",
      "value": "deserunt sed laboris"
    },
    {
      "name": "dolor cupidatat",
      "value": "aliqua ut cupidatat eiusmod consequat"
    }
  ],
  "useAutomover": false
}

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": "1963-12-23T13:12:04.0Z",
  "dueDayofWeek": "in",
  "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": "Ut ullamco sunt"
}

{
  "premiumAdressResult": {
    "e_HNr": "ex velit E",
    "e_Na1": "culpa",
    "e_Na2": "quis dolor in",
    "e_Na3": null,
    "e_Na4": "qui culpa",
    "e_Ort": "labore sed Excepteur ad minim",
    "e_PLZ": "",
    "e_Postf": "et",
    "e_Str": "esse non proident",
    "kd_HNr": null,
    "kd_Na1": "ad elit",
    "kd_Na2": null,
    "kd_Na3": "anim laboris",
    "kd_Na4": "Excepteur occaecat",
    "kd_Ort": "in aliquip ad dolore",
    "kd_PLZ": null,
    "kd_Postf": null,
    "kd_Str": null,
    "nsA_HNr": "elit Ut ",
    "nsA_Land": "in sunt anim",
    "nsA_Land_Postf": "e",
    "nsA_Na1": null,
    "nsA_Na2": "eu laborum anim ut volupt",
    "nsA_Na3": null,
    "nsA_Na4": null,
    "nsA_Ort": null,
    "nsA_Ort_Postf": null,
    "nsA_PLZ": null,
    "nsA_PLZ_Postf": "et enim d",
    "nsA_Postf": null,
    "nsA_Str": "",
    "sdgS": 897355999
  },
  "productVariants": "in non ipsum Duis"
}

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`	`1945-05-05T22:14:05.0Z`
`tillDate`	`1900-01-22T04:32:07.0Z`

Request Payload

Response Payload

[
  {
    "country": null,
    "ekp": "cillum ullamco nisi",
    "isColor": true,
    "isDuplex": true,
    "letterCount": 530276721,
    "printFeedbackDate": "1899-09-05T14:30:09.0Z",
    "registeredLetter": "do dolor dolor eu quis",
    "vendorID": "minim occaecat sit"
  },
  {
    "country": "eu",
    "ekp": "enim",
    "isColor": false,
    "isDuplex": false,
    "letterCount": 1942777615,
    "printFeedbackDate": "1935-06-06T04:01:55.0Z",
    "registeredLetter": null,
    "vendorID": null
  }
]

{
  "code": "qui sunt",
  "date": "1956-06-13T04:13:24.0Z",
  "description": "cupidatat",
  "level": "eiusmod aute"
}

{
  "code": "nisi et",
  "date": null,
  "description": "proident consectetur velit est",
  "level": "incididunt"
}

{
  "code": "esse in officia magna occaecat",
  "date": "1890-03-26T06:20:52.0Z",
  "description": "ut ullamco",
  "level": "anim Duis"
}

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`	`1949-08-09T01:45:01.0Z`
`tillDate`	`1923-01-24T06:40:38.0Z`

Request Payload

Response Payload

Error generating example

{
  "code": "sunt aute",
  "date": "1938-07-09T16:56:47.0Z",
  "description": "ut commodo",
  "level": "sunt voluptate enim in"
}

{
  "code": "sit culpa ea",
  "date": null,
  "description": "in labore esse dolor amet",
  "level": "in anim amet"
}

{
  "code": "dolor veniam culpa Lorem in",
  "date": "1905-01-22T09:16:49.0Z",
  "description": "eu irure Lorem",
  "level": "labore occaecat adipisicing do"
}

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`	`1966-05-16T13:51:45.0Z`
`tillDate`	`1915-10-29T07:56:12.0Z`

Request Payload

Response Payload

Binary Content
(application/octet-stream)

{
  "code": "ex tempor",
  "date": null,
  "description": "reprehenderit laboris",
  "level": "labore aliqua irure"
}

{
  "code": "consequat non sint enim quis",
  "date": null,
  "description": "aliquip id et occaecat voluptate",
  "level": "in"
}

{
  "code": "commodo minim occaecat enim",
  "date": null,
  "description": "esse anim sed fugiat",
  "level": "ex"
}

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`	`1958-02-20T16:39:08.0Z`
`tillDate`	`1906-11-10T22:56:25.0Z`
`hideEKP`	`false`

Request Payload

Response Payload

[
  {
    "batchID": 12345,
    "city": null,
    "costCenter": null,
    "country": null,
    "coverLetter": true,
    "createdDate": "1909-12-16T20:22:41.0Z",
    "custom1": "RE0136645",
    "custom2": "anim sit",
    "custom3": "anim dolor",
    "custom4": null,
    "custom5": null,
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": null,
    "errorList": [
      {
        "code": "aliquip sunt velit",
        "date": "1903-01-23T22:39:53.0Z",
        "description": "qui dolor",
        "level": "dolor qui eu tempor"
      },
      {
        "code": "consequat",
        "date": "1910-07-10T10:59:13.0Z",
        "description": "dolore esse Ut proident",
        "level": "id nostrud"
      },
      {
        "code": "irure ad exercitation",
        "date": "1918-01-12T22:43:08.0Z",
        "description": "pariatur est adipisicing enim",
        "level": "ea eiusmod in et sit"
      }
    ],
    "fileName": "consectetur enim nostrud",
    "frankierID": null,
    "isColor": false,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 1849240733,
    "plugInFeedbackList": null,
    "printFeedbackDate": null,
    "printUploadDate": "1944-11-11T22:43:30.0Z",
    "processedDate": null,
    "registeredLetter": "sint",
    "registeredLetterID": null,
    "registeredLetterStatus": "ut in est velit reprehenderit",
    "registeredLetterStatusDate": "1943-10-11T06:56:07.0Z",
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": 467123095,
    "subVendorID": "Duis consequat nostrud non aute",
    "testEMail": "fugiat veniam sit",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "voluptate cillum sed pariatur",
    "zipCode": null
  },
  {
    "batchID": 12345,
    "city": "dolor eu",
    "costCenter": null,
    "country": null,
    "coverLetter": false,
    "createdDate": "1929-06-09T06:12:07.0Z",
    "custom1": "RE0136645",
    "custom2": "officia",
    "custom3": "aliquip cillum",
    "custom4": null,
    "custom5": "Ut aliquip voluptate",
    "destinationAreaStatus": null,
    "destinationAreaStatusDate": "1945-03-29T18:13:16.0Z",
    "errorList": [
      {
        "code": "incididunt ipsum",
        "date": null,
        "description": "deserunt dolor mollit labore",
        "level": "ipsum dolor"
      },
      {
        "code": "enim velit sunt",
        "date": null,
        "description": "enim ipsum consectetur aliquip",
        "level": "officia"
      },
      {
        "code": "aliqua",
        "date": "1938-09-08T21:18:33.0Z",
        "description": "ut elit reprehenderit",
        "level": "consequat eiusmod ipsum magna in"
      },
      {
        "code": "culpa",
        "date": "1930-12-24T09:28:21.0Z",
        "description": "quis dolor",
        "level": "in ut irure"
      },
      {
        "code": "dolore",
        "date": "1936-08-12T19:26:51.0Z",
        "description": "laboris deserunt",
        "level": "sed"
      }
    ],
    "fileName": "sit incididunt",
    "frankierID": "nulla",
    "isColor": true,
    "isDuplex": false,
    "letterID": 43556780,
    "noOfPages": 110911333,
    "plugInFeedbackList": null,
    "printFeedbackDate": "1967-01-17T05:54:12.0Z",
    "printUploadDate": null,
    "processedDate": null,
    "registeredLetter": "reprehenderit incididunt laboris",
    "registeredLetterID": null,
    "registeredLetterStatus": "ullamco nisi reprehenderit do",
    "registeredLetterStatusDate": null,
    "statusDetails": "Einlieferung in Druckzentrum",
    "statusID": -1923183427,
    "subVendorID": null,
    "testEMail": "est ea mollit ex cupidatat",
    "testFlag": true,
    "testShowRestrictedArea": false,
    "vendorSystemInformation": "cillum veniam",
    "zipCode": null
  }
]

{
  "code": "reprehenderit mollit voluptate pariatur et",
  "date": null,
  "description": "cillum et dolore minim",
  "level": "amet"
}

{
  "code": "laboris dolore",
  "date": "1964-06-09T21:51:22.0Z",
  "description": "cillum voluptate",
  "level": "ea laborum non pariatur magna"
}

{
  "code": "ut sint laborum exercitation nisi",
  "date": "1898-04-07T03:27:09.0Z",
  "description": "nulla enim velit",
  "level": "officia incididunt ullamco nisi"
}

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`	No example
`technicalPhone`	No example
`technicalEmail`	`esse velit dolor reprehenderit`
`businessContact`	`officia in magna`
`businessPhone`	No example
`businessEmail`	No example

Request Payload

Response Payload

dolore dolor incididunt

{
  "code": "culpa mollit voluptate nisi",
  "date": null,
  "description": "Duis",
  "level": "quis laborum"
}

{
  "code": "nisi commodo consectetur ipsum",
  "date": "1908-01-03T12:42:58.0Z",
  "description": "culpa",
  "level": "dolore laborum labore cillum officia"
}

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

dhllogisticsmailepostdocument-processing