(Swift 2) Shippo Create Shipment Object

Create a Shipment object to retrieve rates. It represents a request to ship a given package from the sender to the recipient address.

For more information, see https://goshippo.com/docs/shipping-labels/

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

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

    let http = CkoHttp()
    var success: Bool

    // Implements the following CURL command:

    // curl https://api.goshippo.com/shipments/  \
    //     -H "Authorization: ShippoToken <API_TOKEN>" \
    //     -H "Content-Type: application/json"  \
    //     -d '{
    //        "address_from":{
    //           "name":"Mr. Hippo",
    //           "street1":"215 Clayton St.",
    //           "city":"San Francisco",
    //           "state":"CA",
    //           "zip":"94117",
    //           "country":"US"
    //        },
    //        "address_to":{
    //           "name":"Mrs. Hippo",
    //           "street1":"965 Mission St.",
    //           "city":"San Francisco",
    //           "state":"CA",
    //           "zip":"94105",
    //           "country":"US"
    //        },
    //        "parcels":[{
    //           "length":"5",
    //           "width":"5",
    //           "height":"5",
    //           "distance_unit":"in",
    //           "weight":"2",
    //           "mass_unit":"lb"
    //        }],
    //        "async": false
    //     }'

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

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

    // {
    //   "address_from": {
    //     "name": "Mr. Hippo",
    //     "street1": "215 Clayton St.",
    //     "city": "San Francisco",
    //     "state": "CA",
    //     "zip": "94117",
    //     "country": "US"
    //   },
    //   "address_to": {
    //     "name": "Mrs. Hippo",
    //     "street1": "965 Mission St.",
    //     "city": "San Francisco",
    //     "state": "CA",
    //     "zip": "94105",
    //     "country": "US"
    //   },
    //   "parcels": [
    //     {
    //       "length": "5",
    //       "width": "5",
    //       "height": "5",
    //       "distance_unit": "in",
    //       "weight": "2",
    //       "mass_unit": "lb"
    //     }
    //   ],
    //   "async": false
    // }

    let json = CkoJsonObject()
    json.UpdateString("address_from.name", value: "Mr. Hippo")
    json.UpdateString("address_from.street1", value: "215 Clayton St.")
    json.UpdateString("address_from.city", value: "San Francisco")
    json.UpdateString("address_from.state", value: "CA")
    json.UpdateString("address_from.zip", value: "94117")
    json.UpdateString("address_from.country", value: "US")
    json.UpdateString("address_to.name", value: "Mrs. Hippo")
    json.UpdateString("address_to.street1", value: "965 Mission St.")
    json.UpdateString("address_to.city", value: "San Francisco")
    json.UpdateString("address_to.state", value: "CA")
    json.UpdateString("address_to.zip", value: "94105")
    json.UpdateString("address_to.country", value: "US")
    json.UpdateString("parcels[0].length", value: "5")
    json.UpdateString("parcels[0].width", value: "5")
    json.UpdateString("parcels[0].height", value: "5")
    json.UpdateString("parcels[0].distance_unit", value: "in")
    json.UpdateString("parcels[0].weight", value: "2")
    json.UpdateString("parcels[0].mass_unit", value: "lb")
    json.UpdateBool("async", value: false)

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

    var resp: CkoHttpResponse? = http.PostJson3("https://api.goshippo.com/shipments/", contentType: "application/json", json: json)
    if http.LastMethodSuccess == 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.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "carrier_accounts": [
    //   ],
    //   "object_created": "2019-06-28T17:45:20.441Z",
    //   "object_updated": "2019-06-28T17:45:20.511Z",
    //   "object_id": "17b01795a4884d8a9002ccc17c9d09d1",
    //   "object_owner": "admin@chilkatsoft.com",
    //   "status": "SUCCESS",
    //   "address_from": {
    //     "object_id": "427489906b604f498f7bd2429ab7d9a1",
    //     "is_complete": true,
    //     "name": "Mr. Hippo",
    //     "company": "",
    //     "street_no": "",
    //     "street1": "215 Clayton St.",
    //     "validation_results": {},
    //     "street2": "",
    //     "street3": "",
    //     "city": "San Francisco",
    //     "state": "CA",
    //     "zip": "94117",
    //     "country": "US",
    //     "phone": "",
    //     "email": "",
    //     "is_residential": null,
    //     "test": true
    //   },
    //   "address_to": {
    //     "object_id": "3d7166269a2844b7842ef9ace942ec7c",
    //     "is_complete": true,
    //     "name": "Mrs. Hippo",
    //     "company": "",
    //     "street_no": "",
    //     "street1": "965 Mission St.",
    //     "validation_results": {},
    //     "street2": "",
    //     "street3": "",
    //     "city": "San Francisco",
    //     "state": "CA",
    //     "zip": "94105",
    //     "country": "US",
    //     "phone": "",
    //     "email": "",
    //     "is_residential": null,
    //     "test": true
    //   },
    //   "parcels": [
    //     {
    //       "object_state": "VALID",
    //       "object_created": "2019-06-28T17:45:20.411Z",
    //       "object_updated": "2019-06-28T17:45:20.455Z",
    //       "object_id": "5af766ff15684a4186b0e3c833348fac",
    //       "object_owner": "admin@chilkatsoft.com",
    //       "template": null,
    //       "extra": {},
    //       "length": "5.0000",
    //       "width": "5.0000",
    //       "height": "5.0000",
    //       "distance_unit": "in",
    //       "weight": "2.0000",
    //       "mass_unit": "lb",
    //       "value_amount": null,
    //       "value_currency": null,
    //       "metadata": "",
    //       "line_items": [
    //       ],
    //       "test": true
    //     }
    //   ],
    //   "shipment_date": "2019-06-28T17:45:20.511Z",
    //   "address_return": {
    //     "object_id": "427489906b604f498f7bd2429ab7d9a1",
    //     "is_complete": true,
    //     "name": "Mr. Hippo",
    //     "company": "",
    //     "street_no": "",
    //     "street1": "215 Clayton St.",
    //     "validation_results": {},
    //     "street2": "",
    //     "street3": "",
    //     "city": "San Francisco",
    //     "state": "CA",
    //     "zip": "94117",
    //     "country": "US",
    //     "phone": "",
    //     "email": "",
    //     "is_residential": null,
    //     "test": true
    //   },
    //   "alternate_address_to": null,
    //   "customs_declaration": null,
    //   "extra": {},
    //   "rates": [
    //     {
    //       "object_created": "2019-06-28T17:45:20.789Z",
    //       "object_id": "dd7556c284e8444294d2ab7099e662d2",
    //       "object_owner": "admin@chilkatsoft.com",
    //       "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
    //       "attributes": [
    //         "FASTEST"
    //       ],
    //       "amount": "22.78",
    //       "currency": "USD",
    //       "amount_local": "22.78",
    //       "currency_local": "USD",
    //       "provider": "USPS",
    //       "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
    //       "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
    //       "servicelevel": {
    //         "name": "Priority Mail Express",
    //         "token": "usps_priority_express",
    //         "terms": ""
    //       },
    //       "estimated_days": 2,
    //       "arrives_by": null,
    //       "duration_terms": "Overnight delivery to most U.S. locations.",
    //       "messages": [
    //       ],
    //       "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
    //       "test": true,
    //       "zone": "1"
    //     },
    //     {
    //       "object_created": "2019-06-28T17:45:20.786Z",
    //       "object_id": "ec11cc297e2f4583986097f6d409e5c6",
    //       "object_owner": "admin@chilkatsoft.com",
    //       "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
    //       "attributes": [
    //         "BESTVALUE",
    //         "CHEAPEST",
    //         "FASTEST"
    //       ],
    //       "amount": "6.95",
    //       "currency": "USD",
    //       "amount_local": "6.95",
    //       "currency_local": "USD",
    //       "provider": "USPS",
    //       "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
    //       "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
    //       "servicelevel": {
    //         "name": "Priority Mail",
    //         "token": "usps_priority",
    //         "terms": ""
    //       },
    //       "estimated_days": 2,
    //       "arrives_by": null,
    //       "duration_terms": "Delivery within 1, 2, or 3 days based on where your package started and where it’s being sent.",
    //       "messages": [
    //       ],
    //       "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
    //       "test": true,
    //       "zone": "1"
    //     },
    //     {
    //       "object_created": "2019-06-28T17:45:20.785Z",
    //       "object_id": "d256586f539f4c93a2f02cc11f4942ac",
    //       "object_owner": "admin@chilkatsoft.com",
    //       "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
    //       "attributes": [
    //       ],
    //       "amount": "7.32",
    //       "currency": "USD",
    //       "amount_local": "7.32",
    //       "currency_local": "USD",
    //       "provider": "USPS",
    //       "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
    //       "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
    //       "servicelevel": {
    //         "name": "Parcel Select",
    //         "token": "usps_parcel_select",
    //         "terms": ""
    //       },
    //       "estimated_days": 7,
    //       "arrives_by": null,
    //       "duration_terms": "Delivery in 2 to 8 days.",
    //       "messages": [
    //       ],
    //       "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
    //       "test": true,
    //       "zone": "1"
    //     }
    //   ],
    //   "messages": [
    //     {
    //       "source": "DHLExpress",
    //       "code": "",
    //       "text": "Shippo's DHL Express master account doesn't support shipments to inside of the US"
    //     }
    //   ],
    //   "metadata": "",
    //   "test": true,
    //   "order": null
    // }

    // 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?
    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 j: Int
    var count_j: Int
    var shipment: String?
    var amount: String?
    var currency: String?
    var amount_local: String?
    var currency_local: String?
    var provider: String?
    var provider_image_75: String?
    var provider_image_200: String?
    var servicelevelName: String?
    var servicelevelToken: String?
    var servicelevelTerms: String?
    var estimated_days: Int
    var arrives_by: String?
    var duration_terms: String?
    var carrier_account: String?
    var zone: String?
    var strVal: String?
    var source: String?
    var code: String?
    var text: String?

    var object_created: String? = jResp.StringOf("object_created")
    var object_updated: String? = jResp.StringOf("object_updated")
    var object_id: String? = jResp.StringOf("object_id")
    var object_owner: String? = jResp.StringOf("object_owner")
    var status: String? = jResp.StringOf("status")
    var address_fromObject_id: String? = jResp.StringOf("address_from.object_id")
    var address_fromIs_complete: Bool = jResp.BoolOf("address_from.is_complete")
    var address_fromName: String? = jResp.StringOf("address_from.name")
    var address_fromCompany: String? = jResp.StringOf("address_from.company")
    var address_fromStreet_no: String? = jResp.StringOf("address_from.street_no")
    var address_fromStreet1: String? = jResp.StringOf("address_from.street1")
    var address_fromStreet2: String? = jResp.StringOf("address_from.street2")
    var address_fromStreet3: String? = jResp.StringOf("address_from.street3")
    var address_fromCity: String? = jResp.StringOf("address_from.city")
    var address_fromState: String? = jResp.StringOf("address_from.state")
    var address_fromZip: String? = jResp.StringOf("address_from.zip")
    var address_fromCountry: String? = jResp.StringOf("address_from.country")
    var address_fromPhone: String? = jResp.StringOf("address_from.phone")
    var address_fromEmail: String? = jResp.StringOf("address_from.email")
    var address_fromIs_residential: String? = jResp.StringOf("address_from.is_residential")
    var address_fromTest: Bool = jResp.BoolOf("address_from.test")
    var address_toObject_id: String? = jResp.StringOf("address_to.object_id")
    var address_toIs_complete: Bool = jResp.BoolOf("address_to.is_complete")
    var address_toName: String? = jResp.StringOf("address_to.name")
    var address_toCompany: String? = jResp.StringOf("address_to.company")
    var address_toStreet_no: String? = jResp.StringOf("address_to.street_no")
    var address_toStreet1: String? = jResp.StringOf("address_to.street1")
    var address_toStreet2: String? = jResp.StringOf("address_to.street2")
    var address_toStreet3: String? = jResp.StringOf("address_to.street3")
    var address_toCity: String? = jResp.StringOf("address_to.city")
    var address_toState: String? = jResp.StringOf("address_to.state")
    var address_toZip: String? = jResp.StringOf("address_to.zip")
    var address_toCountry: String? = jResp.StringOf("address_to.country")
    var address_toPhone: String? = jResp.StringOf("address_to.phone")
    var address_toEmail: String? = jResp.StringOf("address_to.email")
    var address_toIs_residential: String? = jResp.StringOf("address_to.is_residential")
    var address_toTest: Bool = jResp.BoolOf("address_to.test")
    var shipment_date: String? = jResp.StringOf("shipment_date")
    var address_returnObject_id: String? = jResp.StringOf("address_return.object_id")
    var address_returnIs_complete: Bool = jResp.BoolOf("address_return.is_complete")
    var address_returnName: String? = jResp.StringOf("address_return.name")
    var address_returnCompany: String? = jResp.StringOf("address_return.company")
    var address_returnStreet_no: String? = jResp.StringOf("address_return.street_no")
    var address_returnStreet1: String? = jResp.StringOf("address_return.street1")
    var address_returnStreet2: String? = jResp.StringOf("address_return.street2")
    var address_returnStreet3: String? = jResp.StringOf("address_return.street3")
    var address_returnCity: String? = jResp.StringOf("address_return.city")
    var address_returnState: String? = jResp.StringOf("address_return.state")
    var address_returnZip: String? = jResp.StringOf("address_return.zip")
    var address_returnCountry: String? = jResp.StringOf("address_return.country")
    var address_returnPhone: String? = jResp.StringOf("address_return.phone")
    var address_returnEmail: String? = jResp.StringOf("address_return.email")
    var address_returnIs_residential: String? = jResp.StringOf("address_return.is_residential")
    var address_returnTest: Bool = jResp.BoolOf("address_return.test")
    var alternate_address_to: String? = jResp.StringOf("alternate_address_to")
    var customs_declaration: String? = jResp.StringOf("customs_declaration")
    var metadata: String? = jResp.StringOf("metadata")
    var test: Bool = jResp.BoolOf("test")
    var order: String? = jResp.StringOf("order")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("carrier_accounts").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("parcels").intValue
    while i < count_i {
        jResp.I = i
        object_state = jResp.StringOf("parcels[i].object_state")
        object_created = jResp.StringOf("parcels[i].object_created")
        object_updated = jResp.StringOf("parcels[i].object_updated")
        object_id = jResp.StringOf("parcels[i].object_id")
        object_owner = jResp.StringOf("parcels[i].object_owner")
        template = jResp.StringOf("parcels[i].template")
        length = jResp.StringOf("parcels[i].length")
        width = jResp.StringOf("parcels[i].width")
        height = jResp.StringOf("parcels[i].height")
        distance_unit = jResp.StringOf("parcels[i].distance_unit")
        weight = jResp.StringOf("parcels[i].weight")
        mass_unit = jResp.StringOf("parcels[i].mass_unit")
        value_amount = jResp.StringOf("parcels[i].value_amount")
        value_currency = jResp.StringOf("parcels[i].value_currency")
        metadata = jResp.StringOf("parcels[i].metadata")
        test = jResp.BoolOf("parcels[i].test")
        j = 0
        count_j = jResp.SizeOfArray("parcels[i].line_items").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("rates").intValue
    while i < count_i {
        jResp.I = i
        object_created = jResp.StringOf("rates[i].object_created")
        object_id = jResp.StringOf("rates[i].object_id")
        object_owner = jResp.StringOf("rates[i].object_owner")
        shipment = jResp.StringOf("rates[i].shipment")
        amount = jResp.StringOf("rates[i].amount")
        currency = jResp.StringOf("rates[i].currency")
        amount_local = jResp.StringOf("rates[i].amount_local")
        currency_local = jResp.StringOf("rates[i].currency_local")
        provider = jResp.StringOf("rates[i].provider")
        provider_image_75 = jResp.StringOf("rates[i].provider_image_75")
        provider_image_200 = jResp.StringOf("rates[i].provider_image_200")
        servicelevelName = jResp.StringOf("rates[i].servicelevel.name")
        servicelevelToken = jResp.StringOf("rates[i].servicelevel.token")
        servicelevelTerms = jResp.StringOf("rates[i].servicelevel.terms")
        estimated_days = jResp.IntOf("rates[i].estimated_days").intValue
        arrives_by = jResp.StringOf("rates[i].arrives_by")
        duration_terms = jResp.StringOf("rates[i].duration_terms")
        carrier_account = jResp.StringOf("rates[i].carrier_account")
        test = jResp.BoolOf("rates[i].test")
        zone = jResp.StringOf("rates[i].zone")
        j = 0
        count_j = jResp.SizeOfArray("rates[i].attributes").intValue
        while j < count_j {
            jResp.J = j
            strVal = jResp.StringOf("rates[i].attributes[j]")
            j = j + 1
        }

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

        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("messages").intValue
    while i < count_i {
        jResp.I = i
        source = jResp.StringOf("messages[i].source")
        code = jResp.StringOf("messages[i].code")
        text = jResp.StringOf("messages[i].text")
        i = i + 1
    }


}