Chilkat Online Tools

autoit / ShipEngine Walkthrough / Validate when creating a shipment

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.

; {
;   "shipments": [
;     {
;       "validate_address": "validate_and_clean",
;       "service_code": "usps_priority_mail",
;       "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"
;       },
;       "ship_to": {
;         "name": "Amanda Miller",
;         "address_line1": "525 Winchester",
;         "postal_code": "95128",
;         "country_code": "US"
;       },
;       "packages": [
;         {
;           "weight": {
;             "value": 17,
;             "unit": "pound"
;           },
;           "dimensions": {
;             "length": 36,
;             "width": 12,
;             "height": 24,
;             "unit": "inch"
;           }
;         }
;       ]
;     }
;   ]
; }

$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("shipments[0].validate_address","validate_and_clean")
$oJson.UpdateString("shipments[0].service_code","usps_priority_mail")
$oJson.UpdateString("shipments[0].ship_from.name","John Doe")
$oJson.UpdateString("shipments[0].ship_from.company_name","Example Corp.")
$oJson.UpdateString("shipments[0].ship_from.address_line1","4009 Marathon Blvd")
$oJson.UpdateString("shipments[0].ship_from.city_locality","Austin")
$oJson.UpdateString("shipments[0].ship_from.state_province","TX")
$oJson.UpdateString("shipments[0].ship_from.postal_code","78756")
$oJson.UpdateString("shipments[0].ship_from.country_code","US")
$oJson.UpdateString("shipments[0].ship_from.phone","512-555-5555")
$oJson.UpdateString("shipments[0].ship_to.name","Amanda Miller")
$oJson.UpdateString("shipments[0].ship_to.address_line1","525 Winchester")
$oJson.UpdateString("shipments[0].ship_to.postal_code","95128")
$oJson.UpdateString("shipments[0].ship_to.country_code","US")
$oJson.UpdateInt("shipments[0].packages[0].weight.value",17)
$oJson.UpdateString("shipments[0].packages[0].weight.unit","pound")
$oJson.UpdateInt("shipments[0].packages[0].dimensions.length",36)
$oJson.UpdateInt("shipments[0].packages[0].dimensions.width",12)
$oJson.UpdateInt("shipments[0].packages[0].dimensions.height",24)
$oJson.UpdateString("shipments[0].packages[0].dimensions.unit","inch")

$oHttp.SetRequestHeader "API-Key","{{API_KEY}}"
$oHttp.SetRequestHeader "Content-Type","application/json"

