Sample code for 30+ languages & platforms
DataFlex

Shippo Label Purchase

See more Shippo Examples

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

Chilkat DataFlex Downloads

DataFlex
Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoHttp
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sObject_state
    String sStatus
    String sObject_created
    String sObject_updated
    String sObject_id
    String sObject_owner
    Boolean iWas_test
    String sRateObject_id
    String sRateAmount
    String sRateCurrency
    String sRateAmount_local
    String sRateCurrency_local
    String sRateProvider
    String sRateServicelevel_name
    String sRateServicelevel_token
    String sRateCarrier_account
    String sTracking_number
    String sTracking_statusObject_created
    String sTracking_statusObject_id
    String sTracking_statusStatus
    String sTracking_statusStatus_details
    String sTracking_statusStatus_date
    String sTracking_url_provider
    String sEta
    String sLabel_url
    String sCommercial_invoice_url
    String sMetadata
    Integer i
    Integer iCount_i
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "shipment.address_from.name" "Mr. Hippo" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_from.street1" "215 Clayton St." To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_from.city" "San Francisco" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_from.state" "CA" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_from.zip" "94117" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_from.country" "US" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_from.phone" "+1 555 341 9393" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_from.email" "support@goshippo.com" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.name" "Mrs. Hippo" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.street1" "965 Mission St." To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.city" "San Francisco" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.state" "CA" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.zip" "94105" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.country" "US" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.phone" "+1 555 341 9393" To iSuccess
    Get ComUpdateString Of hoJson "shipment.address_to.email" "support@goshippo.com" To iSuccess
    Get ComUpdateString Of hoJson "shipment.parcels[0].length" "5" To iSuccess
    Get ComUpdateString Of hoJson "shipment.parcels[0].width" "5" To iSuccess
    Get ComUpdateString Of hoJson "shipment.parcels[0].height" "5" To iSuccess
    Get ComUpdateString Of hoJson "shipment.parcels[0].distance_unit" "in" To iSuccess
    Get ComUpdateString Of hoJson "shipment.parcels[0].weight" "2" To iSuccess
    Get ComUpdateString Of hoJson "shipment.parcels[0].mass_unit" "lb" To iSuccess
    Get ComUpdateString Of hoJson "carrier_account" "b741b99f95e841639b54272834bc478c" To iSuccess
    Get ComUpdateString Of hoJson "servicelevel_token" "usps_priority" To iSuccess

    Send ComSetRequestHeader To hoHttp "Authorization" "ShippoToken <API_Token>"
    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "POST" "https://api.goshippo.com/transactions/" vJson "application/json" vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

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

    Get ComStringOf Of hoJResp "object_state" To sObject_state
    Get ComStringOf Of hoJResp "status" To sStatus
    Get ComStringOf Of hoJResp "object_created" To sObject_created
    Get ComStringOf Of hoJResp "object_updated" To sObject_updated
    Get ComStringOf Of hoJResp "object_id" To sObject_id
    Get ComStringOf Of hoJResp "object_owner" To sObject_owner
    Get ComBoolOf Of hoJResp "was_test" To iWas_test
    Get ComStringOf Of hoJResp "rate.object_id" To sRateObject_id
    Get ComStringOf Of hoJResp "rate.amount" To sRateAmount
    Get ComStringOf Of hoJResp "rate.currency" To sRateCurrency
    Get ComStringOf Of hoJResp "rate.amount_local" To sRateAmount_local
    Get ComStringOf Of hoJResp "rate.currency_local" To sRateCurrency_local
    Get ComStringOf Of hoJResp "rate.provider" To sRateProvider
    Get ComStringOf Of hoJResp "rate.servicelevel_name" To sRateServicelevel_name
    Get ComStringOf Of hoJResp "rate.servicelevel_token" To sRateServicelevel_token
    Get ComStringOf Of hoJResp "rate.carrier_account" To sRateCarrier_account
    Get ComStringOf Of hoJResp "tracking_number" To sTracking_number
    Get ComStringOf Of hoJResp "tracking_status.object_created" To sTracking_statusObject_created
    Get ComStringOf Of hoJResp "tracking_status.object_id" To sTracking_statusObject_id
    Get ComStringOf Of hoJResp "tracking_status.status" To sTracking_statusStatus
    Get ComStringOf Of hoJResp "tracking_status.status_details" To sTracking_statusStatus_details
    Get ComStringOf Of hoJResp "tracking_status.status_date" To sTracking_statusStatus_date
    Get ComStringOf Of hoJResp "tracking_url_provider" To sTracking_url_provider
    Get ComStringOf Of hoJResp "eta" To sEta
    Get ComStringOf Of hoJResp "label_url" To sLabel_url
    Get ComStringOf Of hoJResp "commercial_invoice_url" To sCommercial_invoice_url
    Get ComStringOf Of hoJResp "metadata" To sMetadata
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "messages" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Move (i + 1) To i
    Loop



End_Procedure