Geographic
Get Zipcode Information
This endpoint return the city and state information of the queried zip code.
URL
PROD https://api.skypostal.com/
TEST https://api-test.skypostal.com/
Endpoint
POST /wcf-services/service-geographic.svc/geographic/get-zipcode-info
Request Parameters
Parameters | |
|---|---|
| Object - Required User Info Definition. |
| Object - Required Zip Code Info Definition. |
User Info Definition
Parameters | |
|---|---|
| Integer - Required This is the user code provided by Skypostal. |
| String - Required This is the app key provided by Skypostal. |
| String - Required This is the app key provided by Skypostal. |
Zip Code Definition
Parameters | |
|---|---|
| String - Required - (Brazil Only) 2 characters iso code. (e.g. BR, MX, US, etc.) |
| String - Required Zipcode to be verified. 8 numbers maximum allowed. |
Remember
user_code and app_key are generic credentials, make sure to request your own for TEST and PROD environemnts.
The command should be run as in the following example:
{
"user_info": {
"user_code": 123123,
"user_key": "**",
"app_key": "***"
},
"zip_code_info": {
"country_iso_code": "CL",
"zip_code": "4230000"
}
}The command will return the following format:
{
"_verify": true,
"additional_info": {
"internal": [],
"server": {
"server_id": null,
"server_time": 0
}
},
"data": [
{
"city_clean_name": "santajuana",
"city_code": 160762,
"city_iata_code": "SCL",
"city_iso_code": "CL160762",
"city_name": "SANTA JUANA",
"country_code": 45,
"country_iso_code": "CL",
"county_code": 0,
"county_name": "",
"state_abreviation": "BI",
"state_code": 682,
"state_name": "BIOBIO",
"zip_code": "4230000"
}
],
"error": {
"error_code": "",
"error_description": "",
"error_location": "",
"system_error": false
}
}