(Xojo Plugin) Shippo Create an Order

Demonstrates how to create an order with all the information about your order by sending a POST request to the orders endpoint.

For more information, see https://goshippo.com/docs/orders/

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http
Dim success As Boolean

// Implements the following CURL command:

// curl https://api.goshippo.com/orders/ \
//     -H "Authorization: ShippoToken <API_Token>" \
//     -H "Content-Type: application/json"  \
//     -d '{
//             "to_address": {
//                 "city": "San Francisco",
//                 "company": "Shippo",
//                 "country": "US",
//                 "email": "shippotle@goshippo.com",
//                 "name": "Mr Hippo",
//                 "phone": "15553419393",
//                 "state": "CA",
//                 "street1": "215 Clayton St.",
//                 "zip": "94117"
//             },
//             "line_items": [
//                 {
//                     "quantity": 1,
//                     "sku": "HM-123",
//                     "title": "Hippo Magazines",
//                     "total_price": "12.10",
//                     "currency": "USD",
//                     "weight": "0.40",
//                     "weight_unit": "lb"
//                 }
//             ],
//             "placed_at": "2016-09-23T01:28:12Z",
//             "order_number": "#1068",
//             "order_status": "PAID",
//             "shipping_cost": "12.83",
//             "shipping_cost_currency": "USD",
//             "shipping_method": "USPS First Class Package",
//             "subtotal_price": "12.10",
//             "total_price": "24.93",
//             "total_tax": "0.00",
//             "currency": "USD",
//             "weight": "0.40",
//             "weight_unit": "lb"
//         }'

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "to_address": {
//     "city": "San Francisco",
//     "company": "Shippo",
//     "country": "US",
//     "email": "shippotle@goshippo.com",
//     "name": "Mr Hippo",
//     "phone": "15553419393",
//     "state": "CA",
//     "street1": "215 Clayton St.",
//     "zip": "94117"
//   },
//   "line_items": [
//     {
//       "quantity": 1,
//       "sku": "HM-123",
//       "title": "Hippo Magazines",
//       "total_price": "12.10",
//       "currency": "USD",
//       "weight": "0.40",
//       "weight_unit": "lb"
//     }
//   ],
//   "placed_at": "2016-09-23T01:28:12Z",
//   "order_number": "#1068",
//   "order_status": "PAID",
//   "shipping_cost": "12.83",
//   "shipping_cost_currency": "USD",
//   "shipping_method": "USPS First Class Package",
//   "subtotal_price": "12.10",
//   "total_price": "24.93",
//   "total_tax": "0.00",
//   "currency": "USD",
//   "weight": "0.40",
//   "weight_unit": "lb"
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("to_address.city","San Francisco")
success = json.UpdateString("to_address.company","Shippo")
success = json.UpdateString("to_address.country","US")
success = json.UpdateString("to_address.email","shippotle@goshippo.com")
success = json.UpdateString("to_address.name","Mr Hippo")
success = json.UpdateString("to_address.phone","15553419393")
success = json.UpdateString("to_address.state","CA")
success = json.UpdateString("to_address.street1","215 Clayton St.")
success = json.UpdateString("to_address.zip","94117")
success = json.UpdateInt("line_items[0].quantity",1)
success = json.UpdateString("line_items[0].sku","HM-123")
success = json.UpdateString("line_items[0].title","Hippo Magazines")
success = json.UpdateString("line_items[0].total_price","12.10")
success = json.UpdateString("line_items[0].currency","USD")
success = json.UpdateString("line_items[0].weight","0.40")
success = json.UpdateString("line_items[0].weight_unit","lb")
success = json.UpdateString("placed_at","2016-09-23T01:28:12Z")
success = json.UpdateString("order_number","#1068")
success = json.UpdateString("order_status","PAID")
success = json.UpdateString("shipping_cost","12.83")
success = json.UpdateString("shipping_cost_currency","USD")
success = json.UpdateString("shipping_method","USPS First Class Package")
success = json.UpdateString("subtotal_price","12.10")
success = json.UpdateString("total_price","24.93")
success = json.UpdateString("total_tax","0.00")
success = json.UpdateString("currency","USD")
success = json.UpdateString("weight","0.40")
success = json.UpdateString("weight_unit","lb")

http.SetRequestHeader "Authorization","ShippoToken <API_Token>"
http.SetRequestHeader "Content-Type","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://api.goshippo.com/orders/","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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