(PureBasic) Shippo Label Purchase

Demonstrates how to create a shipping label in one API call through Shippo.

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.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/transactions/  \
    ;     -H "Authorization: ShippoToken <API_Token>" \
    ;     -H "Content-Type: application/json"  \
    ;     -d '{
    ;         "shipment": {
    ;             "address_from": {
    ;                 "name": "Mr. Hippo",
    ;                 "street1": "215 Clayton St.",
    ;                 "city": "San Francisco",
    ;                 "state": "CA",
    ;                 "zip": "94117",
    ;                 "country": "US",
    ;                 "phone": "+1 555 341 9393",
    ;                 "email": "support@goshippo.com"
    ;             },
    ;             "address_to": {
    ;                 "name": "Mrs. Hippo",
    ;                 "street1": "965 Mission St.",
    ;                 "city": "San Francisco",
    ;                 "state": "CA",
    ;                 "zip": "94105",
    ;                 "country": "US",
    ;                 "phone": "+1 555 341 9393",
    ;                 "email": "support@goshippo.com"
    ;             },
    ;             "parcels": [{
    ;                 "length": "5",
    ;                 "width": "5",
    ;                 "height": "5",
    ;                 "distance_unit": "in",
    ;                 "weight": "2",
    ;                 "mass_unit": "lb"
    ;             }]
    ;         },
    ;         "carrier_account": "b741b99f95e841639b54272834bc478c",
    ;         "servicelevel_token": "usps_priority"
    ;         }'

    ; Use this online tool to generate code from sample JSON:
    ; Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "shipment": {
    ;     "address_from": {
    ;       "name": "Mr. Hippo",
    ;       "street1": "215 Clayton St.",
    ;       "city": "San Francisco",
    ;       "state": "CA",
    ;       "zip": "94117",
    ;       "country": "US",
    ;       "phone": "+1 555 341 9393",
    ;       "email": "support@goshippo.com"
    ;     },
    ;     "address_to": {
    ;       "name": "Mrs. Hippo",
    ;       "street1": "965 Mission St.",
    ;       "city": "San Francisco",
    ;       "state": "CA",
    ;       "zip": "94105",
    ;       "country": "US",
    ;       "phone": "+1 555 341 9393",
    ;       "email": "support@goshippo.com"
    ;     },
    ;     "parcels": [
    ;       {
    ;         "length": "5",
    ;         "width": "5",
    ;         "height": "5",
    ;         "distance_unit": "in",
    ;         "weight": "2",
    ;         "mass_unit": "lb"
    ;       }
    ;     ]
    ;   },
    ;   "carrier_account": "b741b99f95e841639b54272834bc478c",
    ;   "servicelevel_token": "usps_priority"
    ; }

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

    CkJsonObject::ckUpdateString(json,"shipment.address_from.name","Mr. Hippo")
    CkJsonObject::ckUpdateString(json,"shipment.address_from.street1","215 Clayton St.")
    CkJsonObject::ckUpdateString(json,"shipment.address_from.city","San Francisco")
    CkJsonObject::ckUpdateString(json,"shipment.address_from.state","CA")
    CkJsonObject::ckUpdateString(json,"shipment.address_from.zip","94117")
    CkJsonObject::ckUpdateString(json,"shipment.address_from.country","US")
    CkJsonObject::ckUpdateString(json,"shipment.address_from.phone","+1 555 341 9393")
    CkJsonObject::ckUpdateString(json,"shipment.address_from.email","support@goshippo.com")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.name","Mrs. Hippo")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.street1","965 Mission St.")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.city","San Francisco")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.state","CA")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.zip","94105")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.country","US")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.phone","+1 555 341 9393")
    CkJsonObject::ckUpdateString(json,"shipment.address_to.email","support@goshippo.com")
    CkJsonObject::ckUpdateString(json,"shipment.parcels[0].length","5")
    CkJsonObject::ckUpdateString(json,"shipment.parcels[0].width","5")
    CkJsonObject::ckUpdateString(json,"shipment.parcels[0].height","5")
    CkJsonObject::ckUpdateString(json,"shipment.parcels[0].distance_unit","in")
    CkJsonObject::ckUpdateString(json,"shipment.parcels[0].weight","2")
    CkJsonObject::ckUpdateString(json,"shipment.parcels[0].mass_unit","lb")
    CkJsonObject::ckUpdateString(json,"carrier_account","b741b99f95e841639b54272834bc478c")
    CkJsonObject::ckUpdateString(json,"servicelevel_token","usps_priority")

    CkHttp::ckSetRequestHeader(http,"Authorization","ShippoToken <API_Token>")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.goshippo.com/transactions/","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        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)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "object_state": "VALID",
    ;   "status": "SUCCESS",
    ;   "object_created": "2013-12-27T19:14:48.273Z",
    ;   "object_updated": "2013-12-27T19:14:48.273Z",
    ;   "object_id": "64bba01845ef40d29374032599f22588",
    ;   "object_owner": "shippotle@goshippo.com",
    ;   "was_test": false,
    ;   "rate": {
    ;     "object_id": "cf6fea899f1848b494d9568e8266e076",
    ;     "amount": "5.50",
    ;     "currency": "USD",
    ;     "amount_local": "5.50",
    ;     "currency_local": "USD",
    ;     "provider": "USPS",
    ;     "servicelevel_name": "Priority Mail",
    ;     "servicelevel_token": "usps_priority",
    ;     "carrier_account": "078870331023437cb917f5187429b093"
    ;   },
    ;   "tracking_number": "ZW70QJC",
    ;   "tracking_status": {
    ;     "object_created": "2013-12-27T23:17:41.411Z",
    ;     "object_id": "a21b3d6831c14ceaba6730179ce6e784",
    ;     "status": "UNKNOWN",
    ;     "status_details": "",
    ;     "status_date": "2013-12-28T12:04:04.214Z"
    ;   },
    ;   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=ZW70QJC",
    ;   "eta": "2013-12-30T12:00:00.000Z",
    ;   "label_url": "https://shippo-delivery.s3.amazonaws.com/96.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
    ;   "commercial_invoice_url": "",
    ;   "metadata": "",
    ;   "messages": [
    ;   ]
    ; }

    ; 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")
    was_test.i = CkJsonObject::ckBoolOf(jResp,"was_test")
    rateObject_id.s = CkJsonObject::ckStringOf(jResp,"rate.object_id")
    rateAmount.s = CkJsonObject::ckStringOf(jResp,"rate.amount")
    rateCurrency.s = CkJsonObject::ckStringOf(jResp,"rate.currency")
    rateAmount_local.s = CkJsonObject::ckStringOf(jResp,"rate.amount_local")
    rateCurrency_local.s = CkJsonObject::ckStringOf(jResp,"rate.currency_local")
    rateProvider.s = CkJsonObject::ckStringOf(jResp,"rate.provider")
    rateServicelevel_name.s = CkJsonObject::ckStringOf(jResp,"rate.servicelevel_name")
    rateServicelevel_token.s = CkJsonObject::ckStringOf(jResp,"rate.servicelevel_token")
    rateCarrier_account.s = CkJsonObject::ckStringOf(jResp,"rate.carrier_account")
    tracking_number.s = CkJsonObject::ckStringOf(jResp,"tracking_number")
    tracking_statusObject_created.s = CkJsonObject::ckStringOf(jResp,"tracking_status.object_created")
    tracking_statusObject_id.s = CkJsonObject::ckStringOf(jResp,"tracking_status.object_id")
    tracking_statusStatus.s = CkJsonObject::ckStringOf(jResp,"tracking_status.status")
    tracking_statusStatus_details.s = CkJsonObject::ckStringOf(jResp,"tracking_status.status_details")
    tracking_statusStatus_date.s = CkJsonObject::ckStringOf(jResp,"tracking_status.status_date")
    tracking_url_provider.s = CkJsonObject::ckStringOf(jResp,"tracking_url_provider")
    eta.s = CkJsonObject::ckStringOf(jResp,"eta")
    label_url.s = CkJsonObject::ckStringOf(jResp,"label_url")
    commercial_invoice_url.s = CkJsonObject::ckStringOf(jResp,"commercial_invoice_url")
    metadata.s = CkJsonObject::ckStringOf(jResp,"metadata")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"messages")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure