Skip to content
FrankKi
Sign inStart freeiOS Download
Menu

Dedicated tool guide

order_status and order_einlieferungsbeleg

Read fulfillment state and retrieve proof of posting where the selected registered-mail product provides it.

Generated contract: apiVersion v1, schemaRevision 2. Examples use placeholders and do not call production.

order_status

read-onlyscope: order:read

Returns where a letter stands: status, German tracking history, tracking number (registered mail), estimated delivery and whether it can still be cancelled. The call takes exactly one id: orderId, approvalId (from order_send while orderId is null) or letterId. Before dispatch the status is queued_autopilot with dispatchAt, humanSummary (de, en) and cancelWith. On awaiting_partner_fix the letter waits for order_fix_resubmit; on failed, failure gives the reason and nextStep the way back. While cancellable is true, order_cancel stops the send.

Input contract

FieldTypeRequirementMeaning
orderIdstringoptional
approvalIdstringoptionalFrom order_send while orderId is null.
letterIdstringoptional

order_einlieferungsbeleg

read-onlyscope: order:read

Returns the proof of posting (Einlieferungsbeleg) for a sent order, once the letter is handed in and the mail provider issues one: a download URL for the receipt valid for 7 days (a PDF where the mail provider issues one, otherwise a JSON record built from its status data; belegFormat names the format, and a new call returns a fresh link), the postmark, the mail provider and the verified record from the GoBD archive. The receipt shows the hand-in at the post. The tracking number and delivery status of registered mail come from order_status.

Input contract

FieldTypeRequirementMeaning
orderIdstringrequired

Contract-shaped example

order_status({ "orderId": "ORDER_ID" })

order_einlieferungsbeleg({ "orderId": "ORDER_ID" })

Treat order_status as authoritative. Proof availability depends on the order and product; NOT_FOUND is not proof that a letter was never submitted.

For conditional fields and nested object limits, the generated complete tool reference remains authoritative. See errors and safe agent onboarding before implementing retries or a live send.

Trust and live status

Machine-readable service facts and the current operational status of the partner interface are publicly available at all times, no login needed.