Lua

Shippo Generate a Return Label

See more Shippo Examples

Demonstrates how to generate a pay-on-use return 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/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

local req = chilkat.HttpRequest.new()
req.http_verb = "POST"
req.path = "/shipments/"
req.content_type = "application/x-www-form-urlencoded"
req:add_param("address_from", "d799c2679e644279b59fe661ac8fa488")
req:add_param("address_to", "42236bcf36214f62bcc6d7f12f02a849")
req:add_param("parcels", "[\"7df2ecf8b4224763ab7c71fae7ec8274\"]")
req:add_param("shipment_date", "2013-12-03T12:00:00.000Z")
req:add_param("extra", "'{ \"is_return\": true}'")
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/shipments/", 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)

-- {}

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