{"uid":"cap_dVV-Pr1v-dEvoLR0iMnYl","slug":"postalform-id-7b8cc437","name":"PostalForm MPP Order Status Poll","description":"Poll order status and fulfillment","url":"https://postalform.com/api/machine/mpp/orders/:id?utm_source=zero.xyz","method":"GET","headers":{},"bodySchema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"Canonical order_id or any aliased request_id returned by the create or validate call."}}},"responseSchema":{"type":"object","required":["order_id","status","payment_status","is_paid","current_step","payment_intent_id","payment_channel","price_usd","currency","mailpiece_type","postcard_size","postcard_guidelines_url","machine_payment","order_complete_url"],"properties":{"x402":{"type":"object","required":["network","pay_to","settlement_tx","settled_at"],"properties":{"pay_to":{"anyOf":[{"type":"string"},{"type":"null"}]},"network":{"anyOf":[{"type":"string"},{"type":"null"}]},"settled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"settlement_tx":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"status":{"type":"string"},"is_paid":{"type":"boolean"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"order_id":{"type":"string","format":"uuid","description":"Canonical server order id. This may differ from request_id when PostalForm reuses an existing unpaid draft."},"price_usd":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}]},"current_step":{"anyOf":[{"type":"string"},{"type":"null"}]},"postcard_size":{"anyOf":[{"enum":["4x6","6x9","11x6"],"type":"string"},{"type":"null"}]},"mailpiece_type":{"enum":["letter","postcard"],"type":"string"},"payment_status":{"type":"string"},"machine_payment":{"type":"object","required":["protocol","method","network","recipient","settlement_reference","settled_at"],"properties":{"method":{"type":"string"},"network":{"type":"string"},"testnet":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"protocol":{"enum":["x402","mpp"],"type":"string"},"recipient":{"type":"string"},"settled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"settlement_reference":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":true},"payment_channel":{"anyOf":[{"type":"string"},{"type":"null"}]},"payment_intent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"order_complete_url":{"type":"string","description":"Either the completion URL after payment settles or a placeholder message before settlement."},"postcard_guidelines_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Canonical postcard PDF formatting guide. Present for postcard responses and null for letter responses."}},"additionalProperties":true},"example":null,"exampleRequest":null,"tags":["mail","print","letters","physical","postal","web"],"displayCostAmount":"0","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"unprobed","priceSource":"unknown","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"free","summary":"Free","primary":null,"accepted":[]},"paymentMethods":[],"brandName":"PostalForm","brandSlug":"postalform","brandBaseUrl":"https://postalform.com","brandDocsUrl":"https://postalform.com/agents","whatItDoes":"Poll the current status and fulfillment state of a physical mail order by order ID","exampleAgentPrompt":"Can you check the current status of my PostalForm order — the order ID is 3f2a1b4c-8d9e-4f10-a123-456789abcdef — and tell me whether payment has settled and what step it's on?","exampleUseCases":null,"resultDescription":"Returns a JSON object with the canonical order_id, order status string, payment_status string, is_paid boolean, current_step in the fulfillment pipeline, mailpiece_type (letter or postcard), postcard_size if applicable, price_usd, payment_channel, payment_intent_id, machine_payment details (protocol, network, recipient, settlement_reference, settled_at), x402 settlement info (network, pay_to, settlement_tx, settled_at), and an order_complete_url pointing to the completion page once payment settles.","failureModes":["Invalid or unknown order UUID returns 404 not found","Malformed UUID format returns 400 bad request","Unpaid order returns is_paid=false with empty settlement fields","Transient server error returns 500 with no order data","Order ID from a different user context may return 403 forbidden"],"whenToPreferThis":"Use this endpoint when you need to poll or verify the payment and fulfillment status of a specific PostalForm physical mail order after creation or validation. Prefer this over re-creating the order when you already have an order_id or request_id and simply need to confirm whether payment has settled or which fulfillment step the order is currently on.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-12T00:30:58.311Z","isFirstParty":false,"canonicalSlug":"postalform-id-7b8cc437"}