(Tcl) Shippo Generate a Return Label

Demonstrates how to generate a pay-on-use return label.

For more information, see https://goshippo.com/docs/return-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/shipments/ \
#     -H "Authorization: ShippoToken <API_Token>" \
#     -d address_from="d799c2679e644279b59fe661ac8fa488" \
#     -d address_to="42236bcf36214f62bcc6d7f12f02a849" \
#     -d parcels=["7df2ecf8b4224763ab7c71fae7ec8274"] \
#     -d shipment_date="2013-12-03T12:00:00.000Z" \
#     -d extra='{ "is_return": true}' \
#     -d async=false

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/shipments/"
CkHttpRequest_put_ContentType $req "application/x-www-form-urlencoded"
CkHttpRequest_AddParam $req "address_from" "d799c2679e644279b59fe661ac8fa488"
CkHttpRequest_AddParam $req "address_to" "42236bcf36214f62bcc6d7f12f02a849"
CkHttpRequest_AddParam $req "parcels" "[\"7df2ecf8b4224763ab7c71fae7ec8274\"]"
CkHttpRequest_AddParam $req "shipment_date" "2013-12-03T12:00:00.000Z"
CkHttpRequest_AddParam $req "extra" "'{ \"is_return\": true}'"
CkHttpRequest_AddParam $req "async" "false"

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

# resp is a CkHttpResponse
set resp [CkHttp_PostUrlEncoded $http "https://api.goshippo.com/shipments/" $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)

# {}

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON


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