Letter Xpress icon

Letter Xpress

Letter Xpress API Integration

Overview

This node integrates with the Letter Xpress API to manage postal and email jobs, transactions, invoices, and account balance. Specifically, the "E-Mail-Aufträge Abrufen" (Retrieve Email Jobs) operation fetches a list of email dispatch jobs from the Letter Xpress service, optionally filtered by their status and paginated.

Typical use cases include:

  • Monitoring the status of email dispatch jobs in an automated workflow.
  • Retrieving email job lists for reporting or auditing purposes.
  • Filtering email jobs by their processing state (e.g., queued, processing, done, error, held).

Example: Automatically fetch all email jobs currently in the queue to trigger follow-up actions or notifications.

Properties

Name Meaning
Seite Page number for pagination when retrieving email jobs. Defaults to 1.
E-Mail Filter Filter for email jobs by status. Options:
- Alle (All)
- In Warteschlange (Queue)
- In Bearbeitung (Processing)
- Abgeschlossen (Done)
- Fehler (Error)
- Zurückgehalten (Hold)

Output

The node outputs a JSON array where each element corresponds to an email job retrieved from the Letter Xpress API. The structure of each email job object depends on the API response but typically includes details such as job ID, status, timestamps, and other metadata related to the email dispatch.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Letter Xpress API.
  • The node makes HTTP requests to https://api.letterxpress.de endpoints.
  • Proper configuration of the API authentication credentials within n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Requesting pages beyond available data may return empty results.
    • Using unsupported filter values could lead to unexpected responses or errors.
  • Error messages:

    • Errors thrown by the node are wrapped as API errors with messages from the Letter Xpress API.
    • If the API returns non-200 status codes, the node throws an error indicating the failure.
  • Resolutions:

    • Verify that the API key and username are correctly set in the node credentials.
    • Ensure the page number is valid and greater than zero.
    • Use only the provided filter options to avoid invalid queries.
    • Enable "Continue On Fail" if partial failure handling is desired.

Links and References

Discussion