(PowerShell) Shippo Validate Address

Demonstrates how to validate your addresses through the Shippo API before you create labels.

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

Chilkat .NET Downloads Chilkat .NET Assemblies Chilkat for Mono

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

# 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="215 Clayton St." \
#     -d city="San Francisco" \
#     -d state="CA" \
#     -d zip=94117 \
#     -d country="US" \
#     -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","215 Clayton St.")
$req.AddParam("city","San Francisco")
$req.AddParam("state","CA")
$req.AddParam("zip","94117")
$req.AddParam("country","US")
$req.AddParam("email","shippotle@goshippo.com")
$req.AddParam("validate","true")

$req.AddHeader("Authorization","ShippoToken <API_TOKEN>")

$resp = $http.PostUrlEncoded("https://api.goshippo.com/addresses/",$req)
if ($http.LastMethodSuccess -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": "2015-03-30T23:47:11.574Z",
#   "object_updated": "2015-03-30T23:47:11.596Z",
#   "object_id": "67183b2e81e9421f894bfbcdc4236b16",
#   "is_complete": false,
#   "validation_results": {
#     "is_valid": false,
#     "messages": [
#       {
#         "source": "USPS",
#         "code": "Address Not Found",
#         "type": "address_error",
#         "text": "The address as submitted could not be found. Please check for excessive abbreviations in the street address line or in the City name."
#       }
#     ]
#   },
#   "object_owner": "shippotle@goshippo.com",
#   "name": "Shawn Ippotle",
#   "company": "Shippo",
#   "street_no": "",
#   "street1": "215 HIPPO ST.",
#   "street2": "",
#   "city": "SAN FRANCISCO",
#   "state": "CA",
#   "zip": "94107",
#   "country": "US",
#   "phone": ""
# }

# 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")
$city = $jResp.StringOf("city")
$state = $jResp.StringOf("state")
$zip = $jResp.StringOf("zip")
$country = $jResp.StringOf("country")
$phone = $jResp.StringOf("phone")
$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")
    $code = $jResp.StringOf("validation_results.messages[i].code")
    $v_type = $jResp.StringOf("validation_results.messages[i].type")
    $text = $jResp.StringOf("validation_results.messages[i].text")
    $i = $i + 1
}