Ruby

Shippo Create Transaction Object

See more Shippo Examples

Creates a Transaction object that represents a shipping label purchase and is based on the shipping rate. 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="478fb066930e4e3195a3686f7ea5b612"
#     -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","478fb066930e4e3195a3686f7ea5b612")
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": "2019-06-28T18:04:08.679Z",
#   "object_updated": "2019-06-28T18:04:10.516Z",
#   "object_id": "6178e155da304f10aa4b4271fdca84fb",
#   "object_owner": "admin@chilkatsoft.com",
#   "test": true,
#   "rate": "dd7556c284e8444294d2ab7099e662d2",
#   "tracking_number": "92701902416755000000000015",
#   "tracking_status": "UNKNOWN",
#   "eta": null,
#   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92701902416755000000000015",
#   "label_url": "https://shippo-delivery-east.s3.amazonaws.com/6178e155da304f10aa4b4271fdca84fb.pdf?Signature=1LU0Qf11nQJGei%2FeLZr%2BQ5EwJS4%3D&Expires=1593281050&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
#   "commercial_invoice_url": null,
#   "messages": [
#   ],
#   "order": null,
#   "metadata": "",
#   "parcel": "5af766ff15684a4186b0e3c833348fac",
#   "billing": {
#     "payments": [
#     ]
#   }
# }

# 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")
test = jResp.BoolOf("test")
rate = jResp.stringOf("rate")
tracking_number = jResp.stringOf("tracking_number")
tracking_status = jResp.stringOf("tracking_status")
eta = jResp.stringOf("eta")
tracking_url_provider = jResp.stringOf("tracking_url_provider")
label_url = jResp.stringOf("label_url")
commercial_invoice_url = jResp.stringOf("commercial_invoice_url")
order = jResp.stringOf("order")
metadata = jResp.stringOf("metadata")
parcel = jResp.stringOf("parcel")
i = 0
count_i = jResp.SizeOfArray("messages")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("billing.payments")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end