Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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.",
# "shipment": {
# "ship_from": {
# "name": "John Doe",
# "company_name": "Example Corp.",
# "address_line1": "4009 Marathon Blvd",
# "city_locality": "Austin",
# "state_province": "TX",
# "postal_code": "78756",
# "country_code": "US",
# "phone": "512-555-5555"
# }
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "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."
CkJsonObject_UpdateString $json "shipment.ship_from.name" "John Doe"
CkJsonObject_UpdateString $json "shipment.ship_from.company_name" "Example Corp."
CkJsonObject_UpdateString $json "shipment.ship_from.address_line1" "4009 Marathon Blvd"
CkJsonObject_UpdateString $json "shipment.ship_from.city_locality" "Austin"
CkJsonObject_UpdateString $json "shipment.ship_from.state_province" "TX"
CkJsonObject_UpdateString $json "shipment.ship_from.postal_code" "78756"
CkJsonObject_UpdateString $json "shipment.ship_from.country_code" "US"
CkJsonObject_UpdateString $json "shipment.ship_from.phone" "512-555-5555"
CkHttp_SetRequestHeader $http "API-Key" "{{API_KEY}}"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.shipengine.com/v1/shipments/recognize" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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"
# },
# "ship_from": {
# "name": "John Doe",
# "company_name": "Example Corp.",
# "phone": "512-555-5555",
# "address_line1": "4009 Marathon Blvd",
# "city_locality": "Austin",
# "state_province": "TX",
# "postal_code": "78756",
# "country_code": "US",
# "address_residential_indicator": "unknown"
# },
# "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
set score [CkJsonObject_stringOf $jResp "score"]
set Confirmation [CkJsonObject_stringOf $jResp "shipment.confirmation"]
set Name [CkJsonObject_stringOf $jResp "shipment.ship_to.name"]
set Company_name [CkJsonObject_stringOf $jResp "shipment.ship_to.company_name"]
set Address_line1 [CkJsonObject_stringOf $jResp "shipment.ship_to.address_line1"]
set City_locality [CkJsonObject_stringOf $jResp "shipment.ship_to.city_locality"]
set State_province [CkJsonObject_stringOf $jResp "shipment.ship_to.state_province"]
set Postal_code [CkJsonObject_stringOf $jResp "shipment.ship_to.postal_code"]
set Address_residential_indicator [CkJsonObject_stringOf $jResp "shipment.ship_to.address_residential_indicator"]
set Ship_fromName [CkJsonObject_stringOf $jResp "shipment.ship_from.name"]
set Ship_fromCompany_name [CkJsonObject_stringOf $jResp "shipment.ship_from.company_name"]
set Phone [CkJsonObject_stringOf $jResp "shipment.ship_from.phone"]
set Ship_fromAddress_line1 [CkJsonObject_stringOf $jResp "shipment.ship_from.address_line1"]
set Ship_fromCity_locality [CkJsonObject_stringOf $jResp "shipment.ship_from.city_locality"]
set Ship_fromState_province [CkJsonObject_stringOf $jResp "shipment.ship_from.state_province"]
set Ship_fromPostal_code [CkJsonObject_stringOf $jResp "shipment.ship_from.postal_code"]
set Country_code [CkJsonObject_stringOf $jResp "shipment.ship_from.country_code"]
set Ship_fromAddress_residential_indicator [CkJsonObject_stringOf $jResp "shipment.ship_from.address_residential_indicator"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "shipment.packages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Value [CkJsonObject_IntOf $jResp "shipment.packages[i].weight.value"]
set Unit [CkJsonObject_stringOf $jResp "shipment.packages[i].weight.unit"]
set Length [CkJsonObject_IntOf $jResp "shipment.packages[i].dimensions.length"]
set Width [CkJsonObject_IntOf $jResp "shipment.packages[i].dimensions.width"]
set Height [CkJsonObject_IntOf $jResp "shipment.packages[i].dimensions.height"]
set dimensionsUnit [CkJsonObject_stringOf $jResp "shipment.packages[i].dimensions.unit"]
set Amount [CkJsonObject_IntOf $jResp "shipment.packages[i].insured_value.amount"]
set v_Currency [CkJsonObject_stringOf $jResp "shipment.packages[i].insured_value.currency"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "entities"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set v_type [CkJsonObject_stringOf $jResp "entities[i].type"]
set score [CkJsonObject_stringOf $jResp "entities[i].score"]
set text [CkJsonObject_stringOf $jResp "entities[i].text"]
set start_index [CkJsonObject_IntOf $jResp "entities[i].start_index"]
set end_index [CkJsonObject_IntOf $jResp "entities[i].end_index"]
set resultValue [CkJsonObject_IntOf $jResp "entities[i].result.value"]
set resultUnit [CkJsonObject_stringOf $jResp "entities[i].result.unit"]
set resultLength [CkJsonObject_IntOf $jResp "entities[i].result.length"]
set resultWidth [CkJsonObject_IntOf $jResp "entities[i].result.width"]
set resultHeight [CkJsonObject_IntOf $jResp "entities[i].result.height"]
set Direction [CkJsonObject_stringOf $jResp "entities[i].result.direction"]
set resultName [CkJsonObject_stringOf $jResp "entities[i].result.name"]
set resultCompany_name [CkJsonObject_stringOf $jResp "entities[i].result.company_name"]
set resultAddress_line1 [CkJsonObject_stringOf $jResp "entities[i].result.address_line1"]
set resultCity_locality [CkJsonObject_stringOf $jResp "entities[i].result.city_locality"]
set resultState_province [CkJsonObject_stringOf $jResp "entities[i].result.state_province"]
set resultPostal_code [CkJsonObject_stringOf $jResp "entities[i].result.postal_code"]
set resultAddress_residential_indicator [CkJsonObject_stringOf $jResp "entities[i].result.address_residential_indicator"]
set Line [CkJsonObject_IntOf $jResp "entities[i].result.line"]
set v_Type [CkJsonObject_stringOf $jResp "entities[i].result.type"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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.",
"shipment": {
"ship_from": {
"name": "John Doe",
"company_name": "Example Corp.",
"address_line1": "4009 Marathon Blvd",
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"phone": "512-555-5555"
}
}
}'
https://api.shipengine.com/v1/shipments/recognize
Postman Collection Item JSON
{
"name": "Parse shipment info w/ known fields",
"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\t\"shipment\": {\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t}\n\t}\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/shipments/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"shipments",
"recognize"
]
},
"description": "If you already know some parts of the shipment, you can provide them to ShipEngine, and we'll use those values. These values can also help us recognize other parts of the shipment."
},
"response": [
{
"name": "Parse shipment info w/ known fields",
"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\t\"shipment\": {\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t}\n\t}\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 17:13:29 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 \"ship_from\": {\n \"name\": \"John Doe\",\n \"company_name\": \"Example Corp.\",\n \"phone\": \"512-555-5555\",\n \"address_line1\": \"4009 Marathon Blvd\",\n \"city_locality\": \"Austin\",\n \"state_province\": \"TX\",\n \"postal_code\": \"78756\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\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}"
}
]
}
