(Xojo Plugin) Shippo Label Purchase

Demonstrates how to create a shipping label in one API call through Shippo.

For more information, see https://goshippo.com/docs/shipping-labels/

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/transactions/  \
//     -H "Authorization: ShippoToken <API_Token>" \
//     -H "Content-Type: application/json"  \
//     -d '{
//         "shipment": {
//             "address_from": {
//                 "name": "Mr. Hippo",
//                 "street1": "215 Clayton St.",
//                 "city": "San Francisco",
//                 "state": "CA",
//                 "zip": "94117",
//                 "country": "US",
//                 "phone": "+1 555 341 9393",
//                 "email": "support@goshippo.com"
//             },
//             "address_to": {
//                 "name": "Mrs. Hippo",
//                 "street1": "965 Mission St.",
//                 "city": "San Francisco",
//                 "state": "CA",
//                 "zip": "94105",
//                 "country": "US",
//                 "phone": "+1 555 341 9393",
//                 "email": "support@goshippo.com"
//             },
//             "parcels": [{
//                 "length": "5",
//                 "width": "5",
//                 "height": "5",
//                 "distance_unit": "in",
//                 "weight": "2",
//                 "mass_unit": "lb"
//             }]
//         },
//         "carrier_account": "b741b99f95e841639b54272834bc478c",
//         "servicelevel_token": "usps_priority"
//         }'

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

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

// {
//   "shipment": {
//     "address_from": {
//       "name": "Mr. Hippo",
//       "street1": "215 Clayton St.",
//       "city": "San Francisco",
//       "state": "CA",
//       "zip": "94117",
//       "country": "US",
//       "phone": "+1 555 341 9393",
//       "email": "support@goshippo.com"
//     },
//     "address_to": {
//       "name": "Mrs. Hippo",
//       "street1": "965 Mission St.",
//       "city": "San Francisco",
//       "state": "CA",
//       "zip": "94105",
//       "country": "US",
//       "phone": "+1 555 341 9393",
//       "email": "support@goshippo.com"
//     },
//     "parcels": [
//       {
//         "length": "5",
//         "width": "5",
//         "height": "5",
//         "distance_unit": "in",
//         "weight": "2",
//         "mass_unit": "lb"
//       }
//     ]
//   },
//   "carrier_account": "b741b99f95e841639b54272834bc478c",
//   "servicelevel_token": "usps_priority"
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("shipment.address_from.name","Mr. Hippo")
success = json.UpdateString("shipment.address_from.street1","215 Clayton St.")
success = json.UpdateString("shipment.address_from.city","San Francisco")
success = json.UpdateString("shipment.address_from.state","CA")
success = json.UpdateString("shipment.address_from.zip","94117")
success = json.UpdateString("shipment.address_from.country","US")
success = json.UpdateString("shipment.address_from.phone","+1 555 341 9393")
success = json.UpdateString("shipment.address_from.email","support@goshippo.com")
success = json.UpdateString("shipment.address_to.name","Mrs. Hippo")
success = json.UpdateString("shipment.address_to.street1","965 Mission St.")
success = json.UpdateString("shipment.address_to.city","San Francisco")
success = json.UpdateString("shipment.address_to.state","CA")
success = json.UpdateString("shipment.address_to.zip","94105")
success = json.UpdateString("shipment.address_to.country","US")
success = json.UpdateString("shipment.address_to.phone","+1 555 341 9393")
success = json.UpdateString("shipment.address_to.email","support@goshippo.com")
success = json.UpdateString("shipment.parcels[0].length","5")
success = json.UpdateString("shipment.parcels[0].width","5")
success = json.UpdateString("shipment.parcels[0].height","5")
success = json.UpdateString("shipment.parcels[0].distance_unit","in")
success = json.UpdateString("shipment.parcels[0].weight","2")
success = json.UpdateString("shipment.parcels[0].mass_unit","lb")
success = json.UpdateString("carrier_account","b741b99f95e841639b54272834bc478c")
success = json.UpdateString("servicelevel_token","usps_priority")

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

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://api.goshippo.com/transactions/","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)

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

Dim object_state As String
object_state = jResp.StringOf("object_state")
Dim status As String
status = jResp.StringOf("status")
Dim object_created As String
object_created = jResp.StringOf("object_created")
Dim object_updated As String
object_updated = jResp.StringOf("object_updated")
Dim object_id As String
object_id = jResp.StringOf("object_id")
Dim object_owner As String
object_owner = jResp.StringOf("object_owner")
Dim was_test As Boolean
was_test = jResp.BoolOf("was_test")
Dim rateObject_id As String
rateObject_id = jResp.StringOf("rate.object_id")
Dim rateAmount As String
rateAmount = jResp.StringOf("rate.amount")
Dim rateCurrency As String
rateCurrency = jResp.StringOf("rate.currency")
Dim rateAmount_local As String
rateAmount_local = jResp.StringOf("rate.amount_local")
Dim rateCurrency_local As String
rateCurrency_local = jResp.StringOf("rate.currency_local")
Dim rateProvider As String
rateProvider = jResp.StringOf("rate.provider")
Dim rateServicelevel_name As String
rateServicelevel_name = jResp.StringOf("rate.servicelevel_name")
Dim rateServicelevel_token As String
rateServicelevel_token = jResp.StringOf("rate.servicelevel_token")
Dim rateCarrier_account As String
rateCarrier_account = jResp.StringOf("rate.carrier_account")
Dim tracking_number As String
tracking_number = jResp.StringOf("tracking_number")
Dim tracking_statusObject_created As String
tracking_statusObject_created = jResp.StringOf("tracking_status.object_created")
Dim tracking_statusObject_id As String
tracking_statusObject_id = jResp.StringOf("tracking_status.object_id")
Dim tracking_statusStatus As String
tracking_statusStatus = jResp.StringOf("tracking_status.status")
Dim tracking_statusStatus_details As String
tracking_statusStatus_details = jResp.StringOf("tracking_status.status_details")
Dim tracking_statusStatus_date As String
tracking_statusStatus_date = jResp.StringOf("tracking_status.status_date")
Dim tracking_url_provider As String
tracking_url_provider = jResp.StringOf("tracking_url_provider")
Dim eta As String
eta = jResp.StringOf("eta")
Dim label_url As String
label_url = jResp.StringOf("label_url")
Dim commercial_invoice_url As String
commercial_invoice_url = jResp.StringOf("commercial_invoice_url")
Dim metadata As String
metadata = jResp.StringOf("metadata")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("messages")
While i < count_i
    jResp.I = i
    i = i + 1
Wend