(Excel) Shippo Adding Metadata

Demonstrates how to add metadata to the tracking request through a POST request.

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

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/tracks/ \
'     -H "Authorization: ShippoToken <API_TOKEN>" \
'     -d carrier="shippo" \
'     -d tracking_number="SHIPPO_TRANSIT" \
'     -d metadata="Order 000123"

Dim req As Chilkat.HttpRequest
Set req = Chilkat.NewHttpRequest
req.HttpVerb = "POST"
req.Path = "/tracks/"
req.ContentType = "application/x-www-form-urlencoded"
req.AddParam "carrier","shippo"
req.AddParam "tracking_number","SHIPPO_TRANSIT"
req.AddParam "metadata","Order 000123"

req.AddHeader "Authorization","ShippoToken <API_TOKEN>"


Set resp = http.PostUrlEncoded("https://api.goshippo.com/tracks/",req)
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)

' {
'   "messages": [
'   ],
'   "carrier": "shippo",
'   "tracking_number": "SHIPPO_TRANSIT",
'   "address_from": {
'     "city": "San Francisco",
'     "state": "CA",
'     "zip": "94103",
'     "country": "US"
'   },
'   "address_to": {
'     "city": "Chicago",
'     "state": "IL",
'     "zip": "60611",
'     "country": "US"
'   },
'   "eta": "2019-07-07T17:07:44.989Z",
'   "original_eta": "2019-07-07T17:07:44.989Z",
'   "servicelevel": {
'     "token": "shippo_priority",
'     "name": "Priority Mail"
'   },
'   "metadata": "Shippo test tracking",
'   "tracking_status": {
'     "object_created": "2019-07-04T17:07:45.003Z",
'     "object_updated": null,
'     "object_id": "ee35fb56f5d04021b36168abedc04573",
'     "status": "TRANSIT",
'     "status_details": "Your shipment has departed from the origin.",
'     "status_date": "2019-07-03T15:02:45.003Z",
'     "substatus": null,
'     "location": {
'       "city": "San Francisco",
'       "state": "CA",
'       "zip": "94103",
'       "country": "US"
'     }
'   },
'   "tracking_history": [
'     {
'       "object_created": "2019-07-04T17:07:45.005Z",
'       "object_updated": null,
'       "object_id": "2121a59f53ed42e0ae0436f636179156",
'       "status": "UNKNOWN",
'       "status_details": "The carrier has received the electronic shipment information.",
'       "status_date": "2019-07-02T12:57:45.005Z",
'       "substatus": null,
'       "location": {
'         "city": "San Francisco",
'         "state": "CA",
'         "zip": "94103",
'         "country": "US"
'       }
'     },
'     {
'       "object_created": "2019-07-04T17:07:45.005Z",
'       "object_updated": null,
'       "object_id": "06f949db1a8245beaa28df264b368a76",
'       "status": "TRANSIT",
'       "status_details": "Your shipment has departed from the origin.",
'       "status_date": "2019-07-03T15:02:45.005Z",
'       "substatus": null,
'       "location": {
'         "city": "San Francisco",
'         "state": "CA",
'         "zip": "94103",
'         "country": "US"
'       }
'     }
'   ],
'   "transaction": null,
'   "test": true
' }

' Sample code for parsing the JSON response...
' Use the following online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON


carrier = jResp.StringOf("carrier")

tracking_number = jResp.StringOf("tracking_number")

address_fromCity = jResp.StringOf("address_from.city")

address_fromState = jResp.StringOf("address_from.state")

address_fromZip = jResp.StringOf("address_from.zip")

address_fromCountry = jResp.StringOf("address_from.country")

address_toCity = jResp.StringOf("address_to.city")

address_toState = jResp.StringOf("address_to.state")

address_toZip = jResp.StringOf("address_to.zip")

address_toCountry = jResp.StringOf("address_to.country")

eta = jResp.StringOf("eta")

original_eta = jResp.StringOf("original_eta")

servicelevelToken = jResp.StringOf("servicelevel.token")

servicelevelName = jResp.StringOf("servicelevel.name")

metadata = jResp.StringOf("metadata")

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

tracking_statusObject_updated = jResp.StringOf("tracking_status.object_updated")

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_statusSubstatus = jResp.StringOf("tracking_status.substatus")

tracking_statusLocationCity = jResp.StringOf("tracking_status.location.city")

tracking_statusLocationState = jResp.StringOf("tracking_status.location.state")

tracking_statusLocationZip = jResp.StringOf("tracking_status.location.zip")

tracking_statusLocationCountry = jResp.StringOf("tracking_status.location.country")

transaction = jResp.StringOf("transaction")

test = jResp.BoolOf("test")

i = 0

count_i = jResp.SizeOfArray("messages")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("tracking_history")
Do While i < count_i
    jResp.I = i
    object_created = jResp.StringOf("tracking_history[i].object_created")
    object_updated = jResp.StringOf("tracking_history[i].object_updated")
    object_id = jResp.StringOf("tracking_history[i].object_id")
    status = jResp.StringOf("tracking_history[i].status")
    status_details = jResp.StringOf("tracking_history[i].status_details")
    status_date = jResp.StringOf("tracking_history[i].status_date")
    substatus = jResp.StringOf("tracking_history[i].substatus")
    locationCity = jResp.StringOf("tracking_history[i].location.city")
    locationState = jResp.StringOf("tracking_history[i].location.state")
    locationZip = jResp.StringOf("tracking_history[i].location.zip")
    locationCountry = jResp.StringOf("tracking_history[i].location.country")
    i = i + 1
Loop