Sample code for 30+ languages & platforms
Swift

Shippo Label Purchase

See more Shippo Examples

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

Chilkat Swift Downloads

Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

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

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

    http.setRequestHeader(name: "Authorization", value: "ShippoToken <API_Token>")
    http.setRequestHeader(name: "Content-Type", value: "application/json")

    let resp = CkoHttpResponse()!
    success = http.httpJson(verb: "POST", url: "https://api.goshippo.com/transactions/", json: json, contentType: "application/json", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp.getBodySb(sb: sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sb: sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp.header!)")
        print("Failed.")
        return
    }

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

    var object_state: String? = jResp.string(of: "object_state")
    var status: String? = jResp.string(of: "status")
    var object_created: String? = jResp.string(of: "object_created")
    var object_updated: String? = jResp.string(of: "object_updated")
    var object_id: String? = jResp.string(of: "object_id")
    var object_owner: String? = jResp.string(of: "object_owner")
    var was_test: Bool = jResp.bool(of: "was_test")
    var rateObject_id: String? = jResp.string(of: "rate.object_id")
    var rateAmount: String? = jResp.string(of: "rate.amount")
    var rateCurrency: String? = jResp.string(of: "rate.currency")
    var rateAmount_local: String? = jResp.string(of: "rate.amount_local")
    var rateCurrency_local: String? = jResp.string(of: "rate.currency_local")
    var rateProvider: String? = jResp.string(of: "rate.provider")
    var rateServicelevel_name: String? = jResp.string(of: "rate.servicelevel_name")
    var rateServicelevel_token: String? = jResp.string(of: "rate.servicelevel_token")
    var rateCarrier_account: String? = jResp.string(of: "rate.carrier_account")
    var tracking_number: String? = jResp.string(of: "tracking_number")
    var tracking_statusObject_created: String? = jResp.string(of: "tracking_status.object_created")
    var tracking_statusObject_id: String? = jResp.string(of: "tracking_status.object_id")
    var tracking_statusStatus: String? = jResp.string(of: "tracking_status.status")
    var tracking_statusStatus_details: String? = jResp.string(of: "tracking_status.status_details")
    var tracking_statusStatus_date: String? = jResp.string(of: "tracking_status.status_date")
    var tracking_url_provider: String? = jResp.string(of: "tracking_url_provider")
    var eta: String? = jResp.string(of: "eta")
    var label_url: String? = jResp.string(of: "label_url")
    var commercial_invoice_url: String? = jResp.string(of: "commercial_invoice_url")
    var metadata: String? = jResp.string(of: "metadata")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "messages").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }


}