Ruby

Shippo Create a Refund

See more Shippo Examples

Demonstrates how to refund a shipping label. Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl  https://api.goshippo.com/refunds/ \
#     -H "Authorization: ShippoToken <API_Token>" \
#     -d transaction="4503427478ea45a899e9b54abc4c5803"

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/refunds/")
req.put_ContentType("application/x-www-form-urlencoded")
req.AddParam("transaction","4503427478ea45a899e9b54abc4c5803")

req.AddHeader("Authorization","ShippoToken <API_Token>")

resp = Chilkat::CkHttpResponse.new()
success = http.HttpReq("https://api.goshippo.com/refunds/",req,resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

object_created = jResp.stringOf("object_created")
object_id = jResp.stringOf("object_id")
object_owner = jResp.stringOf("object_owner")
object_updated = jResp.stringOf("object_updated")
status = jResp.stringOf("status")
transaction = jResp.stringOf("transaction")