(Visual FoxPro) Shippo Create Transaction Object

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

For more information, see https://goshippo.com/docs/shipping-labels/

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lnSuccess
LOCAL loReq
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcObject_state
LOCAL lcStatus
LOCAL lcObject_created
LOCAL lcObject_updated
LOCAL lcObject_id
LOCAL lcObject_owner
LOCAL lnTest
LOCAL lcRate
LOCAL lcTracking_number
LOCAL lcTracking_status
LOCAL lcEta
LOCAL lcTracking_url_provider
LOCAL lcLabel_url
LOCAL lcCommercial_invoice_url
LOCAL lcOrder
LOCAL lcMetadata
LOCAL lcParcel
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = 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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.HttpRequest')
loReq = CreateObject('Chilkat.HttpRequest')
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 = loHttp.PostUrlEncoded("https://api.goshippo.com/transactions",loReq)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

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

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loReq
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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")
lnTest = 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 loSbResponseBody
RELEASE loJResp