Get Shipping Estimate Status
GET/api/shipping-estimates/status
Whether shipping cost estimates are available on this account. Shipping estimates on sales orders, quotes and the B2B portal are rated with the account's own EasyPost connection; Amazon FBA inbound transport estimates use it when present.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Response (data):
connected(boolean): an EasyPost connection exists.mode(production|test|null): the connected key's mode. Test keys return list rates, and EasyPost lists carrier accounts only for production keys.instance_id(integer|null): the EasyPost connection id.key_last4(string|null): last four characters of the API key.error(string|null): the last authentication failure, if any.carrier_accounts[]:id,carrier,descriptionof each carrier account on the EasyPost account (cached for an hour).carrier_accounts_error(string|null): why carrier accounts could not be listed.
All fields are null/empty when EasyPost is not connected.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.