Sample code for 30+ languages & platforms
Ruby

Add order to a ShippingEasy account

See more HTTP Misc Examples

Adds an order to a ShippingEasy account (calls the ShippingEasy REST API).

Chilkat Ruby Downloads

Download Chilkat for Ruby
Ruby 
require 'chilkat'

success = false

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# First create the JSON for the order.
# See https://shippingeasy.readme.io/v1.0/docs/creating-a-signature
# for sample JSON.  
# You may use the online tool at https://tools.chilkat.io/Default.cshtml to 
# generate the following code by pasting sample JSON into the tool.
json = Chilkat::CkJsonObject.new()
json.UpdateString("order.external_order_identifier","ABC-100")
json.UpdateString("order.ordered_at","2014-01-16 14:37:56 -0600")
json.UpdateString("order.order_status","awaiting_shipment")
json.UpdateString("order.subtotal_including_tax","10.00")
json.UpdateString("order.total_including_tax","10.00")
json.UpdateString("order.total_excluding_tax","10.00")
json.UpdateString("order.discount_amount","0.00")
json.UpdateString("order.coupon_discount","1.00")
json.UpdateString("order.subtotal_including_tax","0.00")
json.UpdateString("order.subtotal_excluding_tax","0.00")
json.UpdateString("order.subtotal_excluding_tax","0.00")
json.UpdateString("order.subtotal_tax","0.00")
json.UpdateString("order.total_tax","0")
json.UpdateString("order.base_shipping_cost","0.00")
json.UpdateString("order.shipping_cost_including_tax","0.00")
json.UpdateString("order.shipping_cost_excluding_tax","0.00")
json.UpdateString("order.shipping_cost_tax","0.00")
json.UpdateString("order.base_handling_cost","0.00")
json.UpdateString("order.handling_cost_excluding_tax","0.00")
json.UpdateString("order.handling_cost_including_tax","0.00")
json.UpdateString("order.handling_cost_tax","0.00")
json.UpdateString("order.base_wrapping_cost","0.00")
json.UpdateString("order.wrapping_cost_excluding_tax","0.00")
json.UpdateString("order.wrapping_cost_including_tax","0.00")
json.UpdateString("order.wrapping_cost_tax","0.00")
json.UpdateString("order.notes","Please send promptly.")
json.UpdateString("order.billing_company","Acme Inc.")
json.UpdateString("order.billing_first_name","Fred")
json.UpdateString("order.billing_last_name","Jones")
json.UpdateString("order.billing_address","1234 Street")
json.UpdateString("order.billing_address2","Suite 100")
json.UpdateString("order.billing_city","Austin")
json.UpdateString("order.billing_state","TX")
json.UpdateString("order.billing_postal_code","78701")
json.UpdateString("order.billing_country","USA")
json.UpdateString("order.billing_phone_number","512-123-1234")
json.UpdateString("order.billing_email","test@test.com")
json.UpdateString("order.recipients[0].first_name","Colin")
json.UpdateString("order.recipients[0].last_name","Homenick")
json.UpdateString("order.recipients[0].company","Wintheiser-Hickle")
json.UpdateString("order.recipients[0].email","charles.crona@okeefe.org")
json.UpdateString("order.recipients[0].phone_number","637-481-6505")
json.UpdateString("order.recipients[0].residential","true")
json.UpdateString("order.recipients[0].address","21937 Adelbert Springs")
json.UpdateString("order.recipients[0].address2","")
json.UpdateString("order.recipients[0].province","")
json.UpdateString("order.recipients[0].state","CT")
json.UpdateString("order.recipients[0].city","Terryfurt")
json.UpdateString("order.recipients[0].postal_code","93322")
json.UpdateString("order.recipients[0].postal_code_plus_4","1234")
json.UpdateString("order.recipients[0].country","Andorra")
json.UpdateString("order.recipients[0].shipping_method","Ground")
json.UpdateString("order.recipients[0].base_cost","10.00")
json.UpdateString("order.recipients[0].cost_excluding_tax","10.00")
json.UpdateString("order.recipients[0].cost_tax","0.00")
json.UpdateString("order.recipients[0].base_handling_cost","0.00")
json.UpdateString("order.recipients[0].handling_cost_excluding_tax","0.00")
json.UpdateString("order.recipients[0].handling_cost_including_tax","0.00")
json.UpdateString("order.recipients[0].handling_cost_tax","0.00")
json.UpdateString("order.recipients[0].shipping_zone_id","123")
json.UpdateString("order.recipients[0].shipping_zone_name","XYZ")
json.UpdateString("order.recipients[0].items_total","1")
json.UpdateString("order.recipients[0].items_shipped","0")
json.UpdateString("order.recipients[0].line_items[0].item_name","Pencil Holder")
json.UpdateString("order.recipients[0].line_items[0].sku","9876543")
json.UpdateString("order.recipients[0].line_items[0].bin_picking_number","7")
json.UpdateString("order.recipients[0].line_items[0].unit_price","1.30")
json.UpdateString("order.recipients[0].line_items[0].total_excluding_tax","1.30")
json.UpdateString("order.recipients[0].line_items[0].weight_in_ounces","10")
json.UpdateString("order.recipients[0].line_items[0].product_options.pa_size","large")
json.UpdateString("order.recipients[0].line_items[0].product_options.Colour","Blue")
json.UpdateString("order.recipients[0].line_items[0].quantity","1")

