Xbase++

Shippo Create Transaction Object

See more Shippo Examples

Creates a Transaction object that represents a shipping label purchase and is based on the shipping rate. Xbase++

LOCAL nSuccess
LOCAL oHttp
LOCAL oReq
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cObject_state
LOCAL cStatus
LOCAL cObject_created
LOCAL cObject_updated
LOCAL cObject_id
LOCAL cObject_owner
LOCAL nTest
LOCAL cRate
LOCAL cTracking_number
LOCAL cTracking_status
LOCAL cEta
LOCAL cTracking_url_provider
LOCAL cLabel_url
LOCAL cCommercial_invoice_url
LOCAL cOrder
LOCAL cMetadata
LOCAL cParcel
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/transactions \
//      -H "Authorization: ShippoToken <API_TOKEN>" \
//      -d rate="478fb066930e4e3195a3686f7ea5b612"
//      -d label_file_type="PDF"
//      -d async=false

oReq := CreateObject("Chilkat.HttpRequest")
oReq:HttpVerb := "POST"
oReq:Path := "/transactions"
oReq:ContentType := "application/x-www-form-urlencoded"
oReq:AddParam("rate", "478fb066930e4e3195a3686f7ea5b612")
oReq:AddParam("label_file_type", "PDF")
oReq:AddParam("async", "false")

oReq:AddHeader("Authorization", "ShippoToken <API_TOKEN>")

oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpReq("https://api.goshippo.com/transactions", oReq, oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oReq:destroy()
    oResp:destroy()
    RETURN
ENDIF

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

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

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

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

//  {
//    "object_state": "VALID",
//    "status": "SUCCESS",
//    "object_created": "2019-06-28T18:04:08.679Z",
//    "object_updated": "2019-06-28T18:04:10.516Z",
//    "object_id": "6178e155da304f10aa4b4271fdca84fb",
//    "object_owner": "admin@chilkatsoft.com",
//    "test": true,
//    "rate": "dd7556c284e8444294d2ab7099e662d2",
//    "tracking_number": "92701902416755000000000015",
//    "tracking_status": "UNKNOWN",
//    "eta": null,
//    "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92701902416755000000000015",
//    "label_url": "https://shippo-delivery-east.s3.amazonaws.com/6178e155da304f10aa4b4271fdca84fb.pdf?Signature=1LU0Qf11nQJGei%2FeLZr%2BQ5EwJS4%3D&Expires=1593281050&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
//    "commercial_invoice_url": null,
//    "messages": [
//    ],
//    "order": null,
//    "metadata": "",
//    "parcel": "5af766ff15684a4186b0e3c833348fac",
//    "billing": {
//      "payments": [
//      ]
//    }
//  }

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

cObject_state := oJResp:StringOf("object_state")
cStatus := oJResp:StringOf("status")
cObject_created := oJResp:StringOf("object_created")
cObject_updated := oJResp:StringOf("object_updated")
cObject_id := oJResp:StringOf("object_id")
cObject_owner := oJResp:StringOf("object_owner")
nTest := oJResp:BoolOf("test")
cRate := oJResp:StringOf("rate")
cTracking_number := oJResp:StringOf("tracking_number")
cTracking_status := oJResp:StringOf("tracking_status")
cEta := oJResp:StringOf("eta")
cTracking_url_provider := oJResp:StringOf("tracking_url_provider")
cLabel_url := oJResp:StringOf("label_url")
cCommercial_invoice_url := oJResp:StringOf("commercial_invoice_url")
cOrder := oJResp:StringOf("order")
cMetadata := oJResp:StringOf("metadata")
cParcel := oJResp:StringOf("parcel")
i := 0
nCount_i := oJResp:SizeOfArray("messages")
DO WHILE i < nCount_i
    oJResp:I := i
    i := i + 1
ENDDO
i := 0
nCount_i := oJResp:SizeOfArray("billing.payments")
DO WHILE i < nCount_i
    oJResp:I := i
    i := i + 1
ENDDO

oHttp:destroy()
oReq:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()