Letter Xpress icon

Letter Xpress

Letter Xpress API Integration

Overview

This node integrates with the Letter Xpress API to manage postal and email print jobs, account balances, transactions, and invoices. Specifically, the "Druckaufträge Abrufen" (Get Print Jobs) operation retrieves a list of print jobs filtered by their status and paginated by page number.

Common scenarios include:

  • Monitoring the status of physical mail print jobs in an automated workflow.
  • Fetching batches of print job data for reporting or auditing purposes.
  • Filtering print jobs by their processing state such as queued, processing, completed, or errored.

Practical example:
A user wants to automatically check all print jobs currently in the queue to trigger notifications or further processing steps only for those jobs.

Properties

Name Meaning
Filter Filter for print jobs by status. Options:
- Alle (All)
- In Warteschlange (Queue)
- In Bearbeitung (Processing)
- Abgeschlossen (Done)
- Fehler (Error)
Seite Page number for pagination of results

Output

The output is a JSON array where each element represents a print job object returned from the Letter Xpress API. The exact structure depends on the API response but typically includes details about each print job such as its ID, status, creation date, and other metadata.

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 result in errors or no data returned.
  • 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 credential is correctly set up and has sufficient permissions.
    • Ensure the filter value matches one of the allowed options.
    • Use valid page numbers starting from 1.

Links and References

Discussion