(Excel) Shippo List All Orders

Demonstrates how to list all orders created by sending a GET request to the orders endpoint.

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

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/orders/ \
'     -H "Authorization: ShippoToken <API_Token>"

http.SetRequestHeader "Authorization","ShippoToken <API_Token>"

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = http.QuickGetSb("https://api.goshippo.com/orders/",sbResponseBody)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

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 = http.LastStatus
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "count": 1382,
'   "next": "https://api.goshippo.com/orders/?page=2",
'   "previous": null,
'   "results": [
'     {
'       "object_id": "4f2bc588e4e5446cb3f9fdb7cd5e190b",
'       "object_owner": "shippotle@goshippo.com",
'       "order_number": "#1068",
'       "order_status": "PAID",
'       "placed_at": "2016-09-23T01:28:12Z",
'       "to_address": {
'         "object_created": "2016-09-23T01:38:56Z",
'         "object_updated": "2016-09-23T01:38:56Z",
'         "object_id": "d799c2679e644279b59fe661ac8fa488",
'         "object_owner": "shippotle@goshippo.com",
'         "is_complete": true,
'         "validation_results": {},
'         "name": "Mr Hippo",
'         "company": "Shippo",
'         "street1": "215 Clayton St.",
'         "street2": "",
'         "city": "San Francisco",
'         "state": "CA",
'         "zip": "94117",
'         "country": "US",
'         "phone": "15553419393",
'         "email": "shippotle@goshippo.com",
'         "is_residential": null,
'         "metadata": ""
'       },
'       "from_address": null,
'       "line_items": [
'         {
'           "object_id": "abf7d5675d744b6ea9fdb6f796b28f28",
'           "title": "Hippo Magazines",
'           "variant_title": "",
'           "sku": "HM-123",
'           "quantity": 1,
'           "total_price": "12.10",
'           "currency": "USD",
'           "weight": "0.40",
'           "weight_unit": "lb",
'           "manufacture_country": null,
'           "max_ship_time": null,
'           "max_delivery_time": null,
'           "description": null
'         }
'       ],
'       "shipping_cost": "12.83",
'       "shipping_cost_currency": "USD",
'       "shipping_method": "USPS First Class Package",
'       "shop_app": "Shippo",
'       "subtotal_price": "12.10",
'       "total_price": "24.93",
'       "total_tax": "0.00",
'       "currency": "USD",
'       "transactions": [
'       ],
'       "weight": "0.40",
'       "weight_unit": "lb",
'       "notes": null
'     },
'     ...
'   ]
' }

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


count = jResp.IntOf("count")

next = jResp.StringOf("next")

previous = jResp.StringOf("previous")

i = 0

count_i = jResp.SizeOfArray("results")
Do While i < count_i
    jResp.I = i
    intVal = jResp.IntOf("results[i]")
    j = 0
    count_j = jResp.SizeOfArray("results[i].line_items")
    Do While j < count_j
        jResp.J = j
        object_id = jResp.StringOf("results[i].line_items[j].object_id")
        title = jResp.StringOf("results[i].line_items[j].title")
        variant_title = jResp.StringOf("results[i].line_items[j].variant_title")
        sku = jResp.StringOf("results[i].line_items[j].sku")
        quantity = jResp.IntOf("results[i].line_items[j].quantity")
        total_price = jResp.StringOf("results[i].line_items[j].total_price")
        currency = jResp.StringOf("results[i].line_items[j].currency")
        weight = jResp.StringOf("results[i].line_items[j].weight")
        weight_unit = jResp.StringOf("results[i].line_items[j].weight_unit")
        manufacture_country = jResp.StringOf("results[i].line_items[j].manufacture_country")
        max_ship_time = jResp.StringOf("results[i].line_items[j].max_ship_time")
        max_delivery_time = jResp.StringOf("results[i].line_items[j].max_delivery_time")
        description = jResp.StringOf("results[i].line_items[j].description")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("results[i].transactions")
    Do While j < count_j
        jResp.J = j
        j = j + 1
    Loop
    i = i + 1
Loop