(Excel) Shippo Validate Global Address

Demonstrates how to validate a global address.

For more information, see https://goshippo.com/docs/address-validation/

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Implements the following CURL command:

' curl https://api.goshippo.com/addresses/ \
'     -H "Authorization: ShippoToken <API_TOKEN>" \
'     -d name="Shawn Ippotle" \
'     -d company="Shippo" \
'     -d street1="Kortrijksesteenweg 1005" \
'     -d city="Gent" \
'     -d zip=9000 \
'     -d country="BE" \
'     -d email="shippotle@goshippo.com"\
'     -d validate=true

Dim req As Chilkat.HttpRequest
Set req = Chilkat.NewHttpRequest
req.HttpVerb = "POST"
req.Path = "/addresses/"
req.ContentType = "application/x-www-form-urlencoded"
req.AddParam "name","Shawn Ippotle"
req.AddParam "company","Shippo"
req.AddParam "street1","Kortrijksesteenweg 1005"
req.AddParam "city","Gent"
req.AddParam "zip","9000"
req.AddParam "country","BE"
req.AddParam "email","shippotle@goshippo.com"
req.AddParam "validate","true"

req.AddHeader "Authorization","ShippoToken <API_TOKEN>"


Set resp = http.PostUrlEncoded("https://api.goshippo.com/addresses/",req)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "object_created": "2017-07-26T17:52:37.305Z",
'   "object_updated": "2017-07-26T17:52:37.351Z",
'   "object_id": "b7f9709df3914d1ca6efe4c30e7b0572",
'   "is_complete": true,
'   "validation_results": {
'     "is_valid": true,
'     "messages": [
'       {
'         "source": "Shippo Address Validator",
'         "type": "address_correction",
'         "code": "administrative_area_change",
'         "text": "The administrative area (state or province) was added or changed."
'       },
'       {
'         "source": "Shippo Address Validator",
'         "code": "geocoded_rooftop",
'         "text": "The record was geocoded down to rooftop level, meaning the point is within the property boundaries (most often the center)."
'       },
'       {
'         "source": "Shippo Address Validator",
'         "code": "premises_full",
'         "text": "The address has been verified to the Premise (House or Building) Level, which is the highest level possible with the reference data."
'       }
'     ]
'   },
'   "object_owner": "hippo@goshippo.com",
'   "name": "Hippo Shippo",
'   "company": "Shippo",
'   "street_no": "2",
'   "street1": "Unter den Linden",
'   "street2": "",
'   "street3": "",
'   "city": "Berlin",
'   "state": "",
'   "zip": "10117",
'   "country": "DE",
'   "longitude": "13.39751",
'   "latitude": "52.51785",
'   "phone": "14151234567",
'   "email": "hippo@goshippo.com",
'   "is_residential": null,
'   "metadata": "",
'   "test": false
' }

' Sample code for parsing the JSON response...
' Use the following online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON


object_created = jResp.StringOf("object_created")

object_updated = jResp.StringOf("object_updated")

object_id = jResp.StringOf("object_id")

is_complete = jResp.BoolOf("is_complete")

validation_resultsIs_valid = jResp.BoolOf("validation_results.is_valid")

object_owner = jResp.StringOf("object_owner")

name = jResp.StringOf("name")

company = jResp.StringOf("company")

street_no = jResp.StringOf("street_no")

street1 = jResp.StringOf("street1")

street2 = jResp.StringOf("street2")

street3 = jResp.StringOf("street3")

city = jResp.StringOf("city")

state = jResp.StringOf("state")

zip = jResp.StringOf("zip")

country = jResp.StringOf("country")

longitude = jResp.StringOf("longitude")

latitude = jResp.StringOf("latitude")

phone = jResp.StringOf("phone")

email = jResp.StringOf("email")

is_residential = jResp.StringOf("is_residential")

metadata = jResp.StringOf("metadata")

test = jResp.BoolOf("test")

i = 0

count_i = jResp.SizeOfArray("validation_results.messages")
Do While i < count_i
    jResp.I = i
    source = jResp.StringOf("validation_results.messages[i].source")
    v_type = jResp.StringOf("validation_results.messages[i].type")
    code = jResp.StringOf("validation_results.messages[i].code")
    text = jResp.StringOf("validation_results.messages[i].text")
    i = i + 1
Loop