Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# [
# {
# "address_line1": "Studio Tour Drive, Leavesden WD25 7LR, UK",
# "country_code": "GB"
# }
# ]
set jarr [new_CkJsonArray]
CkJsonArray_AddObjectAt $jarr -1
# jsonObj_1 is a CkJsonObject
set jsonObj_1 [CkJsonArray_ObjectAt $jarr [expr [CkJsonArray_get_Size $jarr] - 1]]
CkJsonObject_UpdateString $jsonObj_1 "address_line1" "Studio Tour Drive, Leavesden WD25 7LR, UK"
CkJsonObject_UpdateString $jsonObj_1 "country_code" "GB"
delete_CkJsonObject $jsonObj_1
CkHttp_SetRequestHeader $http "API-Key" "{{API_KEY}}"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonArray_EmitSb $jarr $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "POST" "https://api.shipengine.com/v1/addresses/validate" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonArray $jarr
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jarrResp [new_CkJsonArray]
CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0
puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonArray $jarr
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# [
# {
# "status": "verified",
# "original_address": {
# "name": null,
# "phone": null,
# "company_name": null,
# "address_line1": "Studio Tour Drive, Leavesden WD25 7LR, UK",
# "address_line2": null,
# "address_line3": null,
# "city_locality": null,
# "state_province": null,
# "postal_code": null,
# "country_code": "GB",
# "address_residential_indicator": "unknown"
# },
# "matched_address": {
# "name": null,
# "phone": null,
# "company_name": "WARNER BROS STUDIO TOUR",
# "address_line1": "Studio Tour Drive",
# "address_line2": "",
# "address_line3": "",
# "city_locality": "Watford",
# "state_province": "Hertfordshire",
# "postal_code": "WD25 7LR",
# "country_code": "GB",
# "address_residential_indicator": "unknown"
# },
# "messages": [
# {
# "code": "a1003",
# "message": "There was a change or addition to the state/province.",
# "type": "warning",
# "detail_code": "state_province_changed_or_added"
# },
# {
# "code": "a1007",
# "message": "This address has been verified down to the suite/PO box level (highest possible accuracy with the provided data)",
# "type": "info",
# "detail_code": "verified_to_suite_level"
# },
# {
# "code": "a1008",
# "message": "This record was successfully geocoded to the community level (ZIP centroid in the US, 3 digit postal code for Canada)",
# "type": "info",
# "detail_code": "coded_to_community_level"
# }
# ]
# }
# ]
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
# json is a CkJsonObject
set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
set json [CkJsonArray_ObjectAt $jarrResp $i]
set status [CkJsonObject_stringOf $json "status"]
set Name [CkJsonObject_stringOf $json "original_address.name"]
set Phone [CkJsonObject_stringOf $json "original_address.phone"]
set Company_name [CkJsonObject_stringOf $json "original_address.company_name"]
set Address_line1 [CkJsonObject_stringOf $json "original_address.address_line1"]
set Address_line2 [CkJsonObject_stringOf $json "original_address.address_line2"]
set Address_line3 [CkJsonObject_stringOf $json "original_address.address_line3"]
set City_locality [CkJsonObject_stringOf $json "original_address.city_locality"]
set State_province [CkJsonObject_stringOf $json "original_address.state_province"]
set Postal_code [CkJsonObject_stringOf $json "original_address.postal_code"]
set Country_code [CkJsonObject_stringOf $json "original_address.country_code"]
set Address_residential_indicator [CkJsonObject_stringOf $json "original_address.address_residential_indicator"]
set matched_addressName [CkJsonObject_stringOf $json "matched_address.name"]
set matched_addressPhone [CkJsonObject_stringOf $json "matched_address.phone"]
set matched_addressCompany_name [CkJsonObject_stringOf $json "matched_address.company_name"]
set matched_addressAddress_line1 [CkJsonObject_stringOf $json "matched_address.address_line1"]
set matched_addressAddress_line2 [CkJsonObject_stringOf $json "matched_address.address_line2"]
set matched_addressAddress_line3 [CkJsonObject_stringOf $json "matched_address.address_line3"]
set matched_addressCity_locality [CkJsonObject_stringOf $json "matched_address.city_locality"]
set matched_addressState_province [CkJsonObject_stringOf $json "matched_address.state_province"]
set matched_addressPostal_code [CkJsonObject_stringOf $json "matched_address.postal_code"]
set matched_addressCountry_code [CkJsonObject_stringOf $json "matched_address.country_code"]
set matched_addressAddress_residential_indicator [CkJsonObject_stringOf $json "matched_address.address_residential_indicator"]
set j 0
set count_j [CkJsonObject_SizeOfArray $json "messages"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set code [CkJsonObject_stringOf $json "messages[j].code"]
set message [CkJsonObject_stringOf $json "messages[j].message"]
set v_type [CkJsonObject_stringOf $json "messages[j].type"]
set detail_code [CkJsonObject_stringOf $json "messages[j].detail_code"]
set j [expr $j + 1]
}
delete_CkJsonObject $json
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonArray $jarr
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '[
{
"address_line1": "Studio Tour Drive, Leavesden WD25 7LR, UK",
"country_code": "GB"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (warning)",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n \"address_line1\": \"Studio Tour Drive, Leavesden WD25 7LR, UK\",\n \"country_code\": \"GB\"\n\t}\n]"
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
},
"description": "This request shows how ShipEngine responds when an address can be verified, but there are warnings such as major corrections. The `status` field is `verified`, and the `messages` array lists the warnings and other information about the corrected the address."
},
"response": [
{
"name": "Validate an address (warning)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n \"address_line1\": \"Studio Tour Drive, Leavesden WD25 7LR, UK\",\n \"country_code\": \"GB\"\n\t}\n]",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 22 Oct 2019 20:32:43 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1614"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "12327571-2884-4f7d-bb9f-ad2cf9331d98"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"verified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"Studio Tour Drive, Leavesden WD25 7LR, UK\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": null,\n \"state_province\": null,\n \"postal_code\": null,\n \"country_code\": \"GB\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": \"WARNER BROS STUDIO TOUR\",\n \"address_line1\": \"Studio Tour Drive\",\n \"address_line2\": \"\",\n \"address_line3\": \"\",\n \"city_locality\": \"Watford\",\n \"state_province\": \"Hertfordshire\",\n \"postal_code\": \"WD25 7LR\",\n \"country_code\": \"GB\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"messages\": [\n {\n \"code\": \"a1003\",\n \"message\": \"There was a change or addition to the state/province.\",\n \"type\": \"warning\",\n \"detail_code\": \"state_province_changed_or_added\"\n },\n {\n \"code\": \"a1007\",\n \"message\": \"This address has been verified down to the suite/PO box level (highest possible accuracy with the provided data)\",\n \"type\": \"info\",\n \"detail_code\": \"verified_to_suite_level\"\n },\n {\n \"code\": \"a1008\",\n \"message\": \"This record was successfully geocoded to the community level (ZIP centroid in the US, 3 digit postal code for Canada)\",\n \"type\": \"info\",\n \"detail_code\": \"coded_to_community_level\"\n }\n ]\n }\n]"
}
]
}
