PureBasic

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

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/transactions")
    CkHttpRequest::setCkContentType(req, "application/x-www-form-urlencoded")
    CkHttpRequest::ckAddParam(req,"rate","478fb066930e4e3195a3686f7ea5b612")
    CkHttpRequest::ckAddParam(req,"label_file_type","PDF")
    CkHttpRequest::ckAddParam(req,"async","false")

    CkHttpRequest::ckAddHeader(req,"Authorization","ShippoToken <API_TOKEN>")

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpReq(http,"https://api.goshippo.com/transactions",req,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkHttpResponse::ckDispose(resp)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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

    object_state.s = CkJsonObject::ckStringOf(jResp,"object_state")
    status.s = CkJsonObject::ckStringOf(jResp,"status")
    object_created.s = CkJsonObject::ckStringOf(jResp,"object_created")
    object_updated.s = CkJsonObject::ckStringOf(jResp,"object_updated")
    object_id.s = CkJsonObject::ckStringOf(jResp,"object_id")
    object_owner.s = CkJsonObject::ckStringOf(jResp,"object_owner")
    test.i = CkJsonObject::ckBoolOf(jResp,"test")
    rate.s = CkJsonObject::ckStringOf(jResp,"rate")
    tracking_number.s = CkJsonObject::ckStringOf(jResp,"tracking_number")
    tracking_status.s = CkJsonObject::ckStringOf(jResp,"tracking_status")
    eta.s = CkJsonObject::ckStringOf(jResp,"eta")
    tracking_url_provider.s = CkJsonObject::ckStringOf(jResp,"tracking_url_provider")
    label_url.s = CkJsonObject::ckStringOf(jResp,"label_url")
    commercial_invoice_url.s = CkJsonObject::ckStringOf(jResp,"commercial_invoice_url")
    order.s = CkJsonObject::ckStringOf(jResp,"order")
    metadata.s = CkJsonObject::ckStringOf(jResp,"metadata")
    parcel.s = CkJsonObject::ckStringOf(jResp,"parcel")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"messages")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"billing.payments")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkHttpResponse::ckDispose(resp)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure