Post Exchange icon

Post Exchange

Post AM.exchange – Tageszeitungs-Microservice API

Abonnement → Bulk importieren

AI-generated

Summary

Import multiple Abonnement (subscription) records in bulk by sending a JSON batch to the Post Exchange API's /api/subscriptions/batch endpoint.

Inputs

  • Batch-Body (JSON) (required) — A JSON object containing an "items" array, where each element represents a subscription with fields matching the API schema such as vorsystemId, recipientName, addressLine1, city, postalCode, country, validFrom, validTo, productType, and productionPlantCode. If provided a naked array, it will be wrapped as 'items' automatically. Optionally, a replaceForDate property may specify a delivery date for deactivating orphan subscriptions.

Output shape

a single JSON object summarizing the bulk import result

The output JSON includes the number of imported items ('imported'), an array of any errors encountered ('errors'), the number of chunks processed ('chunks'), and if 'replaceForDate' was used, the count of deactivated orphan subscriptions ('deactivated'). The operation handles input in chunks of 500 items per request to the API.

Examples

Example 1: Bulk import subscriptions via JSON batch

Provide a JSON object with the key "items" containing an array of subscription objects as the Batch-Body parameter. Each subscription object must include the correct fields conforming to the API schema. Optionally include a replaceForDate property to deactivate orphan subscriptions for that delivery date after import.

Links

Discussion