(PureBasic) Shippo Generate a Return Label

Demonstrates how to generate a pay-on-use return label.

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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

    success.i

    ; Implements the following CURL command:

    ; curl https://api.goshippo.com/shipments/ \
    ;     -H "Authorization: ShippoToken <API_Token>" \
    ;     -d address_from="d799c2679e644279b59fe661ac8fa488" \
    ;     -d address_to="42236bcf36214f62bcc6d7f12f02a849" \
    ;     -d parcels=["7df2ecf8b4224763ab7c71fae7ec8274"] \
    ;     -d shipment_date="2013-12-03T12:00:00.000Z" \
    ;     -d extra='{ "is_return": true}' \
    ;     -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, "/shipments/")
    CkHttpRequest::setCkContentType(req, "application/x-www-form-urlencoded")
    CkHttpRequest::ckAddParam(req,"address_from","d799c2679e644279b59fe661ac8fa488")
    CkHttpRequest::ckAddParam(req,"address_to","42236bcf36214f62bcc6d7f12f02a849")
    CkHttpRequest::ckAddParam(req,"parcels","[" + Chr(34) + "7df2ecf8b4224763ab7c71fae7ec8274" + Chr(34) + "]")
    CkHttpRequest::ckAddParam(req,"shipment_date","2013-12-03T12:00:00.000Z")
    CkHttpRequest::ckAddParam(req,"extra","'{ " + Chr(34) + "is_return" + Chr(34) + ": true}'")
    CkHttpRequest::ckAddParam(req,"async","false")

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

    resp.i = CkHttp::ckPostUrlEncoded(http,"https://api.goshippo.com/shipments/",req)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        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."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {}

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



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


    ProcedureReturn
EndProcedure