(Excel) 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/

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' 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 Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
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"


Set resp = http.PostJson3("https://api.goshippo.com/transactions/","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

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

Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
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


object_state = jResp.StringOf("object_state")

status = jResp.StringOf("status")

object_created = jResp.StringOf("object_created")

object_updated = jResp.StringOf("object_updated")

object_id = jResp.StringOf("object_id")

object_owner = jResp.StringOf("object_owner")

was_test = jResp.BoolOf("was_test")

rateObject_id = jResp.StringOf("rate.object_id")

rateAmount = jResp.StringOf("rate.amount")

rateCurrency = jResp.StringOf("rate.currency")

rateAmount_local = jResp.StringOf("rate.amount_local")

rateCurrency_local = jResp.StringOf("rate.currency_local")

rateProvider = jResp.StringOf("rate.provider")

rateServicelevel_name = jResp.StringOf("rate.servicelevel_name")

rateServicelevel_token = jResp.StringOf("rate.servicelevel_token")

rateCarrier_account = jResp.StringOf("rate.carrier_account")

tracking_number = jResp.StringOf("tracking_number")

tracking_statusObject_created = jResp.StringOf("tracking_status.object_created")

tracking_statusObject_id = jResp.StringOf("tracking_status.object_id")

tracking_statusStatus = jResp.StringOf("tracking_status.status")

tracking_statusStatus_details = jResp.StringOf("tracking_status.status_details")

tracking_statusStatus_date = jResp.StringOf("tracking_status.status_date")

tracking_url_provider = jResp.StringOf("tracking_url_provider")

eta = jResp.StringOf("eta")

label_url = jResp.StringOf("label_url")

commercial_invoice_url = jResp.StringOf("commercial_invoice_url")

metadata = jResp.StringOf("metadata")

i = 0

count_i = jResp.SizeOfArray("messages")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop