(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# 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

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/addresses/"
CkHttpRequest_put_ContentType $req "application/x-www-form-urlencoded"
CkHttpRequest_AddParam $req "name" "Shawn Ippotle"
CkHttpRequest_AddParam $req "company" "Shippo"
CkHttpRequest_AddParam $req "street1" "215 Clayton St."
CkHttpRequest_AddParam $req "city" "San Francisco"
CkHttpRequest_AddParam $req "state" "CA"
CkHttpRequest_AddParam $req "zip" "94117"
CkHttpRequest_AddParam $req "country" "US"
CkHttpRequest_AddParam $req "email" "shippotle@goshippo.com"
CkHttpRequest_AddParam $req "validate" "true"

CkHttpRequest_AddHeader $req "Authorization" "ShippoToken <API_TOKEN>"

# resp is a CkHttpResponse
set resp [CkHttp_PostUrlEncoded $http "https://api.goshippo.com/addresses/" $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set object_created [CkJsonObject_stringOf $jResp "object_created"]
set object_updated [CkJsonObject_stringOf $jResp "object_updated"]
set object_id [CkJsonObject_stringOf $jResp "object_id"]
set is_complete [CkJsonObject_BoolOf $jResp "is_complete"]
set validation_resultsIs_valid [CkJsonObject_BoolOf $jResp "validation_results.is_valid"]
set object_owner [CkJsonObject_stringOf $jResp "object_owner"]
set name [CkJsonObject_stringOf $jResp "name"]
set company [CkJsonObject_stringOf $jResp "company"]
set street_no [CkJsonObject_stringOf $jResp "street_no"]
set street1 [CkJsonObject_stringOf $jResp "street1"]
set street2 [CkJsonObject_stringOf $jResp "street2"]
set city [CkJsonObject_stringOf $jResp "city"]
set state [CkJsonObject_stringOf $jResp "state"]
set zip [CkJsonObject_stringOf $jResp "zip"]
set country [CkJsonObject_stringOf $jResp "country"]
set phone [CkJsonObject_stringOf $jResp "phone"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "validation_results.messages"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set source [CkJsonObject_stringOf $jResp "validation_results.messages[i].source"]
    set code [CkJsonObject_stringOf $jResp "validation_results.messages[i].code"]
    set v_type [CkJsonObject_stringOf $jResp "validation_results.messages[i].type"]
    set text [CkJsonObject_stringOf $jResp "validation_results.messages[i].text"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp