ShippingRateOutcome
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
How a rate request ended, so a caller can tell "no rates for this lane" from "provider unreachable" from "misconfigured" from "not configured". Failure is never modelled as an empty quote list.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Success |
The provider answered with at least one quote. |
NoRatesForLane |
The provider answered, and no carrier it reaches serves this origin, destination and parcel combination. Not an error: the page shows no options and the merchant checks the lane. |
NotConfigured |
No provider is configured or enabled. The null provider's only answer. |
Misconfigured |
A provider is configured but its own settings are incomplete or invalid (a missing credential, an unusable carrier account filter). An administrator fixes this on the settings page. |
AuthenticationFailed |
The provider rejected the credential (HTTP 401 or 403). |
RateLimited |
The provider throttled the caller (HTTP 429). |
InvalidRequest |
The provider rejected the request as malformed or unsupported (any other 4xx). |
ProviderUnavailable |
The provider could not be reached or answered with a server-side fault: a transport failure, an open circuit, or a 5xx. |
Timeout |
The call did not complete within QuoteTimeoutSeconds. |
MalformedResponse |
The provider answered 2xx with a body the response mapper could not read. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.