Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// 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": "525 Winchester",
// "postal_code": "95128",
// "country_code": "US"
// }
// ]
Dim jarr As New Chilkat.JsonArray
success = jarr.AddObjectAt(-1)
Dim jsonObj_1 As Chilkat.JsonObject
jsonObj_1 = jarr.ObjectAt(jarr.Size - 1)
success = jsonObj_1.UpdateString("address_line1","525 Winchester")
success = jsonObj_1.UpdateString("postal_code","95128")
success = jsonObj_1.UpdateString("country_code","US")
http.SetRequestHeader "API-Key","{{API_KEY}}"
http.SetRequestHeader "Content-Type","application/json"
Dim sbRequestBody As New Chilkat.StringBuilder
success = jarr.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("POST","https://api.shipengine.com/v1/addresses/validate",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jarrResp As New Chilkat.JsonArray
success = jarrResp.LoadSb(sbResponseBody)
jarrResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jarrResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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": "525 Winchester",
// "address_line2": null,
// "address_line3": null,
// "city_locality": null,
// "state_province": null,
// "postal_code": "95128",
// "country_code": "US",
// "address_residential_indicator": "unknown"
// },
// "matched_address": {
// "name": null,
// "phone": null,
// "company_name": null,
// "address_line1": "525 S WINCHESTER BLVD",
// "address_line2": "",
// "address_line3": null,
// "city_locality": "SAN JOSE",
// "state_province": "CA",
// "postal_code": "95128-2537",
// "country_code": "US",
// "address_residential_indicator": "no"
// },
// "messages": [
// ]
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim json As Chilkat.JsonObject
Dim status As String
Dim Name As String
Dim Phone As String
Dim Company_name As String
Dim Address_line1 As String
Dim Address_line2 As String
Dim Address_line3 As String
Dim City_locality As String
Dim State_province As String
Dim Postal_code As String
Dim Country_code As String
Dim Address_residential_indicator As String
Dim matched_addressName As String
Dim matched_addressPhone As String
Dim matched_addressCompany_name As String
Dim matched_addressAddress_line1 As String
Dim matched_addressAddress_line2 As String
Dim matched_addressAddress_line3 As String
Dim matched_addressCity_locality As String
Dim matched_addressState_province As String
Dim matched_addressPostal_code As String
Dim matched_addressCountry_code As String
Dim matched_addressAddress_residential_indicator As String
Dim j As Int32
Dim count_j As Int32
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jarrResp.Size
While i < 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 < count_j
json.J = j
j = j + 1
Wend
i = i + 1
Wend
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '[
{
"address_line1": "525 Winchester",
"postal_code": "95128",
"country_code": "US"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (incomplete)",
"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\t\t\"address_line1\": \"525 Winchester\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"US\"\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 demonstrates ShipEngine's ability to validate and fill-in an incomplete address. For most addresses, a `postal_code` is sufficient to fill-in the `city_locality` and `state_province`, or vice-versa. Also notice that the incomplete stree address (525 Winchester) is filled-in as well (525 S Winchester Blvd)."
},
"response": [
{
"name": "Validate an address (incomplete)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n\t\t\"address_line1\": \"525 Winchester\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"US\"\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": "Wed, 18 Sep 2019 14:10:26 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "831"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "9bf1b583-40ed-4715-92b7-0e6bd6cd374c"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"verified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 Winchester\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": null,\n \"state_province\": null,\n \"postal_code\": \"95128\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 S WINCHESTER BLVD\",\n \"address_line2\": \"\",\n \"address_line3\": null,\n \"city_locality\": \"SAN JOSE\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128-2537\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"no\"\n },\n \"messages\": []\n }\n]"
}
]
}
