Xbase++

Shippo List All Orders

See more Shippo Examples

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

LOCAL nSuccess
LOCAL oHttp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL nIntVal
LOCAL j
LOCAL nCount_j
LOCAL cObject_id
LOCAL cTitle
LOCAL cVariant_title
LOCAL cSku
LOCAL nQuantity
LOCAL cTotal_price
LOCAL cCurrency
LOCAL cWeight
LOCAL cWeight_unit
LOCAL cManufacture_country
LOCAL cMax_ship_time
LOCAL cMax_delivery_time
LOCAL cDescription
LOCAL nCount
LOCAL cNext
LOCAL cPrevious
LOCAL i
LOCAL nCount_i

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

//  Implements the following CURL command:

//  curl https://api.goshippo.com/orders/ \
//      -H "Authorization: ShippoToken <API_Token>"

oHttp:SetRequestHeader("Authorization", "ShippoToken <API_Token>")

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oHttp:QuickGetSb("https://api.goshippo.com/orders/", oSbResponseBody)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

nRespStatusCode := oHttp:LastStatus
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oHttp:LastHeader
    ? "Failed."
    oHttp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    RETURN
ENDIF

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

nCount := oJResp:IntOf("count")
cNext := oJResp:StringOf("next")
cPrevious := oJResp:StringOf("previous")
i := 0
nCount_i := oJResp:SizeOfArray("results")
DO WHILE i < nCount_i
    oJResp:I := i
    nIntVal := oJResp:IntOf("results[i]")
    j := 0
    nCount_j := oJResp:SizeOfArray("results[i].line_items")
    DO WHILE j < nCount_j
        oJResp:J := j
        cObject_id := oJResp:StringOf("results[i].line_items[j].object_id")
        cTitle := oJResp:StringOf("results[i].line_items[j].title")
        cVariant_title := oJResp:StringOf("results[i].line_items[j].variant_title")
        cSku := oJResp:StringOf("results[i].line_items[j].sku")
        nQuantity := oJResp:IntOf("results[i].line_items[j].quantity")
        cTotal_price := oJResp:StringOf("results[i].line_items[j].total_price")
        cCurrency := oJResp:StringOf("results[i].line_items[j].currency")
        cWeight := oJResp:StringOf("results[i].line_items[j].weight")
        cWeight_unit := oJResp:StringOf("results[i].line_items[j].weight_unit")
        cManufacture_country := oJResp:StringOf("results[i].line_items[j].manufacture_country")
        cMax_ship_time := oJResp:StringOf("results[i].line_items[j].max_ship_time")
        cMax_delivery_time := oJResp:StringOf("results[i].line_items[j].max_delivery_time")
        cDescription := oJResp:StringOf("results[i].line_items[j].description")
        j := j + 1
    ENDDO
    j := 0
    nCount_j := oJResp:SizeOfArray("results[i].transactions")
    DO WHILE j < nCount_j
        oJResp:J := j
        j := j + 1
    ENDDO
    i := i + 1
ENDDO

oHttp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()