# Replace these values with your actual apiKey and apiSecret.
# (These are not valid values..)
storeApiKey = "569dc30d267f2c4d1f85f9920b2bf9f4"
apiKey = "f9a7c8ebdfd34beaf260d9b0296c7059"
apiSecret = "d3e9f8737d7196b1271a725f89e2156672bc1d900a25e6e0c1364e2f7a20f605"

# Our request will be sent to:
# https://app.shippingeasy.com/api/stores/:store_api_key/orders
# The path part of this request is: /api/stores/:store_api_key/orders

# See https://shippingeasy.readme.io/v1.0/docs/authentication-signing-requests
sbSigStr = Chilkat::CkStringBuilder.new()
sbSigStr.Append("POST&/api/stores/")
sbSigStr.Append(storeApiKey)
sbSigStr.Append("/orders&")
sbSigStr.Append("api_key=")
sbSigStr.Append(apiKey)
sbSigStr.Append("&api_timestamp=")

dt = Chilkat::CkDateTime.new()
dt.SetFromCurrentSystemTime()
sbSigStr.Append(dt.getAsUnixTimeStr(false))
sbSigStr.Append("&")

json.put_EmitCompact(true)
json.EmitSb(sbSigStr)

# Calculate the HMAC-SHA256 of the API Signature String using the API Secret as the HMAC key.
crypt = Chilkat::CkCrypt2.new()
crypt.put_MacAlgorithm("hmac")
crypt.put_EncodingMode("hex")
crypt.SetMacKeyString(apiSecret)
crypt.put_HashAlgorithm("sha256")

sbSignature = Chilkat::CkStringBuilder.new()
sbSignature.Append(crypt.macStringENC(sbSigStr.getAsString()))
sbSignature.ToLowercase()

sbUrl = Chilkat::CkStringBuilder.new()
sbUrl.Append("https://app.shippingeasy.com/api/stores/")
sbUrl.Append(storeApiKey)
sbUrl.Append("/orders?")
sbUrl.Append("api_key=")
sbUrl.Append(apiKey)
sbUrl.Append("&api_timestamp=")
sbUrl.Append(dt.getAsUnixTimeStr(false))
sbUrl.Append("&api_signature=")
sbUrl.Append(sbSignature.getAsString())

# Send a POST equivalent the following curl request:
# 	curl -H "Content-Type: application/json" --data @body.json "https://app.shippingeasy.com/api/stores/27aa472e16faa83dd13b7758d31974ed/orders?
# 	api_key=f9a7c8ebdfd34beaf260d9b0296c7059&
# 	api_timestamp=1401803554&
# 	api_signature=c65f43beed46e581939898a78acd10064cfa146845e97885ec02124d7ad648e4"

http = Chilkat::CkHttp.new()
http.put_SessionLogFilename("qa_output/shippingEasy.txt")
url = sbUrl.getAsString()
resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST",url,json,"application/json",resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

print "response status code = " + resp.get_StatusCode().to_s() + "\n";
print "response body:" + "\n";
print resp.bodyStr() + "\n";