(Swift) Shippo Create the Shipment, Get Rates, and Purchase Label

Demonstrates how retrieve rates and create labels for international shipments.

Note: This example requires Chilkat v11.0.0 or greater.

For more information, see https://goshippo.com/docs/international/

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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/customs/declarations/ \
    //     -H "Authorization: ShippoToken <API_TOKEN>" \
    //     -H "Content-Type: application/json"  \
    //     -d '{          
    //           "contents_type": "MERCHANDISE",
    //           "non_delivery_option": "RETURN",
    //           "certify": true,
    //           "certify_signer": "Simon Kreuz",
    //           "incoterm": "DDU",
    //           "items": [{
    //                     "description": "T-shirt",
    //                     "quantity": 20,
    //                     "net_weight": "5",
    //                     "mass_unit": "lb",
    //                     "value_amount": "200",
    //                     "value_currency": "USD",
    //                     "tariff_number": "",
    //                     "origin_country": "US"
    //             }]
    //     }'

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

    // The following JSON is sent in the request body.

    // {
    //   "contents_type": "MERCHANDISE",
    //   "non_delivery_option": "RETURN",
    //   "certify": true,
    //   "certify_signer": "Simon Kreuz",
    //   "incoterm": "DDU",
    //   "items": [
    //     {
    //       "description": "T-shirt",
    //       "quantity": 20,
    //       "net_weight": "5",
    //       "mass_unit": "lb",
    //       "value_amount": "200",
    //       "value_currency": "USD",
    //       "tariff_number": "",
    //       "origin_country": "US"
    //     }
    //   ]
    // }

    let json = CkoJsonObject()!
    json.update("contents_type", value: "MERCHANDISE")
    json.update("non_delivery_option", value: "RETURN")
    json.updateBool("certify", value: true)
    json.update("certify_signer", value: "Simon Kreuz")
    json.update("incoterm", value: "DDU")
    json.update("items[0].description", value: "T-shirt")
    json.updateInt("items[0].quantity", value: 20)
    json.update("items[0].net_weight", value: "5")
    json.update("items[0].mass_unit", value: "lb")
    json.update("items[0].value_amount", value: "200")
    json.update("items[0].value_currency", value: "USD")
    json.update("items[0].tariff_number", value: "")
    json.update("items[0].origin_country", value: "US")

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

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

    let sbResponseBody = CkoStringBuilder()!
    resp.getBodySb(sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(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_created": "2014-07-17T00:04:06.163Z",
    //   "object_updated": "2014-07-17T00:04:06.163Z",
    //   "object_id": "89436997a794439ab47999701e60392e",
    //   "object_owner": "shippotle@goshippo.com",
    //   "status": "SUCCESS",
    //   "address_from": {
    //     "object_id": "0943ae4e373e4120a99c337e496dcce8",
    //     "validation_results": {},
    //     "is_complete": true,
    //     "company": "",
    //     "street_no": "",
    //     "name": "Mr. Hippo",
    //     "street1": "215 Clayton St.",
    //     "street2": "",
    //     "city": "San Francisco",
    //     "state": "CA",
    //     "zip": "94117",
    //     "country": "US",
    //     "phone": "+15553419393",
    //     "email": "support@goshippo.com",
    //     "is_residential": null
    //   },
    //   "address_to": {
    //     "object_id": "4c7185d353764d0985a6a7825aed8ffb",
    //     "validation_results": {},
    //     "is_complete": true,
    //     "name": "Mrs. Hippo",
    //     "street1": "200 University Ave W",
    //     "city": "Waterloo",
    //     "state": "ON",
    //     "zip": "N2L 3G1",
    //     "country": "CA",
    //     "phone": "+1 555 341 9393",
    //     "email": "support@goshippo.com",
    //     "is_residential": false
    //   },
    //   "address_return": null,
    //   "parcels": [
    //     {
    //       "object_id": "ec952343dd4843c39b42aca620471fd5",
    //       "object_created": "2013-12-01T06:24:21.121Z",
    //       "object_updated": "2013-12-01T06:24:21.121Z",
    //       "object_owner": "shippotle@goshippo.com",
    //       "template": null,
    //       "length": "5",
    //       "width": "5",
    //       "height": "5",
    //       "distance_unit": "in",
    //       "weight": "2",
    //       "mass_unit": "lb",
    //       "value_amount": null,
    //       "value_currency": null,
    //       "metadata": "",
    //       "line_items": [
    //       ],
    //       "test": true
    //     }
    //   ],
    //   "shipment_date": "2013-12-03T12:00:00Z",
    //   "extra": {
    //     "insurance": {
    //       "currency": "",
    //       "amount": ""
    //     },
    //     "reference_1": "",
    //     "reference_2": ""
    //   },
    //   "customs_declaration": "b741b99f95e841639b54272834bc478c",
    //   "rates": [
    //     {
    //       "object_created": "2014-07-17T00:04:06.263Z",
    //       "object_id": "545ab0a1a6ea4c9f9adb2512a57d6d8b",
    //       "object_owner": "shippotle@goshippo.com",
    //       "shipment": "89436997a794439ab47999701e60392e",
    //       "attributes": [
    //       ],
    //       "amount": "5.50",
    //       "currency": "USD",
    //       "amount_local": "5.50",
    //       "currency_local": "USD",
    //       "provider": "USPS",
    //       "provider_image_75": "https://cdn2.goshippo.com/providers/75/USPS.png",
    //       "provider_image_200": "https://cdn2.goshippo.com/providers/200/USPS.png",
    //       "servicelevel": {
    //         "name": "Priority Mail",
    //         "token": "usps_priority",
    //         "terms": ""
    //       },
    //       "days": 2,
    //       "arrives_by": null,
    //       "duration_terms": "Delivery in 1 to 3 business days.",
    //       "messages": [
    //       ],
    //       "carrier_account": "078870331023437cb917f5187429b093",
    //       "test": false,
    //       "zone": 1
    //     },
    //     ...
    //   ],
    //   "carrier_accounts": [
    //   ],
    //   "messages": [
    //   ],
    //   "metadata": "Customer ID 123456"
    // }

    // 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 template: String?
    var length: String?
    var width: String?
    var height: String?
    var distance_unit: String?
    var weight: String?
    var mass_unit: String?
    var value_amount: String?
    var value_currency: String?
    var test: Bool
    var j: Int
    var count_j: Int
    var intVal: Int

    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 status: String? = jResp.string(of: "status")
    var address_fromObject_id: String? = jResp.string(of: "address_from.object_id")
    var address_fromIs_complete: Bool = jResp.bool(of: "address_from.is_complete")
    var address_fromCompany: String? = jResp.string(of: "address_from.company")
    var address_fromStreet_no: String? = jResp.string(of: "address_from.street_no")
    var address_fromName: String? = jResp.string(of: "address_from.name")
    var address_fromStreet1: String? = jResp.string(of: "address_from.street1")
    var address_fromStreet2: String? = jResp.string(of: "address_from.street2")
    var address_fromCity: String? = jResp.string(of: "address_from.city")
    var address_fromState: String? = jResp.string(of: "address_from.state")
    var address_fromZip: String? = jResp.string(of: "address_from.zip")
    var address_fromCountry: String? = jResp.string(of: "address_from.country")
    var address_fromPhone: String? = jResp.string(of: "address_from.phone")
    var address_fromEmail: String? = jResp.string(of: "address_from.email")
    var address_fromIs_residential: String? = jResp.string(of: "address_from.is_residential")
    var address_toObject_id: String? = jResp.string(of: "address_to.object_id")
    var address_toIs_complete: Bool = jResp.bool(of: "address_to.is_complete")
    var address_toName: String? = jResp.string(of: "address_to.name")
    var address_toStreet1: String? = jResp.string(of: "address_to.street1")
    var address_toCity: String? = jResp.string(of: "address_to.city")
    var address_toState: String? = jResp.string(of: "address_to.state")
    var address_toZip: String? = jResp.string(of: "address_to.zip")
    var address_toCountry: String? = jResp.string(of: "address_to.country")
    var address_toPhone: String? = jResp.string(of: "address_to.phone")
    var address_toEmail: String? = jResp.string(of: "address_to.email")
    var address_toIs_residential: Bool = jResp.bool(of: "address_to.is_residential")
    var address_return: String? = jResp.string(of: "address_return")
    var shipment_date: String? = jResp.string(of: "shipment_date")
    var extraInsuranceCurrency: String? = jResp.string(of: "extra.insurance.currency")
    var extraInsuranceAmount: String? = jResp.string(of: "extra.insurance.amount")
    var extraReference_1: String? = jResp.string(of: "extra.reference_1")
    var extraReference_2: String? = jResp.string(of: "extra.reference_2")
    var customs_declaration: String? = jResp.string(of: "customs_declaration")
    var metadata: String? = jResp.string(of: "metadata")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "parcels").intValue
    while i < count_i {
        jResp.i = i
        object_id = jResp.string(of: "parcels[i].object_id")
        object_created = jResp.string(of: "parcels[i].object_created")
        object_updated = jResp.string(of: "parcels[i].object_updated")
        object_owner = jResp.string(of: "parcels[i].object_owner")
        template = jResp.string(of: "parcels[i].template")
        length = jResp.string(of: "parcels[i].length")
        width = jResp.string(of: "parcels[i].width")
        height = jResp.string(of: "parcels[i].height")
        distance_unit = jResp.string(of: "parcels[i].distance_unit")
        weight = jResp.string(of: "parcels[i].weight")
        mass_unit = jResp.string(of: "parcels[i].mass_unit")
        value_amount = jResp.string(of: "parcels[i].value_amount")
        value_currency = jResp.string(of: "parcels[i].value_currency")
        metadata = jResp.string(of: "parcels[i].metadata")
        test = jResp.bool(of: "parcels[i].test")
        j = 0
        count_j = jResp.size(ofArray: "parcels[i].line_items").intValue
        while j < count_j {
            jResp.j = j
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "rates").intValue
    while i < count_i {
        jResp.i = i
        intVal = jResp.int(of: "rates[i]").intValue
        j = 0
        count_j = jResp.size(ofArray: "rates[i].attributes").intValue
        while j < count_j {
            jResp.j = j
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "rates[i].messages").intValue
        while j < count_j {
            jResp.j = j
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "carrier_accounts").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "messages").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }


}