(Ruby) Shippo Label Purchase

Demonstrates how to create a shipping label in one API call through Shippo.

For more information, see https://goshippo.com/docs/shipping-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/transactions/  \
#     -H "Authorization: ShippoToken <API_Token>" \
#     -H "Content-Type: application/json"  \
#     -d '{
#         "shipment": {
#             "address_from": {
#                 "name": "Mr. Hippo",
#                 "street1": "215 Clayton St.",
#                 "city": "San Francisco",
#                 "state": "CA",
#                 "zip": "94117",
#                 "country": "US",
#                 "phone": "+1 555 341 9393",
#                 "email": "support@goshippo.com"
#             },
#             "address_to": {
#                 "name": "Mrs. Hippo",
#                 "street1": "965 Mission St.",
#                 "city": "San Francisco",
#                 "state": "CA",
#                 "zip": "94105",
#                 "country": "US",
#                 "phone": "+1 555 341 9393",
#                 "email": "support@goshippo.com"
#             },
#             "parcels": [{
#                 "length": "5",
#                 "width": "5",
#                 "height": "5",
#                 "distance_unit": "in",
#                 "weight": "2",
#                 "mass_unit": "lb"
#             }]
#         },
#         "carrier_account": "b741b99f95e841639b54272834bc478c",
#         "servicelevel_token": "usps_priority"
#         }'

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "shipment": {
#     "address_from": {
#       "name": "Mr. Hippo",
#       "street1": "215 Clayton St.",
#       "city": "San Francisco",
#       "state": "CA",
#       "zip": "94117",
#       "country": "US",
#       "phone": "+1 555 341 9393",
#       "email": "support@goshippo.com"
#     },
#     "address_to": {
#       "name": "Mrs. Hippo",
#       "street1": "965 Mission St.",
#       "city": "San Francisco",
#       "state": "CA",
#       "zip": "94105",
#       "country": "US",
#       "phone": "+1 555 341 9393",
#       "email": "support@goshippo.com"
#     },
#     "parcels": [
#       {
#         "length": "5",
#         "width": "5",
#         "height": "5",
#         "distance_unit": "in",
#         "weight": "2",
#         "mass_unit": "lb"
#       }
#     ]
#   },
#   "carrier_account": "b741b99f95e841639b54272834bc478c",
#   "servicelevel_token": "usps_priority"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("shipment.address_from.name","Mr. Hippo")
json.UpdateString("shipment.address_from.street1","215 Clayton St.")
json.UpdateString("shipment.address_from.city","San Francisco")
json.UpdateString("shipment.address_from.state","CA")
json.UpdateString("shipment.address_from.zip","94117")
json.UpdateString("shipment.address_from.country","US")
json.UpdateString("shipment.address_from.phone","+1 555 341 9393")
json.UpdateString("shipment.address_from.email","support@goshippo.com")
json.UpdateString("shipment.address_to.name","Mrs. Hippo")
json.UpdateString("shipment.address_to.street1","965 Mission St.")
json.UpdateString("shipment.address_to.city","San Francisco")
json.UpdateString("shipment.address_to.state","CA")
json.UpdateString("shipment.address_to.zip","94105")
json.UpdateString("shipment.address_to.country","US")
json.UpdateString("shipment.address_to.phone","+1 555 341 9393")
json.UpdateString("shipment.address_to.email","support@goshippo.com")
json.UpdateString("shipment.parcels[0].length","5")
json.UpdateString("shipment.parcels[0].width","5")
json.UpdateString("shipment.parcels[0].height","5")
json.UpdateString("shipment.parcels[0].distance_unit","in")
json.UpdateString("shipment.parcels[0].weight","2")
json.UpdateString("shipment.parcels[0].mass_unit","lb")
json.UpdateString("carrier_account","b741b99f95e841639b54272834bc478c")
json.UpdateString("servicelevel_token","usps_priority")

http.SetRequestHeader("Authorization","ShippoToken <API_Token>")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.goshippo.com/transactions/","application/json",json)
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)

# {
#   "object_state": "VALID",
#   "status": "SUCCESS",
#   "object_created": "2013-12-27T19:14:48.273Z",
#   "object_updated": "2013-12-27T19:14:48.273Z",
#   "object_id": "64bba01845ef40d29374032599f22588",
#   "object_owner": "shippotle@goshippo.com",
#   "was_test": false,
#   "rate": {
#     "object_id": "cf6fea899f1848b494d9568e8266e076",
#     "amount": "5.50",
#     "currency": "USD",
#     "amount_local": "5.50",
#     "currency_local": "USD",
#     "provider": "USPS",
#     "servicelevel_name": "Priority Mail",
#     "servicelevel_token": "usps_priority",
#     "carrier_account": "078870331023437cb917f5187429b093"
#   },
#   "tracking_number": "ZW70QJC",
#   "tracking_status": {
#     "object_created": "2013-12-27T23:17:41.411Z",
#     "object_id": "a21b3d6831c14ceaba6730179ce6e784",
#     "status": "UNKNOWN",
#     "status_details": "",
#     "status_date": "2013-12-28T12:04:04.214Z"
#   },
#   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=ZW70QJC",
#   "eta": "2013-12-30T12:00:00.000Z",
#   "label_url": "https://shippo-delivery.s3.amazonaws.com/96.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
#   "commercial_invoice_url": "",
#   "metadata": "",
#   "messages": [
#   ]
# }

# 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_state = jResp.stringOf("object_state")
status = jResp.stringOf("status")
object_created = jResp.stringOf("object_created")
object_updated = jResp.stringOf("object_updated")
object_id = jResp.stringOf("object_id")
object_owner = jResp.stringOf("object_owner")
was_test = jResp.BoolOf("was_test")
rateObject_id = jResp.stringOf("rate.object_id")
rateAmount = jResp.stringOf("rate.amount")
rateCurrency = jResp.stringOf("rate.currency")
rateAmount_local = jResp.stringOf("rate.amount_local")
rateCurrency_local = jResp.stringOf("rate.currency_local")
rateProvider = jResp.stringOf("rate.provider")
rateServicelevel_name = jResp.stringOf("rate.servicelevel_name")
rateServicelevel_token = jResp.stringOf("rate.servicelevel_token")
rateCarrier_account = jResp.stringOf("rate.carrier_account")
tracking_number = jResp.stringOf("tracking_number")
tracking_statusObject_created = jResp.stringOf("tracking_status.object_created")
tracking_statusObject_id = jResp.stringOf("tracking_status.object_id")
tracking_statusStatus = jResp.stringOf("tracking_status.status")
tracking_statusStatus_details = jResp.stringOf("tracking_status.status_details")
tracking_statusStatus_date = jResp.stringOf("tracking_status.status_date")
tracking_url_provider = jResp.stringOf("tracking_url_provider")
eta = jResp.stringOf("eta")
label_url = jResp.stringOf("label_url")
commercial_invoice_url = jResp.stringOf("commercial_invoice_url")
metadata = jResp.stringOf("metadata")
i = 0
count_i = jResp.SizeOfArray("messages")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end