Lua

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. Lua

local chilkat = require("chilkat")

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

local http = chilkat.Http.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

local req = chilkat.HttpRequest.new()
req.http_verb = "POST"
req.path = "/transactions"
req.content_type = "application/x-www-form-urlencoded"
req:add_param("rate", "ec6143e746094bcab1bdc4c17600dabf")
req:add_param("label_file_type", "PDF")
req:add_param("async", "false")

req:add_header("Authorization", "ShippoToken <API_TOKEN>")

local resp = chilkat.HttpResponse.new()
local success = http:http_req("https://api.goshippo.com/transactions", req, resp)
if not success then
    print(http.last_error_text)
    return
end

local sbResponseBody = chilkat.StringBuilder.new()
resp:get_body_sb(sbResponseBody)
local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

local respStatusCode = resp.status_code
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(resp.header)
    print("Failed.")
    return
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

local object_state = jResp:string_of("object_state")
local status = jResp:string_of("status")
local object_created = jResp:string_of("object_created")
local object_updated = jResp:string_of("object_updated")
local object_id = jResp:string_of("object_id")
local object_owner = jResp:string_of("object_owner")
local was_test = jResp:bool_of("was_test")
local rateObject_id = jResp:string_of("rate.object_id")
local rateAmount = jResp:string_of("rate.amount")
local rateCurrency = jResp:string_of("rate.currency")
local rateAmount_local = jResp:string_of("rate.amount_local")
local rateCurrency_local = jResp:string_of("rate.currency_local")
local rateProvider = jResp:string_of("rate.provider")
local rateServicelevel_name = jResp:string_of("rate.servicelevel_name")
local rateServicelevel_token = jResp:string_of("rate.servicelevel_token")
local rateCarrier_account = jResp:string_of("rate.carrier_account")
local tracking_number = jResp:string_of("tracking_number")
local tracking_statusObject_created = jResp:string_of("tracking_status.object_created")
local tracking_statusObject_id = jResp:string_of("tracking_status.object_id")
local tracking_statusStatus = jResp:string_of("tracking_status.status")
local tracking_statusStatus_details = jResp:string_of("tracking_status.status_details")
local tracking_statusStatus_date = jResp:string_of("tracking_status.status_date")
local tracking_url_provider = jResp:string_of("tracking_url_provider")
local eta = jResp:string_of("eta")
local label_url = jResp:string_of("label_url")
local commercial_invoice_url = jResp:string_of("commercial_invoice_url")
local metadata = jResp:string_of("metadata")
local i = 0
local count_i = jResp:size_of_array("messages")
while i < count_i do
    jResp.i = i
    i = i + 1
end