Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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"
; }
; ]
$oJarr = ObjCreate("Chilkat.JsonArray")
$oJarr.AddObjectAt(-1)
Local $oJsonObj_1 = $oJarr.ObjectAt($oJarr.Size - 1)
$oJsonObj_1.UpdateString("address_line1","Studio Tour Drive, Leavesden WD25 7LR, UK")
$oJsonObj_1.UpdateString("country_code","GB")
$oHttp.SetRequestHeader "API-Key","{{API_KEY}}"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJarr.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("POST","https://api.shipengine.com/v1/addresses/validate",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJarrResp = ObjCreate("Chilkat.JsonArray")
$oJarrResp.LoadSb($oSbResponseBody)
$oJarrResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJarrResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $oJson
Local $status
Local $sName
Local $sPhone
Local $sCompany_name
Local $sAddress_line1
Local $sAddress_line2
Local $sAddress_line3
Local $sCity_locality
Local $sState_province
Local $sPostal_code
Local $sCountry_code
Local $sAddress_residential_indicator
Local $sMatched_addressName
Local $sMatched_addressPhone
Local $sMatched_addressCompany_name
Local $sMatched_addressAddress_line1
Local $sMatched_addressAddress_line2
Local $sMatched_addressAddress_line3
Local $sMatched_addressCity_locality
Local $sMatched_addressState_province
Local $sMatched_addressPostal_code
Local $sMatched_addressCountry_code
Local $sMatched_addressAddress_residential_indicator
Local $iJ
Local $iCount_j
Local $sCode
Local $sMessage
Local $sV_type
Local $sDetail_code
Local $i = 0
Local $iCount_i = $oJarrResp.Size
While $i < $iCount_i
$oJson = $oJarrResp.ObjectAt($i)
$status = $oJson.StringOf("status")
$sName = $oJson.StringOf("original_address.name")
$sPhone = $oJson.StringOf("original_address.phone")
$sCompany_name = $oJson.StringOf("original_address.company_name")
$sAddress_line1 = $oJson.StringOf("original_address.address_line1")
$sAddress_line2 = $oJson.StringOf("original_address.address_line2")
$sAddress_line3 = $oJson.StringOf("original_address.address_line3")
$sCity_locality = $oJson.StringOf("original_address.city_locality")
$sState_province = $oJson.StringOf("original_address.state_province")
$sPostal_code = $oJson.StringOf("original_address.postal_code")
$sCountry_code = $oJson.StringOf("original_address.country_code")
$sAddress_residential_indicator = $oJson.StringOf("original_address.address_residential_indicator")
$sMatched_addressName = $oJson.StringOf("matched_address.name")
$sMatched_addressPhone = $oJson.StringOf("matched_address.phone")
$sMatched_addressCompany_name = $oJson.StringOf("matched_address.company_name")
$sMatched_addressAddress_line1 = $oJson.StringOf("matched_address.address_line1")
$sMatched_addressAddress_line2 = $oJson.StringOf("matched_address.address_line2")
$sMatched_addressAddress_line3 = $oJson.StringOf("matched_address.address_line3")
$sMatched_addressCity_locality = $oJson.StringOf("matched_address.city_locality")
$sMatched_addressState_province = $oJson.StringOf("matched_address.state_province")
$sMatched_addressPostal_code = $oJson.StringOf("matched_address.postal_code")
$sMatched_addressCountry_code = $oJson.StringOf("matched_address.country_code")
$sMatched_addressAddress_residential_indicator = $oJson.StringOf("matched_address.address_residential_indicator")
$iJ = 0
$iCount_j = $oJson.SizeOfArray("messages")
While $iJ < $iCount_j
$oJson.J = $iJ
$sCode = $oJson.StringOf("messages[j].code")
$sMessage = $oJson.StringOf("messages[j].message")
$sV_type = $oJson.StringOf("messages[j].type")
$sDetail_code = $oJson.StringOf("messages[j].detail_code")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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]"
}
]
}
