Chilkat Online Tools

Swift3 / ShipEngine Walkthrough / Parse shipment information

Back to Collection Items

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

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

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

    // {
    //   "text": "I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please."
    // }

    let json = CkoJsonObject()!
    json.update("text", value: "I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please.")

    http.setRequestHeader("API-Key", value: "{{API_KEY}}")
    http.setRequestHeader("Content-Type", value: "application/json")

    var resp: CkoHttpResponse? = http.postJson3("https://api.shipengine.com/v1/shipments/recognize", 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)

    // {
    //   "score": 0.9604458751176728,
    //   "shipment": {
    //     "confirmation": "adult_signature",
    //     "ship_to": {
    //       "name": "Amanda Miller",
    //       "company_name": "Adult Signature",
    //       "address_line1": "525 Winchester Blvd",
    //       "city_locality": "San Jose",
    //       "state_province": "CA",
    //       "postal_code": "95128",
    //       "address_residential_indicator": "yes"
    //     },
    //     "packages": [
    //       {
    //         "weight": {
    //           "value": 17,
    //           "unit": "pound"
    //         },
    //         "dimensions": {
    //           "length": 36,
    //           "width": 12,
    //           "height": 24,
    //           "unit": "inch"
    //         },
    //         "insured_value": {
    //           "amount": 400,
    //           "currency": "USD"
    //         }
    //       }
    //     ]
    //   },
    //   "entities": [
    //     {
    //       "type": "weight",
    //       "score": 0.9805313966503588,
    //       "text": "17lb",
    //       "start_index": 17,
    //       "end_index": 20,
    //       "result": {
    //         "value": 17,
    //         "unit": "pound"
    //       }
    //     },
    //     {
    //       "type": "dimensions",
    //       "score": 1,
    //       "text": "36x12x24in",
    //       "start_index": 37,
    //       "end_index": 46,
    //       "result": {
    //         "length": 36,
    //         "width": 12,
    //         "height": 24,
    //         "unit": "inch"
    //       }
    //     },
    //     {
    //       "type": "dimension",
    //       "score": 0.9805313966503588,
    //       "text": "24in",
    //       "start_index": 43,
    //       "end_index": 46,
    //       "result": {
    //         "unit": "inch",
    //         "value": 24
    //       }
    //     },
    //     {
    //       "type": "address",
    //       "score": 0.9686815805970408,
    //       "text": "to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature",
    //       "start_index": 60,
    //       "end_index": 228,
    //       "result": {
    //         "direction": "to",
    //         "name": "Amanda Miller",
    //         "company_name": "Adult Signature",
    //         "address_line1": "525 Winchester Blvd",
    //         "city_locality": "San Jose",
    //         "state_province": "CA",
    //         "postal_code": "95128",
    //         "address_residential_indicator": "yes"
    //       }
    //     },
    //     {
    //       "type": "person",
    //       "score": 0.9519646137063122,
    //       "text": "Amanda Miller",
    //       "start_index": 63,
    //       "end_index": 75,
    //       "result": {
    //         "value": "Amanda Miller"
    //       }
    //     },
    //     {
    //       "type": "residential_indicator",
    //       "score": 0.9519646137063122,
    //       "text": "house",
    //       "start_index": 79,
    //       "end_index": 83,
    //       "result": {
    //         "value": "yes"
    //       }
    //     },
    //     {
    //       "type": "address_line",
    //       "score": 0.9805313966503588,
    //       "text": "525 Winchester Blvd",
    //       "start_index": 88,
    //       "end_index": 106,
    //       "result": {
    //         "line": 1,
    //         "value": "525 Winchester Blvd"
    //       }
    //     },
    //     {
    //       "type": "number",
    //       "score": 0.9805313966503588,
    //       "text": "525",
    //       "start_index": 88,
    //       "end_index": 90,
    //       "result": {
    //         "type": "cardinal",
    //         "value": 525
    //       }
    //     },
    //     {
    //       "type": "city_locality",
    //       "score": 0.9805313966503588,
    //       "text": "San Jose",
    //       "start_index": 111,
    //       "end_index": 118,
    //       "result": {
    //         "value": "San Jose"
    //       }
    //     },
    //     {
    //       "type": "state_province",
    //       "score": 0.9805313966503588,
    //       "text": "California",
    //       "start_index": 120,
    //       "end_index": 129,
    //       "result": {
    //         "name": "California",
    //         "value": "CA"
    //       }
    //     },
    //     {
    //       "type": "postal_code",
    //       "score": 0.9519646137063122,
    //       "text": "95128",
    //       "start_index": 148,
    //       "end_index": 152,
    //       "result": {
    //         "value": "95128"
    //       }
    //     },
    //     {
    //       "type": "insurance",
    //       "score": 0.8530163983409642,
    //       "text": "insure it for $400",
    //       "start_index": 180,
    //       "end_index": 197,
    //       "result": {
    //         "value": 400,
    //         "unit": "USD"
    //       }
    //     },
    //     {
    //       "type": "insured_value",
    //       "score": 1,
    //       "text": "$400",
    //       "start_index": 194,
    //       "end_index": 197,
    //       "result": {
    //         "unit": "USD",
    //         "value": 400
    //       }
    //     },
    //     {
    //       "type": "company",
    //       "score": 0.9519646137063122,
    //       "text": "adult signature",
    //       "start_index": 214,
    //       "end_index": 228,
    //       "result": {
    //         "value": "Adult Signature"
    //       }
    //     },
    //     {
    //       "type": "delivery_confirmation",
    //       "score": 0.8530163983409642,
    //       "text": "adult signature",
    //       "start_index": 214,
    //       "end_index": 228,
    //       "result": {
    //         "name": "Adult Signature",
    //         "value": "adult_signature"
    //       }
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Value: Int
    var Unit: String?
    var Length: Int
    var Width: Int
    var Height: Int
    var dimensionsUnit: String?
    var Amount: Int
    var v_Currency: String?
    var v_type: String?
    var text: String?
    var start_index: Int
    var end_index: Int
    var resultValue: Int
    var resultUnit: String?
    var resultLength: Int
    var resultWidth: Int
    var resultHeight: Int
    var Direction: String?
    var resultName: String?
    var resultCompany_name: String?
    var resultAddress_line1: String?
    var resultCity_locality: String?
    var resultState_province: String?
    var resultPostal_code: String?
    var resultAddress_residential_indicator: String?
    var Line: Int
    var v_Type: String?

    var score: String? = jResp.string(of: "score")
    var Confirmation: String? = jResp.string(of: "shipment.confirmation")
    var Name: String? = jResp.string(of: "shipment.ship_to.name")
    var Company_name: String? = jResp.string(of: "shipment.ship_to.company_name")
    var Address_line1: String? = jResp.string(of: "shipment.ship_to.address_line1")
    var City_locality: String? = jResp.string(of: "shipment.ship_to.city_locality")
    var State_province: String? = jResp.string(of: "shipment.ship_to.state_province")
    var Postal_code: String? = jResp.string(of: "shipment.ship_to.postal_code")
    var Address_residential_indicator: String? = jResp.string(of: "shipment.ship_to.address_residential_indicator")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "shipment.packages").intValue
    while i < count_i {
        jResp.i = i
        Value = jResp.int(of: "shipment.packages[i].weight.value").intValue
        Unit = jResp.string(of: "shipment.packages[i].weight.unit")
        Length = jResp.int(of: "shipment.packages[i].dimensions.length").intValue
        Width = jResp.int(of: "shipment.packages[i].dimensions.width").intValue
        Height = jResp.int(of: "shipment.packages[i].dimensions.height").intValue
        dimensionsUnit = jResp.string(of: "shipment.packages[i].dimensions.unit")
        Amount = jResp.int(of: "shipment.packages[i].insured_value.amount").intValue
        v_Currency = jResp.string(of: "shipment.packages[i].insured_value.currency")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "entities").intValue
    while i < count_i {
        jResp.i = i
        v_type = jResp.string(of: "entities[i].type")
        score = jResp.string(of: "entities[i].score")
        text = jResp.string(of: "entities[i].text")
        start_index = jResp.int(of: "entities[i].start_index").intValue
        end_index = jResp.int(of: "entities[i].end_index").intValue
        resultValue = jResp.int(of: "entities[i].result.value").intValue
        resultUnit = jResp.string(of: "entities[i].result.unit")
        resultLength = jResp.int(of: "entities[i].result.length").intValue
        resultWidth = jResp.int(of: "entities[i].result.width").intValue
        resultHeight = jResp.int(of: "entities[i].result.height").intValue
        Direction = jResp.string(of: "entities[i].result.direction")
        resultName = jResp.string(of: "entities[i].result.name")
        resultCompany_name = jResp.string(of: "entities[i].result.company_name")
        resultAddress_line1 = jResp.string(of: "entities[i].result.address_line1")
        resultCity_locality = jResp.string(of: "entities[i].result.city_locality")
        resultState_province = jResp.string(of: "entities[i].result.state_province")
        resultPostal_code = jResp.string(of: "entities[i].result.postal_code")
        resultAddress_residential_indicator = jResp.string(of: "entities[i].result.address_residential_indicator")
        Line = jResp.int(of: "entities[i].result.line").intValue
        v_Type = jResp.string(of: "entities[i].result.type")
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '{
	"text": "I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It\'s really valuable, so insure it for $400 and require an adult signature please."
}'
https://api.shipengine.com/v1/shipments/recognize

