(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# 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/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

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/shipments/")
req.put_ContentType("application/x-www-form-urlencoded")
req.AddParam("address_from","d799c2679e644279b59fe661ac8fa488")
req.AddParam("address_to","42236bcf36214f62bcc6d7f12f02a849")
req.AddParam("parcels","[\"7df2ecf8b4224763ab7c71fae7ec8274\"]")
req.AddParam("shipment_date","2013-12-03T12:00:00.000Z")
req.AddParam("extra","'{ \"is_return\": true}'")
req.AddParam("async","false")

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

# resp is a CkHttpResponse
resp = http.PostUrlEncoded("https://api.goshippo.com/shipments/",req)
if (http.get_LastMethodSuccess() == 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)

# {}

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