Zum Inhalt springen
FrankKi
Sign inStart freeiOS Download

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 1. Examples use placeholders and do not call production.

order_status

read-onlyscope: order:read

Returns the current status of an order including a chronological German tracking history, the tracking number (registered mail only), the estimated delivery and whether the letter can still be cancelled. On status awaiting_partner_fix the letter is waiting for a correction: call order_fix_resubmit. While cancellable is true, order_cancel can still stop the send.

Input contract

FieldTypeRequirementMeaning
orderIdstringrequired

order_einlieferungsbeleg

read-onlyscope: order:read

Returns the proof of posting (Einlieferungsbeleg) for a sent order: a download URL for the receipt PDF valid for 90 days, the postmark, the mail provider and the verified record from the GoBD archive.

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.