Skip to content

Hybrid letter status query

The “Hybrid letter status query” service task retrieves the current status of a single hybrid letter via Deutsche Post’s E-POSTBUSINESS API. Exactly one letterID is required.

Input parameters

{
  "letterID": "c9c8e9f0-...",
  "login": {
    "vendorID": "OPTIONAL_OVERRIDE",
    "ekp": "OPTIONAL_OVERRIDE",
    "secret": "OPTIONAL_OVERRIDE",
    "password": "OPTIONAL_OVERRIDE",
    "vendorSubID": "OPTIONAL",
    "tokenDuration": 1440
  }
}
  • letterID: Unique ID of the letter (returned during submission).
  • login: Optional; if omitted, the task uses the stored defaults, individual fields can be overridden.

Output

The task returns the letter status as a single object (keys in lowercase, timestamps in UTC):

{
  "letterid": "c9c8e9f0-...",
  "filename": "Invoice_4711.pdf",
  "statusid": 210,
  "statusdetails": "Transferred to print center",
  "createddate": "2025-09-05T08:12:03.000Z",
  "processeddate": "2025-09-05T08:15:10.000Z",
  "printuploaddate": "2025-09-05T08:16:00.000Z",
  "printfeedbackdate": "2025-09-05T08:28:30.000Z",
  "registeredletter": false,
  "noofpages": 3,
  "costcenter": "AB1234",
  "errorlist": [],
  "pluginfeedbacklist": []
}

Behavior and validation

  • ID check: Exactly one valid letterID must be provided, otherwise the task fails.
  • UTC timestamps: All date fields are normalized to UTC ISO (...Z).
  • Login caching: Tokens are cached per tenant; the optional login object overrides defaults.
  • Cost center check: The query verifies that the letter belongs to the tenant (costcenter).

JSON examples

{
  "letterID": "c9c8e9f0-..."
}

{
  "letterID": "c9c8e9f0-...",
  "login": {
    "ekp": "EKP123456",
    "password": "****"
  }
}

Notes

  • Error cases: Invalid IDs or foreign cost centers trigger an error.
  • Mapping: All output keys follow the Pantarey schema (lowercase).