Powershell / ShipEngine Walkthrough / Validate an address (warning)
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# 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"
# }
# ]
$jarr = New-Object Chilkat.JsonArray
$jarr.AddObjectAt(-1)
$jsonObj_1 = $jarr.ObjectAt($jarr.Size - 1)
$jsonObj_1.UpdateString("address_line1","Studio Tour Drive, Leavesden WD25 7LR, UK")
$jsonObj_1.UpdateString("country_code","GB")
$http.SetRequestHeader("API-Key","{{API_KEY}}")
$http.SetRequestHeader("Content-Type","application/json")
$sbRequestBody = New-Object Chilkat.StringBuilder
$jarr.EmitSb($sbRequestBody)
$resp = $http.PTextSb("POST","https://api.shipengine.com/v1/addresses/validate",$sbRequestBody,"utf-8","application/json",$false,$false)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jarrResp = New-Object Chilkat.JsonArray
$jarrResp.LoadSb($sbResponseBody)
$jarrResp.EmitCompact = $false
$("Response Body:")
$($jarrResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$i = 0
$count_i = $jarrResp.Size
while ($i -lt $count_i) {
$json = $jarrResp.ObjectAt($i)
$status = $json.StringOf("status")
$Name = $json.StringOf("original_address.name")
$Phone = $json.StringOf("original_address.phone")
$Company_name = $json.StringOf("original_address.company_name")
$Address_line1 = $json.StringOf("original_address.address_line1")
$Address_line2 = $json.StringOf("original_address.address_line2")
$Address_line3 = $json.StringOf("original_address.address_line3")
$City_locality = $json.StringOf("original_address.city_locality")
$State_province = $json.StringOf("original_address.state_province")
$Postal_code = $json.StringOf("original_address.postal_code")
$Country_code = $json.StringOf("original_address.country_code")
$Address_residential_indicator = $json.StringOf("original_address.address_residential_indicator")
$matched_addressName = $json.StringOf("matched_address.name")
$matched_addressPhone = $json.StringOf("matched_address.phone")
$matched_addressCompany_name = $json.StringOf("matched_address.company_name")
$matched_addressAddress_line1 = $json.StringOf("matched_address.address_line1")
$matched_addressAddress_line2 = $json.StringOf("matched_address.address_line2")
$matched_addressAddress_line3 = $json.StringOf("matched_address.address_line3")
$matched_addressCity_locality = $json.StringOf("matched_address.city_locality")
$matched_addressState_province = $json.StringOf("matched_address.state_province")
$matched_addressPostal_code = $json.StringOf("matched_address.postal_code")
$matched_addressCountry_code = $json.StringOf("matched_address.country_code")
$matched_addressAddress_residential_indicator = $json.StringOf("matched_address.address_residential_indicator")
$j = 0
$count_j = $json.SizeOfArray("messages")
while ($j -lt $count_j) {
$json.J = $j
$code = $json.StringOf("messages[j].code")
$message = $json.StringOf("messages[j].message")
$v_type = $json.StringOf("messages[j].type")
$detail_code = $json.StringOf("messages[j].detail_code")
$j = $j + 1
}
$i = $i + 1
}
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]"
}
]
}
