B4X

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. B4X

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("http")

'  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 ChilkatHttpRequest
req.Initialize
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>")

Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpReq("https://api.goshippo.com/addresses/", req, resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
resp.GetBodySb(sbResponseBody)
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Log("Response Body:")
Log(jResp.Emit)

Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
    Log("Response Header:")
    Log(resp.Header)
    Log("Failed.")
    Return
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



Dim source As String
Dim v_type As String
Dim code As String
Dim text As String

Dim object_created As String = jResp.StringOf("object_created")
Dim object_updated As String = jResp.StringOf("object_updated")
Dim object_id As String = jResp.StringOf("object_id")
Dim is_complete As Boolean = jResp.BoolOf("is_complete")
Dim validation_resultsIs_valid As Boolean = jResp.BoolOf("validation_results.is_valid")
Dim object_owner As String = jResp.StringOf("object_owner")
Dim name As String = jResp.StringOf("name")
Dim company As String = jResp.StringOf("company")
Dim street_no As String = jResp.StringOf("street_no")
Dim street1 As String = jResp.StringOf("street1")
Dim street2 As String = jResp.StringOf("street2")
Dim street3 As String = jResp.StringOf("street3")
Dim city As String = jResp.StringOf("city")
Dim state As String = jResp.StringOf("state")
Dim zip As String = jResp.StringOf("zip")
Dim country As String = jResp.StringOf("country")
Dim longitude As String = jResp.StringOf("longitude")
Dim latitude As String = jResp.StringOf("latitude")
Dim phone As String = jResp.StringOf("phone")
Dim email As String = jResp.StringOf("email")
Dim is_residential As String = jResp.StringOf("is_residential")
Dim metadata As String = jResp.StringOf("metadata")
Dim test As Boolean = jResp.BoolOf("test")
Dim i As Int = 0
Dim count_i As Int = 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