Local $oResp = $oHttp.PostJson3("https://api.shipengine.com/v1/shipments","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)

; {
;   "has_errors": false,
;   "shipments": [
;     {
;       "errors": [
;       ],
;       "address_validation": {
;         "status": "verified",
;         "original_address": {
;           "name": "Amanda Miller",
;           "phone": null,
;           "company_name": null,
;           "address_line1": "525 Winchester",
;           "address_line2": null,
;           "address_line3": null,
;           "city_locality": null,
;           "state_province": null,
;           "postal_code": "95128",
;           "country_code": "US",
;           "address_residential_indicator": "unknown"
;         },
;         "matched_address": {
;           "name": "AMANDA MILLER",
;           "phone": null,
;           "company_name": null,
;           "address_line1": "525 S WINCHESTER BLVD",
;           "address_line2": "",
;           "address_line3": null,
;           "city_locality": "SAN JOSE",
;           "state_province": "CA",
;           "postal_code": "95128-2537",
;           "country_code": "US",
;           "address_residential_indicator": "no"
;         },
;         "messages": [
;         ]
;       },
;       "shipment_id": "se-4159801",
;       "carrier_id": "se-121861",
;       "service_code": "usps_priority_mail",
;       "external_shipment_id": null,
;       "ship_date": "2019-09-18T00:00:00Z",
;       "created_at": "2019-09-18T16:01:54.9171198Z",
;       "modified_at": "2019-09-18T16:01:54.9171198Z",
;       "shipment_status": "pending",
;       "ship_to": {
;         "name": "AMANDA MILLER",
;         "phone": null,
;         "company_name": null,
;         "address_line1": "525 S WINCHESTER BLVD",
;         "address_line2": "",
;         "address_line3": null,
;         "city_locality": "SAN JOSE",
;         "state_province": "CA",
;         "postal_code": "95128-2537",
;         "country_code": "US",
;         "address_residential_indicator": "no"
;       },
;       "ship_from": {
;         "name": "John Doe",
;         "phone": "512-555-5555",
;         "company_name": "Example Corp.",
;         "address_line1": "4009 Marathon Blvd",
;         "address_line2": null,
;         "address_line3": null,
;         "city_locality": "Austin",
;         "state_province": "TX",
;         "postal_code": "78756",
;         "country_code": "US",
;         "address_residential_indicator": "unknown"
;       },
;       "warehouse_id": null,
;       "return_to": {
;         "name": "John Doe",
;         "phone": "512-555-5555",
;         "company_name": "Example Corp.",
;         "address_line1": "4009 Marathon Blvd",
;         "address_line2": null,
;         "address_line3": null,
;         "city_locality": "Austin",
;         "state_province": "TX",
;         "postal_code": "78756",
;         "country_code": "US",
;         "address_residential_indicator": "unknown"
;       },
;       "confirmation": "none",
;       "customs": null,
;       "external_order_id": null,
;       "order_source_code": null,
;       "advanced_options": {
;         "bill_to_account": null,
;         "bill_to_country_code": null,
;         "bill_to_party": null,
;         "bill_to_postal_code": null,
;         "contains_alcohol": false,
;         "delivered_duty_paid": false,
;         "non_machinable": false,
;         "saturday_delivery": false,
;         "dry_ice": false,
;         "dry_ice_weight": null,
;         "freight_class": null,
;         "custom_field1": null,
;         "custom_field2": null,
;         "custom_field3": null
;       },
;       "insurance_provider": "none",
;       "tags": [
;       ],
;       "packages": [
;         {
;           "package_code": "package",
;           "weight": {
;             "value": 17,
;             "unit": "pound"
;           },
;           "dimensions": {
;             "unit": "inch",
;             "length": 36,
;             "width": 12,
;             "height": 24
;           },
;           "insured_value": {
;             "currency": "usd",
;             "amount": 0
;           },
;           "label_messages": {
;             "reference1": null,
;             "reference2": null,
;             "reference3": null
;           },
;           "external_package_id": null
;         }
;       ],
;       "total_weight": {
;         "value": 17,
;         "unit": "pound"
;       },
;       "items": [
;       ]
;     }
;   ]
; }

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

Local $sStatus
Local $sName
Local $sPhone
Local $sCompany_name
Local $sAddress_line1
Local $sAddress_line2
Local $sAddress_line3
Local $sCity_locality
Local $sState_province
Local $sPostal_code
Local $sCountry_code
Local $sAddress_residential_indicator
Local $sMatched_addressName
Local $sMatched_addressPhone
Local $sMatched_addressCompany_name
Local $sMatched_addressAddress_line1
Local $sMatched_addressAddress_line2
Local $sMatched_addressAddress_line3
Local $sMatched_addressCity_locality
Local $sMatched_addressState_province
Local $sMatched_addressPostal_code
Local $sMatched_addressCountry_code
Local $sMatched_addressAddress_residential_indicator
Local $shipment_id
Local $sCarrier_id
Local $service_code
Local $sExternal_shipment_id
Local $ship_date
Local $sCreated_at
Local $sModified_at
Local $shipment_status
Local $ship_toName
Local $ship_toPhone
Local $ship_toCompany_name
Local $ship_toAddress_line1
Local $ship_toAddress_line2
Local $ship_toAddress_line3
Local $ship_toCity_locality
Local $ship_toState_province
Local $ship_toPostal_code
Local $ship_toCountry_code
Local $ship_toAddress_residential_indicator
Local $ship_fromName
Local $ship_fromPhone
Local $ship_fromCompany_name
Local $ship_fromAddress_line1
Local $ship_fromAddress_line2
Local $ship_fromAddress_line3
Local $ship_fromCity_locality
Local $ship_fromState_province
Local $ship_fromPostal_code
Local $ship_fromCountry_code
Local $ship_fromAddress_residential_indicator
Local $sWarehouse_id
Local $sReturn_toName
Local $sReturn_toPhone
Local $sReturn_toCompany_name
Local $sReturn_toAddress_line1
Local $sReturn_toAddress_line2
Local $sReturn_toAddress_line3
Local $sReturn_toCity_locality
Local $sReturn_toState_province
Local $sReturn_toPostal_code
Local $sReturn_toCountry_code
Local $sReturn_toAddress_residential_indicator
Local $sConfirmation
Local $sCustoms
Local $sExternal_order_id
Local $sOrder_source_code
Local $sBill_to_account
Local $sBill_to_country_code
Local $sBill_to_party
Local $sBill_to_postal_code
Local $bContains_alcohol
Local $bDelivered_duty_paid
Local $bNon_machinable
Local $bSaturday_delivery
Local $bDry_ice
Local $sDry_ice_weight
Local $sFreight_class
Local $sCustom_field1
Local $sCustom_field2
Local $sCustom_field3
Local $sInsurance_provider
Local $iValue
Local $sUnit
Local $iJ
Local $iCount_j
Local $sPackage_code
Local $iWeightValue
Local $sWeightUnit
Local $sDimensionsUnit
Local $iLength
Local $iWidth
Local $iHeight
Local $sV_Currency
Local $iAmount
Local $sReference1
Local $sReference2
Local $sReference3
Local $sExternal_package_id

Local $bHas_errors = $oJResp.BoolOf("has_errors")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("shipments")
While $i < $iCount_i
    $oJResp.I = $i
    $sStatus = $oJResp.StringOf("shipments[i].address_validation.status")
    $sName = $oJResp.StringOf("shipments[i].address_validation.original_address.name")
    $sPhone = $oJResp.StringOf("shipments[i].address_validation.original_address.phone")
    $sCompany_name = $oJResp.StringOf("shipments[i].address_validation.original_address.company_name")
    $sAddress_line1 = $oJResp.StringOf("shipments[i].address_validation.original_address.address_line1")
    $sAddress_line2 = $oJResp.StringOf("shipments[i].address_validation.original_address.address_line2")
    $sAddress_line3 = $oJResp.StringOf("shipments[i].address_validation.original_address.address_line3")
    $sCity_locality = $oJResp.StringOf("shipments[i].address_validation.original_address.city_locality")
    $sState_province = $oJResp.StringOf("shipments[i].address_validation.original_address.state_province")
    $sPostal_code = $oJResp.StringOf("shipments[i].address_validation.original_address.postal_code")
    $sCountry_code = $oJResp.StringOf("shipments[i].address_validation.original_address.country_code")
    $sAddress_residential_indicator = $oJResp.StringOf("shipments[i].address_validation.original_address.address_residential_indicator")
    $sMatched_addressName = $oJResp.StringOf("shipments[i].address_validation.matched_address.name")
    $sMatched_addressPhone = $oJResp.StringOf("shipments[i].address_validation.matched_address.phone")
    $sMatched_addressCompany_name = $oJResp.StringOf("shipments[i].address_validation.matched_address.company_name")
    $sMatched_addressAddress_line1 = $oJResp.StringOf("shipments[i].address_validation.matched_address.address_line1")
    $sMatched_addressAddress_line2 = $oJResp.StringOf("shipments[i].address_validation.matched_address.address_line2")
    $sMatched_addressAddress_line3 = $oJResp.StringOf("shipments[i].address_validation.matched_address.address_line3")
    $sMatched_addressCity_locality = $oJResp.StringOf("shipments[i].address_validation.matched_address.city_locality")
    $sMatched_addressState_province = $oJResp.StringOf("shipments[i].address_validation.matched_address.state_province")
    $sMatched_addressPostal_code = $oJResp.StringOf("shipments[i].address_validation.matched_address.postal_code")
    $sMatched_addressCountry_code = $oJResp.StringOf("shipments[i].address_validation.matched_address.country_code")
    $sMatched_addressAddress_residential_indicator = $oJResp.StringOf("shipments[i].address_validation.matched_address.address_residential_indicator")
    $shipment_id = $oJResp.StringOf("shipments[i].shipment_id")
    $sCarrier_id = $oJResp.StringOf("shipments[i].carrier_id")
    $service_code = $oJResp.StringOf("shipments[i].service_code")
    $sExternal_shipment_id = $oJResp.StringOf("shipments[i].external_shipment_id")
    $ship_date = $oJResp.StringOf("shipments[i].ship_date")
    $sCreated_at = $oJResp.StringOf("shipments[i].created_at")
    $sModified_at = $oJResp.StringOf("shipments[i].modified_at")
    $shipment_status = $oJResp.StringOf("shipments[i].shipment_status")
    $ship_toName = $oJResp.StringOf("shipments[i].ship_to.name")
    $ship_toPhone = $oJResp.StringOf("shipments[i].ship_to.phone")
    $ship_toCompany_name = $oJResp.StringOf("shipments[i].ship_to.company_name")
    $ship_toAddress_line1 = $oJResp.StringOf("shipments[i].ship_to.address_line1")
    $ship_toAddress_line2 = $oJResp.StringOf("shipments[i].ship_to.address_line2")
    $ship_toAddress_line3 = $oJResp.StringOf("shipments[i].ship_to.address_line3")
    $ship_toCity_locality = $oJResp.StringOf("shipments[i].ship_to.city_locality")
    $ship_toState_province = $oJResp.StringOf("shipments[i].ship_to.state_province")
    $ship_toPostal_code = $oJResp.StringOf("shipments[i].ship_to.postal_code")
    $ship_toCountry_code = $oJResp.StringOf("shipments[i].ship_to.country_code")
    $ship_toAddress_residential_indicator = $oJResp.StringOf("shipments[i].ship_to.address_residential_indicator")
    $ship_fromName = $oJResp.StringOf("shipments[i].ship_from.name")
    $ship_fromPhone = $oJResp.StringOf("shipments[i].ship_from.phone")
    $ship_fromCompany_name = $oJResp.StringOf("shipments[i].ship_from.company_name")
    $ship_fromAddress_line1 = $oJResp.StringOf("shipments[i].ship_from.address_line1")
    $ship_fromAddress_line2 = $oJResp.StringOf("shipments[i].ship_from.address_line2")
    $ship_fromAddress_line3 = $oJResp.StringOf("shipments[i].ship_from.address_line3")
    $ship_fromCity_locality = $oJResp.StringOf("shipments[i].ship_from.city_locality")
    $ship_fromState_province = $oJResp.StringOf("shipments[i].ship_from.state_province")
    $ship_fromPostal_code = $oJResp.StringOf("shipments[i].ship_from.postal_code")
    $ship_fromCountry_code = $oJResp.StringOf("shipments[i].ship_from.country_code")
    $ship_fromAddress_residential_indicator = $oJResp.StringOf("shipments[i].ship_from.address_residential_indicator")
    $sWarehouse_id = $oJResp.StringOf("shipments[i].warehouse_id")
    $sReturn_toName = $oJResp.StringOf("shipments[i].return_to.name")
    $sReturn_toPhone = $oJResp.StringOf("shipments[i].return_to.phone")
    $sReturn_toCompany_name = $oJResp.StringOf("shipments[i].return_to.company_name")
    $sReturn_toAddress_line1 = $oJResp.StringOf("shipments[i].return_to.address_line1")
    $sReturn_toAddress_line2 = $oJResp.StringOf("shipments[i].return_to.address_line2")
    $sReturn_toAddress_line3 = $oJResp.StringOf("shipments[i].return_to.address_line3")
    $sReturn_toCity_locality = $oJResp.StringOf("shipments[i].return_to.city_locality")
    $sReturn_toState_province = $oJResp.StringOf("shipments[i].return_to.state_province")
    $sReturn_toPostal_code = $oJResp.StringOf("shipments[i].return_to.postal_code")
    $sReturn_toCountry_code = $oJResp.StringOf("shipments[i].return_to.country_code")
    $sReturn_toAddress_residential_indicator = $oJResp.StringOf("shipments[i].return_to.address_residential_indicator")
    $sConfirmation = $oJResp.StringOf("shipments[i].confirmation")
    $sCustoms = $oJResp.StringOf("shipments[i].customs")
    $sExternal_order_id = $oJResp.StringOf("shipments[i].external_order_id")
    $sOrder_source_code = $oJResp.StringOf("shipments[i].order_source_code")
    $sBill_to_account = $oJResp.StringOf("shipments[i].advanced_options.bill_to_account")
    $sBill_to_country_code = $oJResp.StringOf("shipments[i].advanced_options.bill_to_country_code")
    $sBill_to_party = $oJResp.StringOf("shipments[i].advanced_options.bill_to_party")
    $sBill_to_postal_code = $oJResp.StringOf("shipments[i].advanced_options.bill_to_postal_code")
    $bContains_alcohol = $oJResp.BoolOf("shipments[i].advanced_options.contains_alcohol")
    $bDelivered_duty_paid = $oJResp.BoolOf("shipments[i].advanced_options.delivered_duty_paid")
    $bNon_machinable = $oJResp.BoolOf("shipments[i].advanced_options.non_machinable")
    $bSaturday_delivery = $oJResp.BoolOf("shipments[i].advanced_options.saturday_delivery")
    $bDry_ice = $oJResp.BoolOf("shipments[i].advanced_options.dry_ice")
    $sDry_ice_weight = $oJResp.StringOf("shipments[i].advanced_options.dry_ice_weight")
    $sFreight_class = $oJResp.StringOf("shipments[i].advanced_options.freight_class")
    $sCustom_field1 = $oJResp.StringOf("shipments[i].advanced_options.custom_field1")
    $sCustom_field2 = $oJResp.StringOf("shipments[i].advanced_options.custom_field2")
    $sCustom_field3 = $oJResp.StringOf("shipments[i].advanced_options.custom_field3")
    $sInsurance_provider = $oJResp.StringOf("shipments[i].insurance_provider")
    $iValue = $oJResp.IntOf("shipments[i].total_weight.value")
    $sUnit = $oJResp.StringOf("shipments[i].total_weight.unit")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("shipments[i].errors")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("shipments[i].address_validation.messages")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("shipments[i].tags")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("shipments[i].packages")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sPackage_code = $oJResp.StringOf("shipments[i].packages[j].package_code")
        $iWeightValue = $oJResp.IntOf("shipments[i].packages[j].weight.value")
        $sWeightUnit = $oJResp.StringOf("shipments[i].packages[j].weight.unit")
        $sDimensionsUnit = $oJResp.StringOf("shipments[i].packages[j].dimensions.unit")
        $iLength = $oJResp.IntOf("shipments[i].packages[j].dimensions.length")
        $iWidth = $oJResp.IntOf("shipments[i].packages[j].dimensions.width")
        $iHeight = $oJResp.IntOf("shipments[i].packages[j].dimensions.height")
        $sV_Currency = $oJResp.StringOf("shipments[i].packages[j].insured_value.currency")
        $iAmount = $oJResp.IntOf("shipments[i].packages[j].insured_value.amount")
        $sReference1 = $oJResp.StringOf("shipments[i].packages[j].label_messages.reference1")
        $sReference2 = $oJResp.StringOf("shipments[i].packages[j].label_messages.reference2")
        $sReference3 = $oJResp.StringOf("shipments[i].packages[j].label_messages.reference3")
        $sExternal_package_id = $oJResp.StringOf("shipments[i].packages[j].external_package_id")
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("shipments[i].items")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '{
	"shipments": [{
		"validate_address": "validate_and_clean",
		"service_code": "usps_priority_mail",
		"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"
		},
		"ship_to": {
			"name": "Amanda Miller",
			"address_line1": "525 Winchester",
			"postal_code": "95128",
			"country_code": "US"
		},
		"packages": [
			{
				"weight": {
					"value": 17,
					"unit": "pound"
				},
				"dimensions": {
					"length": 36,
					"width": 12,
					"height": 24,
					"unit": "inch"
				}
			}
		]
	}]
}'
https://api.shipengine.com/v1/shipments

