(Tcl) Shippo Label Purchase

Demonstrates how to create a shipping label in one API call through Shippo.

For more information, see https://goshippo.com/docs/shipping-labels/

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/transactions/  \
#     -H "Authorization: ShippoToken <API_Token>" \
#     -H "Content-Type: application/json"  \
#     -d '{
#         "shipment": {
#             "address_from": {
#                 "name": "Mr. Hippo",
#                 "street1": "215 Clayton St.",
#                 "city": "San Francisco",
#                 "state": "CA",
#                 "zip": "94117",
#                 "country": "US",
#                 "phone": "+1 555 341 9393",
#                 "email": "support@goshippo.com"
#             },
#             "address_to": {
#                 "name": "Mrs. Hippo",
#                 "street1": "965 Mission St.",
#                 "city": "San Francisco",
#                 "state": "CA",
#                 "zip": "94105",
#                 "country": "US",
#                 "phone": "+1 555 341 9393",
#                 "email": "support@goshippo.com"
#             },
#             "parcels": [{
#                 "length": "5",
#                 "width": "5",
#                 "height": "5",
#                 "distance_unit": "in",
#                 "weight": "2",
#                 "mass_unit": "lb"
#             }]
#         },
#         "carrier_account": "b741b99f95e841639b54272834bc478c",
#         "servicelevel_token": "usps_priority"
#         }'

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "shipment": {
#     "address_from": {
#       "name": "Mr. Hippo",
#       "street1": "215 Clayton St.",
#       "city": "San Francisco",
#       "state": "CA",
#       "zip": "94117",
#       "country": "US",
#       "phone": "+1 555 341 9393",
#       "email": "support@goshippo.com"
#     },
#     "address_to": {
#       "name": "Mrs. Hippo",
#       "street1": "965 Mission St.",
#       "city": "San Francisco",
#       "state": "CA",
#       "zip": "94105",
#       "country": "US",
#       "phone": "+1 555 341 9393",
#       "email": "support@goshippo.com"
#     },
#     "parcels": [
#       {
#         "length": "5",
#         "width": "5",
#         "height": "5",
#         "distance_unit": "in",
#         "weight": "2",
#         "mass_unit": "lb"
#       }
#     ]
#   },
#   "carrier_account": "b741b99f95e841639b54272834bc478c",
#   "servicelevel_token": "usps_priority"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "shipment.address_from.name" "Mr. Hippo"
CkJsonObject_UpdateString $json "shipment.address_from.street1" "215 Clayton St."
CkJsonObject_UpdateString $json "shipment.address_from.city" "San Francisco"
CkJsonObject_UpdateString $json "shipment.address_from.state" "CA"
CkJsonObject_UpdateString $json "shipment.address_from.zip" "94117"
CkJsonObject_UpdateString $json "shipment.address_from.country" "US"
CkJsonObject_UpdateString $json "shipment.address_from.phone" "+1 555 341 9393"
CkJsonObject_UpdateString $json "shipment.address_from.email" "support@goshippo.com"
CkJsonObject_UpdateString $json "shipment.address_to.name" "Mrs. Hippo"
CkJsonObject_UpdateString $json "shipment.address_to.street1" "965 Mission St."
CkJsonObject_UpdateString $json "shipment.address_to.city" "San Francisco"
CkJsonObject_UpdateString $json "shipment.address_to.state" "CA"
CkJsonObject_UpdateString $json "shipment.address_to.zip" "94105"
CkJsonObject_UpdateString $json "shipment.address_to.country" "US"
CkJsonObject_UpdateString $json "shipment.address_to.phone" "+1 555 341 9393"
CkJsonObject_UpdateString $json "shipment.address_to.email" "support@goshippo.com"
CkJsonObject_UpdateString $json "shipment.parcels[0].length" "5"
CkJsonObject_UpdateString $json "shipment.parcels[0].width" "5"
CkJsonObject_UpdateString $json "shipment.parcels[0].height" "5"
CkJsonObject_UpdateString $json "shipment.parcels[0].distance_unit" "in"
CkJsonObject_UpdateString $json "shipment.parcels[0].weight" "2"
CkJsonObject_UpdateString $json "shipment.parcels[0].mass_unit" "lb"
CkJsonObject_UpdateString $json "carrier_account" "b741b99f95e841639b54272834bc478c"
CkJsonObject_UpdateString $json "servicelevel_token" "usps_priority"

CkHttp_SetRequestHeader $http "Authorization" "ShippoToken <API_Token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.goshippo.com/transactions/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    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_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {
#   "object_state": "VALID",
#   "status": "SUCCESS",
#   "object_created": "2013-12-27T19:14:48.273Z",
#   "object_updated": "2013-12-27T19:14:48.273Z",
#   "object_id": "64bba01845ef40d29374032599f22588",
#   "object_owner": "shippotle@goshippo.com",
#   "was_test": false,
#   "rate": {
#     "object_id": "cf6fea899f1848b494d9568e8266e076",
#     "amount": "5.50",
#     "currency": "USD",
#     "amount_local": "5.50",
#     "currency_local": "USD",
#     "provider": "USPS",
#     "servicelevel_name": "Priority Mail",
#     "servicelevel_token": "usps_priority",
#     "carrier_account": "078870331023437cb917f5187429b093"
#   },
#   "tracking_number": "ZW70QJC",
#   "tracking_status": {
#     "object_created": "2013-12-27T23:17:41.411Z",
#     "object_id": "a21b3d6831c14ceaba6730179ce6e784",
#     "status": "UNKNOWN",
#     "status_details": "",
#     "status_date": "2013-12-28T12:04:04.214Z"
#   },
#   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=ZW70QJC",
#   "eta": "2013-12-30T12:00:00.000Z",
#   "label_url": "https://shippo-delivery.s3.amazonaws.com/96.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
#   "commercial_invoice_url": "",
#   "metadata": "",
#   "messages": [
#   ]
# }

# 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_state [CkJsonObject_stringOf $jResp "object_state"]
set status [CkJsonObject_stringOf $jResp "status"]
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 object_owner [CkJsonObject_stringOf $jResp "object_owner"]
set was_test [CkJsonObject_BoolOf $jResp "was_test"]
set rateObject_id [CkJsonObject_stringOf $jResp "rate.object_id"]
set rateAmount [CkJsonObject_stringOf $jResp "rate.amount"]
set rateCurrency [CkJsonObject_stringOf $jResp "rate.currency"]
set rateAmount_local [CkJsonObject_stringOf $jResp "rate.amount_local"]
set rateCurrency_local [CkJsonObject_stringOf $jResp "rate.currency_local"]
set rateProvider [CkJsonObject_stringOf $jResp "rate.provider"]
set rateServicelevel_name [CkJsonObject_stringOf $jResp "rate.servicelevel_name"]
set rateServicelevel_token [CkJsonObject_stringOf $jResp "rate.servicelevel_token"]
set rateCarrier_account [CkJsonObject_stringOf $jResp "rate.carrier_account"]
set tracking_number [CkJsonObject_stringOf $jResp "tracking_number"]
set tracking_statusObject_created [CkJsonObject_stringOf $jResp "tracking_status.object_created"]
set tracking_statusObject_id [CkJsonObject_stringOf $jResp "tracking_status.object_id"]
set tracking_statusStatus [CkJsonObject_stringOf $jResp "tracking_status.status"]
set tracking_statusStatus_details [CkJsonObject_stringOf $jResp "tracking_status.status_details"]
set tracking_statusStatus_date [CkJsonObject_stringOf $jResp "tracking_status.status_date"]
set tracking_url_provider [CkJsonObject_stringOf $jResp "tracking_url_provider"]
set eta [CkJsonObject_stringOf $jResp "eta"]
set label_url [CkJsonObject_stringOf $jResp "label_url"]
set commercial_invoice_url [CkJsonObject_stringOf $jResp "commercial_invoice_url"]
set metadata [CkJsonObject_stringOf $jResp "metadata"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "messages"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp