(Tcl) Shippo Create a Refund

Demonstrates how to refund a shipping label.

For more information, see https://goshippo.com/docs/refunds/

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/refunds/ \
#     -H "Authorization: ShippoToken <API_Token>" \
#     -d transaction="4503427478ea45a899e9b54abc4c5803"

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/refunds/"
CkHttpRequest_put_ContentType $req "application/x-www-form-urlencoded"
CkHttpRequest_AddParam $req "transaction" "4503427478ea45a899e9b54abc4c5803"

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

# resp is a CkHttpResponse
set resp [CkHttp_PostUrlEncoded $http "https://api.goshippo.com/refunds/" $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": "2014-04-21T07:12:41.044Z",
#   "object_id": "bd7b8379a2e847bcb0818125943dde5d",
#   "object_owner": "shippotle@goshippo.com",
#   "object_updated": "2014-04-21T07:12:41.045Z",
#   "status": "QUEUED",
#   "transaction": "35ed59f23a514ecfa2faeaed93a00086"
# }

# 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_id [CkJsonObject_stringOf $jResp "object_id"]
set object_owner [CkJsonObject_stringOf $jResp "object_owner"]
set object_updated [CkJsonObject_stringOf $jResp "object_updated"]
set status [CkJsonObject_stringOf $jResp "status"]
set transaction [CkJsonObject_stringOf $jResp "transaction"]

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