Postman Collection Item JSON

{
  "name": "Parse shipment information",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"text\": \"I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please.\"\n}"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/shipments/recognize",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "shipments",
        "recognize"
      ]
    },
    "description": "ShipEngine can parse more than just addresses. If you think the text may contain other shipment information, like package weight, dimensions, insurance, or carrier preferences, then use our Parse Shipment API instead of our Parse Address API."
  },
  "response": [
    {
      "name": "Parse shipment information",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"text\": \"I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please.\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.shipengine.com/v1/shipments/recognize",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "shipments",
            "recognize"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 18 Sep 2019 16:50:59 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "content-encoding",
          "value": "gzip"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"score\": 0.9604458751176728,\n    \"shipment\": {\n        \"confirmation\": \"adult_signature\",\n        \"ship_to\": {\n            \"name\": \"Amanda Miller\",\n            \"company_name\": \"Adult Signature\",\n            \"address_line1\": \"525 Winchester Blvd\",\n            \"city_locality\": \"San Jose\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"95128\",\n            \"address_residential_indicator\": \"yes\"\n        },\n        \"packages\": [\n            {\n                \"weight\": {\n                    \"value\": 17,\n                    \"unit\": \"pound\"\n                },\n                \"dimensions\": {\n                    \"length\": 36,\n                    \"width\": 12,\n                    \"height\": 24,\n                    \"unit\": \"inch\"\n                },\n                \"insured_value\": {\n                    \"amount\": 400,\n                    \"currency\": \"USD\"\n                }\n            }\n        ]\n    },\n    \"entities\": [\n        {\n            \"type\": \"weight\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"17lb\",\n            \"start_index\": 17,\n            \"end_index\": 20,\n            \"result\": {\n                \"value\": 17,\n                \"unit\": \"pound\"\n            }\n        },\n        {\n            \"type\": \"dimensions\",\n            \"score\": 1,\n            \"text\": \"36x12x24in\",\n            \"start_index\": 37,\n            \"end_index\": 46,\n            \"result\": {\n                \"length\": 36,\n                \"width\": 12,\n                \"height\": 24,\n                \"unit\": \"inch\"\n            }\n        },\n        {\n            \"type\": \"dimension\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"24in\",\n            \"start_index\": 43,\n            \"end_index\": 46,\n            \"result\": {\n                \"unit\": \"inch\",\n                \"value\": 24\n            }\n        },\n        {\n            \"type\": \"address\",\n            \"score\": 0.9686815805970408,\n            \"text\": \"to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature\",\n            \"start_index\": 60,\n            \"end_index\": 228,\n            \"result\": {\n                \"direction\": \"to\",\n                \"name\": \"Amanda Miller\",\n                \"company_name\": \"Adult Signature\",\n                \"address_line1\": \"525 Winchester Blvd\",\n                \"city_locality\": \"San Jose\",\n                \"state_province\": \"CA\",\n                \"postal_code\": \"95128\",\n                \"address_residential_indicator\": \"yes\"\n            }\n        },\n        {\n            \"type\": \"person\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"Amanda Miller\",\n            \"start_index\": 63,\n            \"end_index\": 75,\n            \"result\": {\n                \"value\": \"Amanda Miller\"\n            }\n        },\n        {\n            \"type\": \"residential_indicator\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"house\",\n            \"start_index\": 79,\n            \"end_index\": 83,\n            \"result\": {\n                \"value\": \"yes\"\n            }\n        },\n        {\n            \"type\": \"address_line\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"525 Winchester Blvd\",\n            \"start_index\": 88,\n            \"end_index\": 106,\n            \"result\": {\n                \"line\": 1,\n                \"value\": \"525 Winchester Blvd\"\n            }\n        },\n        {\n            \"type\": \"number\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"525\",\n            \"start_index\": 88,\n            \"end_index\": 90,\n            \"result\": {\n                \"type\": \"cardinal\",\n                \"value\": 525\n            }\n        },\n        {\n            \"type\": \"city_locality\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"San Jose\",\n            \"start_index\": 111,\n            \"end_index\": 118,\n            \"result\": {\n                \"value\": \"San Jose\"\n            }\n        },\n        {\n            \"type\": \"state_province\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"California\",\n            \"start_index\": 120,\n            \"end_index\": 129,\n            \"result\": {\n                \"name\": \"California\",\n                \"value\": \"CA\"\n            }\n        },\n        {\n            \"type\": \"postal_code\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"95128\",\n            \"start_index\": 148,\n            \"end_index\": 152,\n            \"result\": {\n                \"value\": \"95128\"\n            }\n        },\n        {\n            \"type\": \"insurance\",\n            \"score\": 0.8530163983409642,\n            \"text\": \"insure it for $400\",\n            \"start_index\": 180,\n            \"end_index\": 197,\n            \"result\": {\n                \"value\": 400,\n                \"unit\": \"USD\"\n            }\n        },\n        {\n            \"type\": \"insured_value\",\n            \"score\": 1,\n            \"text\": \"$400\",\n            \"start_index\": 194,\n            \"end_index\": 197,\n            \"result\": {\n                \"unit\": \"USD\",\n                \"value\": 400\n            }\n        },\n        {\n            \"type\": \"company\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"adult signature\",\n            \"start_index\": 214,\n            \"end_index\": 228,\n            \"result\": {\n                \"value\": \"Adult Signature\"\n            }\n        },\n        {\n            \"type\": \"delivery_confirmation\",\n            \"score\": 0.8530163983409642,\n            \"text\": \"adult signature\",\n            \"start_index\": 214,\n            \"end_index\": 228,\n            \"result\": {\n                \"name\": \"Adult Signature\",\n                \"value\": \"adult_signature\"\n            }\n        }\n    ]\n}"
    }
  ]
}