Lianja

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. Lianja

llSuccess = .F.

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

loHttp = createobject("CkHttp")

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

loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
loReq.Path = "/transactions"
loReq.ContentType = "application/x-www-form-urlencoded"
loReq.AddParam("rate","478fb066930e4e3195a3686f7ea5b612")
loReq.AddParam("label_file_type","PDF")
loReq.AddParam("async","false")

loReq.AddHeader("Authorization","ShippoToken <API_TOKEN>")

loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpReq("https://api.goshippo.com/transactions",loReq,loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    release loResp
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loHttp
    release loReq
    release loResp
    release loSbResponseBody
    release loJResp
    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

lcObject_state = loJResp.StringOf("object_state")
lcStatus = loJResp.StringOf("status")
lcObject_created = loJResp.StringOf("object_created")
lcObject_updated = loJResp.StringOf("object_updated")
lcObject_id = loJResp.StringOf("object_id")
lcObject_owner = loJResp.StringOf("object_owner")
llTest = loJResp.BoolOf("test")
lcRate = loJResp.StringOf("rate")
lcTracking_number = loJResp.StringOf("tracking_number")
lcTracking_status = loJResp.StringOf("tracking_status")
lcEta = loJResp.StringOf("eta")
lcTracking_url_provider = loJResp.StringOf("tracking_url_provider")
lcLabel_url = loJResp.StringOf("label_url")
lcCommercial_invoice_url = loJResp.StringOf("commercial_invoice_url")
lcOrder = loJResp.StringOf("order")
lcMetadata = loJResp.StringOf("metadata")
lcParcel = loJResp.StringOf("parcel")
i = 0
lnCount_i = loJResp.SizeOfArray("messages")
do while i < lnCount_i
    loJResp.I = i
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("billing.payments")
do while i < lnCount_i
    loJResp.I = i
    i = i + 1
enddo


release loHttp
release loReq
release loResp
release loSbResponseBody
release loJResp