B4X
B4X
Shippo Label Purchase
See more Shippo Examples
Demonstrates how to create a shipping label in one API call through Shippo.Chilkat B4X Downloads
Dim success As Boolean = False
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As ChilkatHttp
http.Initialize("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"
' }
Dim json As ChilkatJsonObject
json.Initialize
json.UpdateString("shipment.address_from.name", "Mr. Hippo")
json.UpdateString("shipment.address_from.street1", "215 Clayton St.")
json.UpdateString("shipment.address_from.city", "San Francisco")
json.UpdateString("shipment.address_from.state", "CA")
json.UpdateString("shipment.address_from.zip", "94117")
json.UpdateString("shipment.address_from.country", "US")
json.UpdateString("shipment.address_from.phone", "+1 555 341 9393")
json.UpdateString("shipment.address_from.email", "support@goshippo.com")
json.UpdateString("shipment.address_to.name", "Mrs. Hippo")
json.UpdateString("shipment.address_to.street1", "965 Mission St.")
json.UpdateString("shipment.address_to.city", "San Francisco")
json.UpdateString("shipment.address_to.state", "CA")
json.UpdateString("shipment.address_to.zip", "94105")
json.UpdateString("shipment.address_to.country", "US")
json.UpdateString("shipment.address_to.phone", "+1 555 341 9393")
json.UpdateString("shipment.address_to.email", "support@goshippo.com")
json.UpdateString("shipment.parcels[0].length", "5")
json.UpdateString("shipment.parcels[0].width", "5")
json.UpdateString("shipment.parcels[0].height", "5")
json.UpdateString("shipment.parcels[0].distance_unit", "in")
json.UpdateString("shipment.parcels[0].weight", "2")
json.UpdateString("shipment.parcels[0].mass_unit", "lb")
json.UpdateString("carrier_account", "b741b99f95e841639b54272834bc478c")
json.UpdateString("servicelevel_token", "usps_priority")
http.SetRequestHeader("Authorization", "ShippoToken <API_Token>")
http.SetRequestHeader("Content-Type", "application/json")
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", "https://api.goshippo.com/transactions/", json, "application/json", resp)
If success = False Then
Log(http.LastErrorText)
Return
End If
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize
resp.GetBodySb(sbResponseBody)
Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Log("Response Body:")
Log(jResp.Emit)
Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
Log("Response Header:")
Log(resp.Header)
Log("Failed.")
Return
End If
' 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
Dim object_state As String = jResp.StringOf("object_state")
Dim status As String = jResp.StringOf("status")
Dim object_created As String = jResp.StringOf("object_created")
Dim object_updated As String = jResp.StringOf("object_updated")
Dim object_id As String = jResp.StringOf("object_id")
Dim object_owner As String = jResp.StringOf("object_owner")
Dim was_test As Boolean = jResp.BoolOf("was_test")
Dim rateObject_id As String = jResp.StringOf("rate.object_id")
Dim rateAmount As String = jResp.StringOf("rate.amount")
Dim rateCurrency As String = jResp.StringOf("rate.currency")
Dim rateAmount_local As String = jResp.StringOf("rate.amount_local")
Dim rateCurrency_local As String = jResp.StringOf("rate.currency_local")
Dim rateProvider As String = jResp.StringOf("rate.provider")
Dim rateServicelevel_name As String = jResp.StringOf("rate.servicelevel_name")
Dim rateServicelevel_token As String = jResp.StringOf("rate.servicelevel_token")
Dim rateCarrier_account As String = jResp.StringOf("rate.carrier_account")
Dim tracking_number As String = jResp.StringOf("tracking_number")
Dim tracking_statusObject_created As String = jResp.StringOf("tracking_status.object_created")
Dim tracking_statusObject_id As String = jResp.StringOf("tracking_status.object_id")
Dim tracking_statusStatus As String = jResp.StringOf("tracking_status.status")
Dim tracking_statusStatus_details As String = jResp.StringOf("tracking_status.status_details")
Dim tracking_statusStatus_date As String = jResp.StringOf("tracking_status.status_date")
Dim tracking_url_provider As String = jResp.StringOf("tracking_url_provider")
Dim eta As String = jResp.StringOf("eta")
Dim label_url As String = jResp.StringOf("label_url")
Dim commercial_invoice_url As String = jResp.StringOf("commercial_invoice_url")
Dim metadata As String = jResp.StringOf("metadata")
Dim i As Int = 0
Dim count_i As Int = jResp.SizeOfArray("messages")
Do While i < count_i
jResp.I = i
i = i + 1
Loop