Ruby

Shippo POST to Transaction Endpoint

See more Shippo Examples

Demonstrates how to POST to the Transaction endpoint with your Rate object_id to purchase your international 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/transactions \
#     -H "Authorization: ShippoToken <API_TOKEN>" \
#     -d rate="ec6143e746094bcab1bdc4c17600dabf"
#     -d label_file_type="PDF"
#     -d async=false

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/transactions")
req.put_ContentType("application/x-www-form-urlencoded")
req.AddParam("rate","ec6143e746094bcab1bdc4c17600dabf")
req.AddParam("label_file_type","PDF")
req.AddParam("async","false")

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

resp = Chilkat::CkHttpResponse.new()
success = http.HttpReq("https://api.goshippo.com/transactions",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_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