Dedicated tool guide
shipping_quote
Read the current destination and product price without sending or reserving wallet funds.
Generated contract: apiVersion v1, schemaRevision 2. Examples use placeholders and do not call production.
shipping_quote
read-onlyscope: letter:readDetermines the price, letter format, shipping method and estimated delivery time for a planned letter, before it is sent. This is the estimate for when the letter is still only planned: you only supply page count, country and delivery type. Once the letter exists, order_send performs the actual send (and order_send with dryRun:true gives the more precise price for that specific letter). The price is per letter and already includes the partner's volume tier where one applies (field tierId). For the volume tiers themselves, call pricing_tiers.
Input contract
| Field | Type | Requirement | Meaning |
|---|---|---|---|
pageCount | integer | required | Page count for a general estimate. With letterId, FrankKi uses the stored page count and ignores this value. |
color | boolean | required | Colour assumption for a general estimate. With letterId, FrankKi detects colour from the stored preview and ignores this value. |
deliveryType | standard | einschreiben_einwurf | einschreiben_uebergabe | ch_b_post | ch_a_post | ch_einschreiben | at_eco | at_prio | intl_standard | intl_priority | intl_express | intl_tracked | intl_registered | required | Registered-mail availability depends on the destination and its current catalog, not a Germany-only rule. The codes einschreiben_einwurf and einschreiben_uebergabe are German products; Switzerland uses ch_einschreiben. For other destinations, use only methods returned in availableDeliveryTypes by a standard shipping_quote for that country, then quote the chosen code. A rejected country/method pair does not establish availability in other countries. A catalog snapshot with no registered method does not prove that the postal service never offers one. Tracked mail is not registered mail. Never substitute standard or tracked delivery when registered mail was requested without the user's agreement. A carrier-issued proof-of-posting PDF is not promised. |
express | boolean | optional | |
country | string | optional | ISO 3166-1 alpha-2, defaults to DE. |
letterId | string | optional | Optional: the letterId of an existing draft. Page count and colour then come from the stored preview; for the final price including attachments, use order_send with dryRun:true. |
Contract-shaped example
shipping_quote({
"letterId": "REVIEWED_LETTER_ID",
"pageCount": 1,
"color": false,
"deliveryType": "einschreiben_einwurf",
"country": "DE"
})Carry priceVersion and unitPriceCents into order_send as priceVersion and quotedUnitPriceCents.
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.