Xojo Plugin
Xojo Plugin
Add order to a ShippingEasy account
See more HTTP Misc Examples
Adds an order to a ShippingEasy account (calls the ShippingEasy REST API).Chilkat Xojo Plugin Downloads
Dim success As Boolean
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.
Dim json As New Chilkat.JsonObject
success = json.UpdateString("order.external_order_identifier","ABC-100")
success = json.UpdateString("order.ordered_at","2014-01-16 14:37:56 -0600")
success = json.UpdateString("order.order_status","awaiting_shipment")
success = json.UpdateString("order.subtotal_including_tax","10.00")
success = json.UpdateString("order.total_including_tax","10.00")
success = json.UpdateString("order.total_excluding_tax","10.00")
success = json.UpdateString("order.discount_amount","0.00")
success = json.UpdateString("order.coupon_discount","1.00")
success = json.UpdateString("order.subtotal_including_tax","0.00")
success = json.UpdateString("order.subtotal_excluding_tax","0.00")
success = json.UpdateString("order.subtotal_excluding_tax","0.00")
success = json.UpdateString("order.subtotal_tax","0.00")
success = json.UpdateString("order.total_tax","0")
success = json.UpdateString("order.base_shipping_cost","0.00")
success = json.UpdateString("order.shipping_cost_including_tax","0.00")
success = json.UpdateString("order.shipping_cost_excluding_tax","0.00")
success = json.UpdateString("order.shipping_cost_tax","0.00")
success = json.UpdateString("order.base_handling_cost","0.00")
success = json.UpdateString("order.handling_cost_excluding_tax","0.00")
success = json.UpdateString("order.handling_cost_including_tax","0.00")
success = json.UpdateString("order.handling_cost_tax","0.00")
success = json.UpdateString("order.base_wrapping_cost","0.00")
success = json.UpdateString("order.wrapping_cost_excluding_tax","0.00")
success = json.UpdateString("order.wrapping_cost_including_tax","0.00")
success = json.UpdateString("order.wrapping_cost_tax","0.00")
success = json.UpdateString("order.notes","Please send promptly.")
success = json.UpdateString("order.billing_company","Acme Inc.")
success = json.UpdateString("order.billing_first_name","Fred")
success = json.UpdateString("order.billing_last_name","Jones")
success = json.UpdateString("order.billing_address","1234 Street")
success = json.UpdateString("order.billing_address2","Suite 100")
success = json.UpdateString("order.billing_city","Austin")
success = json.UpdateString("order.billing_state","TX")
success = json.UpdateString("order.billing_postal_code","78701")
success = json.UpdateString("order.billing_country","USA")
success = json.UpdateString("order.billing_phone_number","512-123-1234")
success = json.UpdateString("order.billing_email","test@test.com")
success = json.UpdateString("order.recipients[0].first_name","Colin")
success = json.UpdateString("order.recipients[0].last_name","Homenick")
success = json.UpdateString("order.recipients[0].company","Wintheiser-Hickle")
success = json.UpdateString("order.recipients[0].email","charles.crona@okeefe.org")
success = json.UpdateString("order.recipients[0].phone_number","637-481-6505")
success = json.UpdateString("order.recipients[0].residential","true")
success = json.UpdateString("order.recipients[0].address","21937 Adelbert Springs")
success = json.UpdateString("order.recipients[0].address2","")
success = json.UpdateString("order.recipients[0].province","")
success = json.UpdateString("order.recipients[0].state","CT")
success = json.UpdateString("order.recipients[0].city","Terryfurt")
success = json.UpdateString("order.recipients[0].postal_code","93322")
success = json.UpdateString("order.recipients[0].postal_code_plus_4","1234")
success = json.UpdateString("order.recipients[0].country","Andorra")
success = json.UpdateString("order.recipients[0].shipping_method","Ground")
success = json.UpdateString("order.recipients[0].base_cost","10.00")
success = json.UpdateString("order.recipients[0].cost_excluding_tax","10.00")
success = json.UpdateString("order.recipients[0].cost_tax","0.00")
success = json.UpdateString("order.recipients[0].base_handling_cost","0.00")
success = json.UpdateString("order.recipients[0].handling_cost_excluding_tax","0.00")
success = json.UpdateString("order.recipients[0].handling_cost_including_tax","0.00")
success = json.UpdateString("order.recipients[0].handling_cost_tax","0.00")
success = json.UpdateString("order.recipients[0].shipping_zone_id","123")
success = json.UpdateString("order.recipients[0].shipping_zone_name","XYZ")
success = json.UpdateString("order.recipients[0].items_total","1")
success = json.UpdateString("order.recipients[0].items_shipped","0")
success = json.UpdateString("order.recipients[0].line_items[0].item_name","Pencil Holder")
success = json.UpdateString("order.recipients[0].line_items[0].sku","9876543")
success = json.UpdateString("order.recipients[0].line_items[0].bin_picking_number","7")
success = json.UpdateString("order.recipients[0].line_items[0].unit_price","1.30")
success = json.UpdateString("order.recipients[0].line_items[0].total_excluding_tax","1.30")
success = json.UpdateString("order.recipients[0].line_items[0].weight_in_ounces","10")
success = json.UpdateString("order.recipients[0].line_items[0].product_options.pa_size","large")
success = json.UpdateString("order.recipients[0].line_items[0].product_options.Colour","Blue")
success = json.UpdateString("order.recipients[0].line_items[0].quantity","1")
// Replace these values with your actual apiKey and apiSecret.
// (These are not valid values..)
Dim storeApiKey As String
storeApiKey = "569dc30d267f2c4d1f85f9920b2bf9f4"
Dim apiKey As String
apiKey = "f9a7c8ebdfd34beaf260d9b0296c7059"
Dim apiSecret As String
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
Dim sbSigStr As New Chilkat.StringBuilder
success = sbSigStr.Append("POST&/api/stores/")
success = sbSigStr.Append(storeApiKey)
success = sbSigStr.Append("/orders&")
success = sbSigStr.Append("api_key=")
success = sbSigStr.Append(apiKey)
success = sbSigStr.Append("&api_timestamp=")
Dim dt As New Chilkat.CkDateTime
success = dt.SetFromCurrentSystemTime()
success = sbSigStr.Append(dt.GetAsUnixTimeStr(False))
success = sbSigStr.Append("&")
json.EmitCompact = True
success = json.EmitSb(sbSigStr)
// Calculate the HMAC-SHA256 of the API Signature String using the API Secret as the HMAC key.
Dim crypt As New Chilkat.Crypt2
crypt.MacAlgorithm = "hmac"
crypt.EncodingMode = "hex"
success = crypt.SetMacKeyString(apiSecret)
crypt.HashAlgorithm = "sha256"
Dim sbSignature As New Chilkat.StringBuilder
success = sbSignature.Append(crypt.MacStringENC(sbSigStr.GetAsString()))
success = sbSignature.ToLowercase()
Dim sbUrl As New Chilkat.StringBuilder
success = sbUrl.Append("https://app.shippingeasy.com/api/stores/")
success = sbUrl.Append(storeApiKey)
success = sbUrl.Append("/orders?")
success = sbUrl.Append("api_key=")
success = sbUrl.Append(apiKey)
success = sbUrl.Append("&api_timestamp=")
success = sbUrl.Append(dt.GetAsUnixTimeStr(False))
success = sbUrl.Append("&api_signature=")
success = 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"
Dim http As New Chilkat.Http
http.SessionLogFilename = "qa_output/shippingEasy.txt"
Dim url As String
url = sbUrl.GetAsString()
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("POST",url,json,"application/json",resp)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
System.DebugLog("response status code = " + Str(resp.StatusCode))
System.DebugLog("response body:")
System.DebugLog(resp.BodyStr)