(Tcl) Shippo Create Transaction Object

Creates a Transaction object that represents a shipping label purchase and is based on the shipping rate.

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>" \
#     -d rate="478fb066930e4e3195a3686f7ea5b612"
#     -d label_file_type="PDF"
#     -d async=false

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/transactions"
CkHttpRequest_put_ContentType $req "application/x-www-form-urlencoded"
CkHttpRequest_AddParam $req "rate" "478fb066930e4e3195a3686f7ea5b612"
CkHttpRequest_AddParam $req "label_file_type" "PDF"
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/transactions" $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_state": "VALID",
#   "status": "SUCCESS",
#   "object_created": "2019-06-28T18:04:08.679Z",
#   "object_updated": "2019-06-28T18:04:10.516Z",
#   "object_id": "6178e155da304f10aa4b4271fdca84fb",
#   "object_owner": "admin@chilkatsoft.com",
#   "test": true,
#   "rate": "dd7556c284e8444294d2ab7099e662d2",
#   "tracking_number": "92701902416755000000000015",
#   "tracking_status": "UNKNOWN",
#   "eta": null,
#   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92701902416755000000000015",
#   "label_url": "https://shippo-delivery-east.s3.amazonaws.com/6178e155da304f10aa4b4271fdca84fb.pdf?Signature=1LU0Qf11nQJGei%2FeLZr%2BQ5EwJS4%3D&Expires=1593281050&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
#   "commercial_invoice_url": null,
#   "messages": [
#   ],
#   "order": null,
#   "metadata": "",
#   "parcel": "5af766ff15684a4186b0e3c833348fac",
#   "billing": {
#     "payments": [
#     ]
#   }
# }

# 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 test [CkJsonObject_BoolOf $jResp "test"]
set rate [CkJsonObject_stringOf $jResp "rate"]
set tracking_number [CkJsonObject_stringOf $jResp "tracking_number"]
set tracking_status [CkJsonObject_stringOf $jResp "tracking_status"]
set eta [CkJsonObject_stringOf $jResp "eta"]
set tracking_url_provider [CkJsonObject_stringOf $jResp "tracking_url_provider"]
set label_url [CkJsonObject_stringOf $jResp "label_url"]
set commercial_invoice_url [CkJsonObject_stringOf $jResp "commercial_invoice_url"]
set order [CkJsonObject_stringOf $jResp "order"]
set metadata [CkJsonObject_stringOf $jResp "metadata"]
set parcel [CkJsonObject_stringOf $jResp "parcel"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "messages"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "billing.payments"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}

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