PowerShell

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.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

$req = New-Object Chilkat.HttpRequest
$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>")

$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpReq("https://api.goshippo.com/addresses/",$req,$resp)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.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)

# {
#   "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")
while ($i -lt $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
}