Zone Lookup
此内容尚不支持你的语言。
You can use “Zones” API to lookup US domestic zone information. The information is provided and defined by USPS. Teapplix subscribes from USPS zone information and updates our database periodically.
You can do zone lookups in bulk, providing many pair of “From” “To” zip codes (5 digits). Notice currently, zone lookup is limited to domestic US only.
The zone lookup api “Zones” is provided at the below endpoint:
POST Request
Zones
Request to obtain shipping zone
| Property | Type | Description | Constraints |
|---|---|---|---|
Routes |
Route[] | The packages routes | Required |
Route
Shipment route
| Property | Type | Description | Constraints |
|---|---|---|---|
FromZip |
string | Sender's zip code | RequiredPattern: [0-9]{5} |
ToZip |
string | Recipient zip code | RequiredPattern: [0-9]{5} |
POST Response - 200
ShippingZone
| Property | Type | Description | Constraints |
|---|---|---|---|
Routes |
Shipping Zone Route[] |
Shipping Zone Route
| Property | Type | Description | Constraints |
|---|---|---|---|
FromZip |
string | From zip code | Required |
ToZip |
string | To zip code | Required |
Zone |
string | Delivery zone (if available) | |
Error |
Error |
Error
| Property | Type | Description | Constraints |
|---|---|---|---|
Level |
string | ||
Code |
string | ||
Message |
string |
POST Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |