Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJarr
LOCAL loJsonObj_1
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJarrResp
LOCAL lnRespStatusCode
LOCAL loJson
LOCAL lcStatus
LOCAL lcName
LOCAL lcPhone
LOCAL lcCompany_name
LOCAL lcAddress_line1
LOCAL lcAddress_line2
LOCAL lcAddress_line3
LOCAL lcCity_locality
LOCAL lcState_province
LOCAL lcPostal_code
LOCAL lcCountry_code
LOCAL lcAddress_residential_indicator
LOCAL lcMatched_addressName
LOCAL lcMatched_addressPhone
LOCAL lcMatched_addressCompany_name
LOCAL lcMatched_addressAddress_line1
LOCAL lcMatched_addressAddress_line2
LOCAL lcMatched_addressAddress_line3
LOCAL lcMatched_addressCity_locality
LOCAL lcMatched_addressState_province
LOCAL lcMatched_addressPostal_code
LOCAL lcMatched_addressCountry_code
LOCAL lcMatched_addressAddress_residential_indicator
LOCAL j
LOCAL lnCount_j
LOCAL lcCode
LOCAL lcMessage
LOCAL lcV_type
LOCAL lcDetail_code
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('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"
* }
* ]
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonArray')
loJarr = CreateObject('Chilkat.JsonArray')
loJarr.AddObjectAt(-1)
loJsonObj_1 = loJarr.ObjectAt(loJarr.Size - 1)
loJsonObj_1.UpdateString("address_line1","Studio Tour Drive, Leavesden WD25 7LR, UK")
loJsonObj_1.UpdateString("country_code","GB")
RELEASE loJsonObj_1
loHttp.SetRequestHeader("API-Key","{{API_KEY}}")
loHttp.SetRequestHeader("Content-Type","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJarr.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("POST","https://api.shipengine.com/v1/addresses/validate",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJarr
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonArray')
loJarrResp = CreateObject('Chilkat.JsonArray')
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = 0
? "Response Body:"
? loJarrResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJarr
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJarrResp
CANCEL
ENDIF
RELEASE loResp
* 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
lnCount_i = loJarrResp.Size
DO WHILE i < lnCount_i
loJson = loJarrResp.ObjectAt(i)
lcStatus = loJson.StringOf("status")
lcName = loJson.StringOf("original_address.name")
lcPhone = loJson.StringOf("original_address.phone")
lcCompany_name = loJson.StringOf("original_address.company_name")
lcAddress_line1 = loJson.StringOf("original_address.address_line1")
lcAddress_line2 = loJson.StringOf("original_address.address_line2")
lcAddress_line3 = loJson.StringOf("original_address.address_line3")
lcCity_locality = loJson.StringOf("original_address.city_locality")
lcState_province = loJson.StringOf("original_address.state_province")
lcPostal_code = loJson.StringOf("original_address.postal_code")
lcCountry_code = loJson.StringOf("original_address.country_code")
lcAddress_residential_indicator = loJson.StringOf("original_address.address_residential_indicator")
lcMatched_addressName = loJson.StringOf("matched_address.name")
lcMatched_addressPhone = loJson.StringOf("matched_address.phone")
lcMatched_addressCompany_name = loJson.StringOf("matched_address.company_name")
lcMatched_addressAddress_line1 = loJson.StringOf("matched_address.address_line1")
lcMatched_addressAddress_line2 = loJson.StringOf("matched_address.address_line2")
lcMatched_addressAddress_line3 = loJson.StringOf("matched_address.address_line3")
lcMatched_addressCity_locality = loJson.StringOf("matched_address.city_locality")
lcMatched_addressState_province = loJson.StringOf("matched_address.state_province")
lcMatched_addressPostal_code = loJson.StringOf("matched_address.postal_code")
lcMatched_addressCountry_code = loJson.StringOf("matched_address.country_code")
lcMatched_addressAddress_residential_indicator = loJson.StringOf("matched_address.address_residential_indicator")
j = 0
lnCount_j = loJson.SizeOfArray("messages")
DO WHILE j < lnCount_j
loJson.J = j
lcCode = loJson.StringOf("messages[j].code")
lcMessage = loJson.StringOf("messages[j].message")
lcV_type = loJson.StringOf("messages[j].type")
lcDetail_code = loJson.StringOf("messages[j].detail_code")
j = j + 1
ENDDO
RELEASE loJson
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJarr
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJarrResp
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]"
}
]
}
