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 price, letter format, shipping method and estimated delivery time for a planned letter, before it is sent. The estimate needs only page count, country and delivery type. Once the letter exists, order_send sends it, 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); pricing_tiers returns the volume tiers themselves. Registered-mail availability follows the destination's current catalog. The codes einschreiben_einwurf and einschreiben_uebergabe are German products; Switzerland uses ch_einschreiben. For other destinations, a standard shipping_quote for that country lists the available methods in availableDeliveryTypes, and a quote for the chosen code returns its price. A rejected country/method pair gives a verdict for that pair alone. A catalog snapshot gives a verdict for that snapshot alone. Tracked mail and registered mail are distinct products.
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 | optional | Colour for an estimate. Defaults to the colour of the default letterhead. With letterId, FrankKi reads the colour from the stored preview. |
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 | Delivery method code. Registered mail: einschreiben_einwurf and einschreiben_uebergabe for Germany, ch_einschreiben for Switzerland; for other countries a standard quote names the codes in availableDeliveryTypes. |
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; order_send with dryRun:true returns the final price including attachments. |
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.