autoit / ShipEngine Walkthrough / Parse shipment info w/ known fields
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
; 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"
; }
; }
; }
$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("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.")
$oJson.UpdateString("shipment.ship_from.name","John Doe")
$oJson.UpdateString("shipment.ship_from.company_name","Example Corp.")
$oJson.UpdateString("shipment.ship_from.address_line1","4009 Marathon Blvd")
$oJson.UpdateString("shipment.ship_from.city_locality","Austin")
$oJson.UpdateString("shipment.ship_from.state_province","TX")
$oJson.UpdateString("shipment.ship_from.postal_code","78756")
$oJson.UpdateString("shipment.ship_from.country_code","US")
$oJson.UpdateString("shipment.ship_from.phone","512-555-5555")
$oHttp.SetRequestHeader "API-Key","{{API_KEY}}"
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://api.shipengine.com/v1/shipments/recognize","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $iValue
Local $sUnit
Local $iLength
Local $iWidth
Local $iHeight
Local $sDimensionsUnit
Local $iAmount
Local $sV_Currency
Local $sV_type
Local $sText
Local $iStart_index
Local $iEnd_index
Local $iResultValue
Local $sResultUnit
Local $iResultLength
Local $iResultWidth
Local $iResultHeight
Local $sDirection
Local $sResultName
Local $sResultCompany_name
Local $sResultAddress_line1
Local $sResultCity_locality
Local $sResultState_province
Local $sResultPostal_code
Local $sResultAddress_residential_indicator
Local $iLine
Local $sV_Type
Local $score = $oJResp.StringOf("score")
Local $sConfirmation = $oJResp.StringOf("shipment.confirmation")
Local $sName = $oJResp.StringOf("shipment.ship_to.name")
Local $sCompany_name = $oJResp.StringOf("shipment.ship_to.company_name")
Local $sAddress_line1 = $oJResp.StringOf("shipment.ship_to.address_line1")
Local $sCity_locality = $oJResp.StringOf("shipment.ship_to.city_locality")
Local $sState_province = $oJResp.StringOf("shipment.ship_to.state_province")
Local $sPostal_code = $oJResp.StringOf("shipment.ship_to.postal_code")
Local $sAddress_residential_indicator = $oJResp.StringOf("shipment.ship_to.address_residential_indicator")
Local $sShip_fromName = $oJResp.StringOf("shipment.ship_from.name")
Local $sShip_fromCompany_name = $oJResp.StringOf("shipment.ship_from.company_name")
Local $sPhone = $oJResp.StringOf("shipment.ship_from.phone")
Local $sShip_fromAddress_line1 = $oJResp.StringOf("shipment.ship_from.address_line1")
Local $sShip_fromCity_locality = $oJResp.StringOf("shipment.ship_from.city_locality")
Local $sShip_fromState_province = $oJResp.StringOf("shipment.ship_from.state_province")
Local $sShip_fromPostal_code = $oJResp.StringOf("shipment.ship_from.postal_code")
Local $sCountry_code = $oJResp.StringOf("shipment.ship_from.country_code")
Local $sShip_fromAddress_residential_indicator = $oJResp.StringOf("shipment.ship_from.address_residential_indicator")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("shipment.packages")
While $i < $iCount_i
$oJResp.I = $i
$iValue = $oJResp.IntOf("shipment.packages[i].weight.value")
$sUnit = $oJResp.StringOf("shipment.packages[i].weight.unit")
$iLength = $oJResp.IntOf("shipment.packages[i].dimensions.length")
$iWidth = $oJResp.IntOf("shipment.packages[i].dimensions.width")
$iHeight = $oJResp.IntOf("shipment.packages[i].dimensions.height")
$sDimensionsUnit = $oJResp.StringOf("shipment.packages[i].dimensions.unit")
$iAmount = $oJResp.IntOf("shipment.packages[i].insured_value.amount")
$sV_Currency = $oJResp.StringOf("shipment.packages[i].insured_value.currency")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("entities")
While $i < $iCount_i
$oJResp.I = $i
$sV_type = $oJResp.StringOf("entities[i].type")
$score = $oJResp.StringOf("entities[i].score")
$sText = $oJResp.StringOf("entities[i].text")
$iStart_index = $oJResp.IntOf("entities[i].start_index")
$iEnd_index = $oJResp.IntOf("entities[i].end_index")
$iResultValue = $oJResp.IntOf("entities[i].result.value")
$sResultUnit = $oJResp.StringOf("entities[i].result.unit")
$iResultLength = $oJResp.IntOf("entities[i].result.length")
$iResultWidth = $oJResp.IntOf("entities[i].result.width")
$iResultHeight = $oJResp.IntOf("entities[i].result.height")
$sDirection = $oJResp.StringOf("entities[i].result.direction")
$sResultName = $oJResp.StringOf("entities[i].result.name")
$sResultCompany_name = $oJResp.StringOf("entities[i].result.company_name")
$sResultAddress_line1 = $oJResp.StringOf("entities[i].result.address_line1")
$sResultCity_locality = $oJResp.StringOf("entities[i].result.city_locality")
$sResultState_province = $oJResp.StringOf("entities[i].result.state_province")
$sResultPostal_code = $oJResp.StringOf("entities[i].result.postal_code")
$sResultAddress_residential_indicator = $oJResp.StringOf("entities[i].result.address_residential_indicator")
$iLine = $oJResp.IntOf("entities[i].result.line")
$sV_Type = $oJResp.StringOf("entities[i].result.type")
$i = $i + 1
Wend
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}"
}
]
}
