Get Letter Status
get_letter_statusReturn the current state of one letter: where it is, the date it goes to USPS, and the estimated delivery date. USPS does not scan plain First-Class letters at delivery, so a Standard letter ends at an expected delivery date and never reports delivery — do not tell the user a letter arrived unless the status itself says so. This creates nothing and mails nothing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| letter_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tier | Yes | ||
| scans | Yes | ||
| status | Yes | Where the letter is. expected_delivery is the last state a standard or proof-of-mailing letter reaches; only certified tiers ever reach delivered. | |
| payment | Yes | ||
| livemode | Yes | False for sandbox letters, which are never mailed. | |
| letter_id | Yes | ||
| mail_date | Yes | The calendar date (YYYY-MM-DD, New York time) this piece goes to USPS. | |
| created_at | Yes | ||
| disclosure | Yes | Say this to the user whenever an expected delivery date is shown. | |
| description | Yes | One sentence for the user about where this letter is. | |
| cancelled_at | Yes | ||
| delivered_at | No | Certified tiers only, and absent entirely for the tiers USPS does not scan. | |
| tracking_url | No | Direct USPS tracking link. Share it with the user when available. | |
| tracking_number | No | USPS Certified Mail tracking number, present once the operator saves it. | |
| delivery_confirmation | Yes | False for every tier USPS does not scan at delivery. Never claim otherwise. | |
| expected_delivery_estimate | Yes |