Xbase++
Xbase++
Shippo Label Purchase
See more Shippo Examples
Demonstrates how to create a shipping label in one API call through Shippo.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL oJson
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cObject_state
LOCAL cStatus
LOCAL cObject_created
LOCAL cObject_updated
LOCAL cObject_id
LOCAL cObject_owner
LOCAL nWas_test
LOCAL cRateObject_id
LOCAL cRateAmount
LOCAL cRateCurrency
LOCAL cRateAmount_local
LOCAL cRateCurrency_local
LOCAL cRateProvider
LOCAL cRateServicelevel_name
LOCAL cRateServicelevel_token
LOCAL cRateCarrier_account
LOCAL cTracking_number
LOCAL cTracking_statusObject_created
LOCAL cTracking_statusObject_id
LOCAL cTracking_statusStatus
LOCAL cTracking_statusStatus_details
LOCAL cTracking_statusStatus_date
LOCAL cTracking_url_provider
LOCAL cEta
LOCAL cLabel_url
LOCAL cCommercial_invoice_url
LOCAL cMetadata
LOCAL i
LOCAL nCount_i
nSuccess := 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
oHttp := CreateObject("Chilkat.Http")
// 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"
// }
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("shipment.address_from.name", "Mr. Hippo")
oJson:UpdateString("shipment.address_from.street1", "215 Clayton St.")
oJson:UpdateString("shipment.address_from.city", "San Francisco")
oJson:UpdateString("shipment.address_from.state", "CA")
oJson:UpdateString("shipment.address_from.zip", "94117")
oJson:UpdateString("shipment.address_from.country", "US")
oJson:UpdateString("shipment.address_from.phone", "+1 555 341 9393")
oJson:UpdateString("shipment.address_from.email", "support@goshippo.com")
oJson:UpdateString("shipment.address_to.name", "Mrs. Hippo")
oJson:UpdateString("shipment.address_to.street1", "965 Mission St.")
oJson:UpdateString("shipment.address_to.city", "San Francisco")
oJson:UpdateString("shipment.address_to.state", "CA")
oJson:UpdateString("shipment.address_to.zip", "94105")
oJson:UpdateString("shipment.address_to.country", "US")
oJson:UpdateString("shipment.address_to.phone", "+1 555 341 9393")
oJson:UpdateString("shipment.address_to.email", "support@goshippo.com")
oJson:UpdateString("shipment.parcels[0].length", "5")
oJson:UpdateString("shipment.parcels[0].width", "5")
oJson:UpdateString("shipment.parcels[0].height", "5")
oJson:UpdateString("shipment.parcels[0].distance_unit", "in")
oJson:UpdateString("shipment.parcels[0].weight", "2")
oJson:UpdateString("shipment.parcels[0].mass_unit", "lb")
oJson:UpdateString("carrier_account", "b741b99f95e841639b54272834bc478c")
oJson:UpdateString("servicelevel_token", "usps_priority")
oHttp:SetRequestHeader("Authorization", "ShippoToken <API_Token>")
oHttp:SetRequestHeader("Content-Type", "application/json")
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpJson("POST", "https://api.goshippo.com/transactions/", oJson, "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oJson:destroy()
oResp:destroy()
RETURN
ENDIF
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0
? "Response Body:"
? oJResp:Emit()
nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
? "Response Header:"
? oResp:Header
? "Failed."
oHttp:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()
RETURN
ENDIF
// 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
cObject_state := oJResp:StringOf("object_state")
cStatus := oJResp:StringOf("status")
cObject_created := oJResp:StringOf("object_created")
cObject_updated := oJResp:StringOf("object_updated")
cObject_id := oJResp:StringOf("object_id")
cObject_owner := oJResp:StringOf("object_owner")
nWas_test := oJResp:BoolOf("was_test")
cRateObject_id := oJResp:StringOf("rate.object_id")
cRateAmount := oJResp:StringOf("rate.amount")
cRateCurrency := oJResp:StringOf("rate.currency")
cRateAmount_local := oJResp:StringOf("rate.amount_local")
cRateCurrency_local := oJResp:StringOf("rate.currency_local")
cRateProvider := oJResp:StringOf("rate.provider")
cRateServicelevel_name := oJResp:StringOf("rate.servicelevel_name")
cRateServicelevel_token := oJResp:StringOf("rate.servicelevel_token")
cRateCarrier_account := oJResp:StringOf("rate.carrier_account")
cTracking_number := oJResp:StringOf("tracking_number")
cTracking_statusObject_created := oJResp:StringOf("tracking_status.object_created")
cTracking_statusObject_id := oJResp:StringOf("tracking_status.object_id")
cTracking_statusStatus := oJResp:StringOf("tracking_status.status")
cTracking_statusStatus_details := oJResp:StringOf("tracking_status.status_details")
cTracking_statusStatus_date := oJResp:StringOf("tracking_status.status_date")
cTracking_url_provider := oJResp:StringOf("tracking_url_provider")
cEta := oJResp:StringOf("eta")
cLabel_url := oJResp:StringOf("label_url")
cCommercial_invoice_url := oJResp:StringOf("commercial_invoice_url")
cMetadata := oJResp:StringOf("metadata")
i := 0
nCount_i := oJResp:SizeOfArray("messages")
DO WHILE i < nCount_i
oJResp:I := i
i := i + 1
ENDDO
oHttp:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()