Get request status
Returns the current status and outcome of a label-purchase request. Read-only and safe to call repeatedly.
Poll while status is processing. Terminal outcomes are purchased, dry_run_completed, no_match, and failed. The dry_run field identifies dry runs, which can also end in no_match or failed.
A no_match outcome includes reason.code and reason.message: rules and fallback selected nothing (no_match), every returned rate was excluded from automatic selection (all_rates_excluded), or no rates were returned for the shipment (no_rates_returned). Reason codes may be added; tolerate unknown codes. purchased and dry_run_completed need no reason.
A successful poll returns HTTP 200 for every outcome. Only failed includes error; branch on its code and tolerate additional codes. A failed automation may have an unconfirmed purchase: check the account or transaction before retrying when instructed by the error.
Returns 404 for a request id that does not exist or does not belong to your account.
Authorizations
Shippo API token, sent as Authorization: ShippoToken <API_TOKEN>.
Path Parameters
Response
Successful Response
- ProcessingStatus
- DryRunCompletedStatus
- PurchasedStatus
- NoMatchStatus
- FailedStatus
Whether this request was created in test mode.
Automation processing is still in progress.
"processing"Whether this request evaluates selection without purchasing a label.