Postman Collection Item JSON

{
  "name": "Validate when creating a shipment",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let response = pm.response.json();",
          "",
          "if (response.shipments.length > 0) {",
          "    pm.collectionVariables.set(\"shipment_id\", response.shipments[0].shipment_id);",
          "}"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"shipments\": [{\n\t\t\"validate_address\": \"validate_and_clean\",\n\t\t\"service_code\": \"usps_priority_mail\",\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\t\"ship_to\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 Winchester\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}]\n}"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/shipments",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "shipments"
      ]
    },
    "description": "You can validate the address at the same time as creating a shipment in ShipEngine by setting the `validate_address` field to either `validate_only` or `validate_and_clean`."
  },
  "response": [
    {
      "name": "Validate when creating a shipment",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"shipments\": [{\n\t\t\"validate_address\": \"validate_and_clean\",\n\t\t\"service_code\": \"usps_priority_mail\",\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\t\"ship_to\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 Winchester\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.shipengine.com/v1/shipments",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "shipments"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 18 Sep 2019 16:01:54 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "4156"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "9b4734c7-f7d7-4ce9-8597-e9e6696d0053"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"has_errors\": false,\n    \"shipments\": [\n        {\n            \"errors\": [],\n            \"address_validation\": {\n                \"status\": \"verified\",\n                \"original_address\": {\n                    \"name\": \"Amanda Miller\",\n                    \"phone\": null,\n                    \"company_name\": null,\n                    \"address_line1\": \"525 Winchester\",\n                    \"address_line2\": null,\n                    \"address_line3\": null,\n                    \"city_locality\": null,\n                    \"state_province\": null,\n                    \"postal_code\": \"95128\",\n                    \"country_code\": \"US\",\n                    \"address_residential_indicator\": \"unknown\"\n                },\n                \"matched_address\": {\n                    \"name\": \"AMANDA MILLER\",\n                    \"phone\": null,\n                    \"company_name\": null,\n                    \"address_line1\": \"525 S WINCHESTER BLVD\",\n                    \"address_line2\": \"\",\n                    \"address_line3\": null,\n                    \"city_locality\": \"SAN JOSE\",\n                    \"state_province\": \"CA\",\n                    \"postal_code\": \"95128-2537\",\n                    \"country_code\": \"US\",\n                    \"address_residential_indicator\": \"no\"\n                },\n                \"messages\": []\n            },\n            \"shipment_id\": \"se-4159801\",\n            \"carrier_id\": \"se-121861\",\n            \"service_code\": \"usps_priority_mail\",\n            \"external_shipment_id\": null,\n            \"ship_date\": \"2019-09-18T00:00:00Z\",\n            \"created_at\": \"2019-09-18T16:01:54.9171198Z\",\n            \"modified_at\": \"2019-09-18T16:01:54.9171198Z\",\n            \"shipment_status\": \"pending\",\n            \"ship_to\": {\n                \"name\": \"AMANDA MILLER\",\n                \"phone\": null,\n                \"company_name\": null,\n                \"address_line1\": \"525 S WINCHESTER BLVD\",\n                \"address_line2\": \"\",\n                \"address_line3\": null,\n                \"city_locality\": \"SAN JOSE\",\n                \"state_province\": \"CA\",\n                \"postal_code\": \"95128-2537\",\n                \"country_code\": \"US\",\n                \"address_residential_indicator\": \"no\"\n            },\n            \"ship_from\": {\n                \"name\": \"John Doe\",\n                \"phone\": \"512-555-5555\",\n                \"company_name\": \"Example Corp.\",\n                \"address_line1\": \"4009 Marathon Blvd\",\n                \"address_line2\": null,\n                \"address_line3\": null,\n                \"city_locality\": \"Austin\",\n                \"state_province\": \"TX\",\n                \"postal_code\": \"78756\",\n                \"country_code\": \"US\",\n                \"address_residential_indicator\": \"unknown\"\n            },\n            \"warehouse_id\": null,\n            \"return_to\": {\n                \"name\": \"John Doe\",\n                \"phone\": \"512-555-5555\",\n                \"company_name\": \"Example Corp.\",\n                \"address_line1\": \"4009 Marathon Blvd\",\n                \"address_line2\": null,\n                \"address_line3\": null,\n                \"city_locality\": \"Austin\",\n                \"state_province\": \"TX\",\n                \"postal_code\": \"78756\",\n                \"country_code\": \"US\",\n                \"address_residential_indicator\": \"unknown\"\n            },\n            \"confirmation\": \"none\",\n            \"customs\": null,\n            \"external_order_id\": null,\n            \"order_source_code\": null,\n            \"advanced_options\": {\n                \"bill_to_account\": null,\n                \"bill_to_country_code\": null,\n                \"bill_to_party\": null,\n                \"bill_to_postal_code\": null,\n                \"contains_alcohol\": false,\n                \"delivered_duty_paid\": false,\n                \"non_machinable\": false,\n                \"saturday_delivery\": false,\n                \"dry_ice\": false,\n                \"dry_ice_weight\": null,\n                \"freight_class\": null,\n                \"custom_field1\": null,\n                \"custom_field2\": null,\n                \"custom_field3\": null\n            },\n            \"insurance_provider\": \"none\",\n            \"tags\": [],\n            \"packages\": [\n                {\n                    \"package_code\": \"package\",\n                    \"weight\": {\n                        \"value\": 17,\n                        \"unit\": \"pound\"\n                    },\n                    \"dimensions\": {\n                        \"unit\": \"inch\",\n                        \"length\": 36,\n                        \"width\": 12,\n                        \"height\": 24\n                    },\n                    \"insured_value\": {\n                        \"currency\": \"usd\",\n                        \"amount\": 0\n                    },\n                    \"label_messages\": {\n                        \"reference1\": null,\n                        \"reference2\": null,\n                        \"reference3\": null\n                    },\n                    \"external_package_id\": null\n                }\n            ],\n            \"total_weight\": {\n                \"value\": 17,\n                \"unit\": \"pound\"\n            },\n            \"items\": []\n        }\n    ]\n}"
    }
  ]
}