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.
; {
; "rate_options": {
; "carrier_ids": [
; "{{stamps_com}}",
; "{{fedex}}",
; "{{ups}}"
; ],
; "service_codes": [
; "usps_priority_mail",
; "fedex_ground",
; "ups_ground"
; ]
; },
; "shipment": {
; "validate_address": "validate_and_clean",
; "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("rate_options.carrier_ids[0]","{{stamps_com}}")
$oJson.UpdateString("rate_options.carrier_ids[1]","{{fedex}}")
$oJson.UpdateString("rate_options.carrier_ids[2]","{{ups}}")
$oJson.UpdateString("rate_options.service_codes[0]","usps_priority_mail")
$oJson.UpdateString("rate_options.service_codes[1]","fedex_ground")
$oJson.UpdateString("rate_options.service_codes[2]","ups_ground")
$oJson.UpdateString("shipment.validate_address","validate_and_clean")
$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")
$oJson.UpdateString("shipment.ship_to.name","Amanda Miller")
$oJson.UpdateString("shipment.ship_to.address_line1","525 Winchester")
$oJson.UpdateString("shipment.ship_to.postal_code","95128")
$oJson.UpdateString("shipment.ship_to.country_code","US")
$oJson.UpdateInt("shipment.packages[0].weight.value",17)
$oJson.UpdateString("shipment.packages[0].weight.unit","pound")
$oJson.UpdateInt("shipment.packages[0].dimensions.length",36)
$oJson.UpdateInt("shipment.packages[0].dimensions.width",12)
$oJson.UpdateInt("shipment.packages[0].dimensions.height",24)
$oJson.UpdateString("shipment.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/rates","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)
; {
; "rate_response": {
; "rates": [
; {
; "rate_id": "se-12502689",
; "rate_type": "shipment",
; "carrier_id": "se-121862",
; "shipping_amount": {
; "currency": "usd",
; "amount": 65.58
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": null,
; "package_type": null,
; "delivery_days": 4,
; "guaranteed_service": true,
; "estimated_delivery_date": "2019-09-24T23:00:00Z",
; "carrier_delivery_days": "Tuesday 9/24 by 11:00 PM",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "UPS® Ground",
; "service_code": "ups_ground",
; "trackable": true,
; "carrier_code": "ups",
; "carrier_nickname": "ShipEngine Test Account - UPS",
; "carrier_friendly_name": "UPS",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502690",
; "rate_type": "shipment",
; "carrier_id": "se-121861",
; "shipping_amount": {
; "currency": "usd",
; "amount": 98.14
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": 7,
; "package_type": "package",
; "delivery_days": 2,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-20T00:00:00Z",
; "carrier_delivery_days": "2",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "USPS Priority Mail",
; "service_code": "usps_priority_mail",
; "trackable": true,
; "carrier_code": "stamps_com",
; "carrier_nickname": "ShipEngine Test Account - Stamps.com",
; "carrier_friendly_name": "Stamps.com",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502691",
; "rate_type": "shipment",
; "carrier_id": "se-121861",
; "shipping_amount": {
; "currency": "usd",
; "amount": 12.72
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": 7,
; "package_type": "medium_flat_rate_box",
; "delivery_days": 2,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-20T00:00:00Z",
; "carrier_delivery_days": "2",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "USPS Priority Mail",
; "service_code": "usps_priority_mail",
; "trackable": true,
; "carrier_code": "stamps_com",
; "carrier_nickname": "ShipEngine Test Account - Stamps.com",
; "carrier_friendly_name": "Stamps.com",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502692",
; "rate_type": "shipment",
; "carrier_id": "se-121861",
; "shipping_amount": {
; "currency": "usd",
; "amount": 6.98
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": 7,
; "package_type": "small_flat_rate_box",
; "delivery_days": 2,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-20T00:00:00Z",
; "carrier_delivery_days": "2",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "USPS Priority Mail",
; "service_code": "usps_priority_mail",
; "trackable": true,
; "carrier_code": "stamps_com",
; "carrier_nickname": "ShipEngine Test Account - Stamps.com",
; "carrier_friendly_name": "Stamps.com",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502693",
; "rate_type": "shipment",
; "carrier_id": "se-121861",
; "shipping_amount": {
; "currency": "usd",
; "amount": 17.47
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": 7,
; "package_type": "large_flat_rate_box",
; "delivery_days": 2,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-20T00:00:00Z",
; "carrier_delivery_days": "2",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "USPS Priority Mail",
; "service_code": "usps_priority_mail",
; "trackable": true,
; "carrier_code": "stamps_com",
; "carrier_nickname": "ShipEngine Test Account - Stamps.com",
; "carrier_friendly_name": "Stamps.com",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502694",
; "rate_type": "shipment",
; "carrier_id": "se-121861",
; "shipping_amount": {
; "currency": "usd",
; "amount": 6.48
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": 7,
; "package_type": "flat_rate_envelope",
; "delivery_days": 2,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-20T00:00:00Z",
; "carrier_delivery_days": "2",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "USPS Priority Mail",
; "service_code": "usps_priority_mail",
; "trackable": true,
; "carrier_code": "stamps_com",
; "carrier_nickname": "ShipEngine Test Account - Stamps.com",
; "carrier_friendly_name": "Stamps.com",
; "validation_status": "has_warnings",
; "warning_messages": [
; "Heads up! You've included custom dimensions for a package type with a standardized size. For more accurate rates, consider removing the dimensions for this shipment."
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502695",
; "rate_type": "shipment",
; "carrier_id": "se-121861",
; "shipping_amount": {
; "currency": "usd",
; "amount": 7.03
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": 7,
; "package_type": "flat_rate_padded_envelope",
; "delivery_days": 2,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-20T00:00:00Z",
; "carrier_delivery_days": "2",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "USPS Priority Mail",
; "service_code": "usps_priority_mail",
; "trackable": true,
; "carrier_code": "stamps_com",
; "carrier_nickname": "ShipEngine Test Account - Stamps.com",
; "carrier_friendly_name": "Stamps.com",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502696",
; "rate_type": "shipment",
; "carrier_id": "se-121861",
; "shipping_amount": {
; "currency": "usd",
; "amount": 6.78
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 0
; },
; "zone": 7,
; "package_type": "flat_rate_legal_envelope",
; "delivery_days": 2,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-20T00:00:00Z",
; "carrier_delivery_days": "2",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "USPS Priority Mail",
; "service_code": "usps_priority_mail",
; "trackable": true,
; "carrier_code": "stamps_com",
; "carrier_nickname": "ShipEngine Test Account - Stamps.com",
; "carrier_friendly_name": "Stamps.com",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; },
; {
; "rate_id": "se-12502697",
; "rate_type": "shipment",
; "carrier_id": "se-121863",
; "shipping_amount": {
; "currency": "usd",
; "amount": 58.37
; },
; "insurance_amount": {
; "currency": "usd",
; "amount": 0
; },
; "confirmation_amount": {
; "currency": "usd",
; "amount": 0
; },
; "other_amount": {
; "currency": "usd",
; "amount": 4.09
; },
; "zone": null,
; "package_type": null,
; "delivery_days": 3,
; "guaranteed_service": false,
; "estimated_delivery_date": "2019-09-21T00:00:00Z",
; "carrier_delivery_days": "3",
; "ship_date": "2019-09-18T00:00:00Z",
; "negotiated_rate": false,
; "service_type": "FedEx Ground®",
; "service_code": "fedex_ground",
; "trackable": true,
; "carrier_code": "fedex",
; "carrier_nickname": "ShipEngine Test Account - FedEx",
; "carrier_friendly_name": "FedEx",
; "validation_status": "valid",
; "warning_messages": [
; ],
; "error_messages": [
; ]
; }
; ],
; "invalid_rates": [
; ],
; "rate_request_id": "se-1437547",
; "shipment_id": "se-4160010",
; "created_at": "2019-09-18T16:07:21.3769021Z",
; "status": "completed",
; "errors": [
; ]
; },
; "shipment_id": "se-4160010",
; "carrier_id": null,
; "service_code": null,
; "external_shipment_id": null,
; "ship_date": "2019-09-18T00:00:00Z",
; "created_at": "2019-09-18T16:07:20.62Z",
; "modified_at": "2019-09-18T16:07:20.62Z",
; "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 $sRate_id
Local $sRate_type
Local $sV_Currency
Local $sAmount
Local $sInsurance_amountCurrency
Local $insurance_amountAmount
Local $sConfirmation_amountCurrency
Local $iConfirmation_amountAmount
Local $sOther_amountCurrency
Local $iOther_amountAmount
Local $sZone
Local $sPackage_type
Local $iDelivery_days
Local $bGuaranteed_service
Local $sEstimated_delivery_date
Local $sCarrier_delivery_days
Local $bNegotiated_rate
Local $service_type
Local $bTrackable
Local $sCarrier_code
Local $sCarrier_nickname
Local $sCarrier_friendly_name
Local $sValidation_status
Local $iJ
Local $iCount_j
Local $strVal
Local $sPackage_code
Local $iWeightValue
Local $sWeightUnit
Local $sDimensionsUnit
Local $iLength
Local $iWidth
Local $iHeight
Local $sInsured_valueCurrency
Local $insured_valueAmount
Local $sReference1
Local $sReference2
Local $sReference3
Local $sExternal_package_id
Local $sRate_request_id = $oJResp.StringOf("rate_response.rate_request_id")
Local $sShipment_id = $oJResp.StringOf("rate_response.shipment_id")
Local $sCreated_at = $oJResp.StringOf("rate_response.created_at")
Local $sStatus = $oJResp.StringOf("rate_response.status")
Local $shipment_id = $oJResp.StringOf("shipment_id")
Local $sCarrier_id = $oJResp.StringOf("carrier_id")
Local $service_code = $oJResp.StringOf("service_code")
Local $sExternal_shipment_id = $oJResp.StringOf("external_shipment_id")
Local $ship_date = $oJResp.StringOf("ship_date")
Local $sCreated_at = $oJResp.StringOf("created_at")
Local $sModified_at = $oJResp.StringOf("modified_at")
Local $shipment_status = $oJResp.StringOf("shipment_status")
Local $sName = $oJResp.StringOf("ship_to.name")
Local $sPhone = $oJResp.StringOf("ship_to.phone")
Local $sCompany_name = $oJResp.StringOf("ship_to.company_name")
Local $sAddress_line1 = $oJResp.StringOf("ship_to.address_line1")
Local $sAddress_line2 = $oJResp.StringOf("ship_to.address_line2")
Local $sAddress_line3 = $oJResp.StringOf("ship_to.address_line3")
Local $sCity_locality = $oJResp.StringOf("ship_to.city_locality")
Local $sState_province = $oJResp.StringOf("ship_to.state_province")
Local $sPostal_code = $oJResp.StringOf("ship_to.postal_code")
Local $sCountry_code = $oJResp.StringOf("ship_to.country_code")
Local $sAddress_residential_indicator = $oJResp.StringOf("ship_to.address_residential_indicator")
Local $ship_fromName = $oJResp.StringOf("ship_from.name")
Local $ship_fromPhone = $oJResp.StringOf("ship_from.phone")
Local $ship_fromCompany_name = $oJResp.StringOf("ship_from.company_name")
Local $ship_fromAddress_line1 = $oJResp.StringOf("ship_from.address_line1")
Local $ship_fromAddress_line2 = $oJResp.StringOf("ship_from.address_line2")
Local $ship_fromAddress_line3 = $oJResp.StringOf("ship_from.address_line3")
Local $ship_fromCity_locality = $oJResp.StringOf("ship_from.city_locality")
Local $ship_fromState_province = $oJResp.StringOf("ship_from.state_province")
Local $ship_fromPostal_code = $oJResp.StringOf("ship_from.postal_code")
Local $ship_fromCountry_code = $oJResp.StringOf("ship_from.country_code")
Local $ship_fromAddress_residential_indicator = $oJResp.StringOf("ship_from.address_residential_indicator")
Local $sWarehouse_id = $oJResp.StringOf("warehouse_id")
Local $sReturn_toName = $oJResp.StringOf("return_to.name")
Local $sReturn_toPhone = $oJResp.StringOf("return_to.phone")
Local $sReturn_toCompany_name = $oJResp.StringOf("return_to.company_name")
Local $sReturn_toAddress_line1 = $oJResp.StringOf("return_to.address_line1")
Local $sReturn_toAddress_line2 = $oJResp.StringOf("return_to.address_line2")
Local $sReturn_toAddress_line3 = $oJResp.StringOf("return_to.address_line3")
Local $sReturn_toCity_locality = $oJResp.StringOf("return_to.city_locality")
Local $sReturn_toState_province = $oJResp.StringOf("return_to.state_province")
Local $sReturn_toPostal_code = $oJResp.StringOf("return_to.postal_code")
Local $sReturn_toCountry_code = $oJResp.StringOf("return_to.country_code")
Local $sReturn_toAddress_residential_indicator = $oJResp.StringOf("return_to.address_residential_indicator")
Local $sConfirmation = $oJResp.StringOf("confirmation")
Local $sCustoms = $oJResp.StringOf("customs")
Local $sExternal_order_id = $oJResp.StringOf("external_order_id")
Local $sOrder_source_code = $oJResp.StringOf("order_source_code")
Local $sBill_to_account = $oJResp.StringOf("advanced_options.bill_to_account")
Local $sBill_to_country_code = $oJResp.StringOf("advanced_options.bill_to_country_code")
Local $sBill_to_party = $oJResp.StringOf("advanced_options.bill_to_party")
Local $sBill_to_postal_code = $oJResp.StringOf("advanced_options.bill_to_postal_code")
Local $bContains_alcohol = $oJResp.BoolOf("advanced_options.contains_alcohol")
Local $bDelivered_duty_paid = $oJResp.BoolOf("advanced_options.delivered_duty_paid")
Local $bNon_machinable = $oJResp.BoolOf("advanced_options.non_machinable")
Local $bSaturday_delivery = $oJResp.BoolOf("advanced_options.saturday_delivery")
Local $bDry_ice = $oJResp.BoolOf("advanced_options.dry_ice")
Local $sDry_ice_weight = $oJResp.StringOf("advanced_options.dry_ice_weight")
Local $sFreight_class = $oJResp.StringOf("advanced_options.freight_class")
Local $sCustom_field1 = $oJResp.StringOf("advanced_options.custom_field1")
Local $sCustom_field2 = $oJResp.StringOf("advanced_options.custom_field2")
Local $sCustom_field3 = $oJResp.StringOf("advanced_options.custom_field3")
Local $sInsurance_provider = $oJResp.StringOf("insurance_provider")
Local $iValue = $oJResp.IntOf("total_weight.value")
Local $sUnit = $oJResp.StringOf("total_weight.unit")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("rate_response.rates")
While $i < $iCount_i
$oJResp.I = $i
$sRate_id = $oJResp.StringOf("rate_response.rates[i].rate_id")
$sRate_type = $oJResp.StringOf("rate_response.rates[i].rate_type")
$sCarrier_id = $oJResp.StringOf("rate_response.rates[i].carrier_id")
$sV_Currency = $oJResp.StringOf("rate_response.rates[i].shipping_amount.currency")
$sAmount = $oJResp.StringOf("rate_response.rates[i].shipping_amount.amount")
$sInsurance_amountCurrency = $oJResp.StringOf("rate_response.rates[i].insurance_amount.currency")
$insurance_amountAmount = $oJResp.IntOf("rate_response.rates[i].insurance_amount.amount")
$sConfirmation_amountCurrency = $oJResp.StringOf("rate_response.rates[i].confirmation_amount.currency")
$iConfirmation_amountAmount = $oJResp.IntOf("rate_response.rates[i].confirmation_amount.amount")
$sOther_amountCurrency = $oJResp.StringOf("rate_response.rates[i].other_amount.currency")
$iOther_amountAmount = $oJResp.IntOf("rate_response.rates[i].other_amount.amount")
$sZone = $oJResp.StringOf("rate_response.rates[i].zone")
$sPackage_type = $oJResp.StringOf("rate_response.rates[i].package_type")
$iDelivery_days = $oJResp.IntOf("rate_response.rates[i].delivery_days")
$bGuaranteed_service = $oJResp.BoolOf("rate_response.rates[i].guaranteed_service")
$sEstimated_delivery_date = $oJResp.StringOf("rate_response.rates[i].estimated_delivery_date")
$sCarrier_delivery_days = $oJResp.StringOf("rate_response.rates[i].carrier_delivery_days")
$ship_date = $oJResp.StringOf("rate_response.rates[i].ship_date")
$bNegotiated_rate = $oJResp.BoolOf("rate_response.rates[i].negotiated_rate")
$service_type = $oJResp.StringOf("rate_response.rates[i].service_type")
$service_code = $oJResp.StringOf("rate_response.rates[i].service_code")
$bTrackable = $oJResp.BoolOf("rate_response.rates[i].trackable")
$sCarrier_code = $oJResp.StringOf("rate_response.rates[i].carrier_code")
$sCarrier_nickname = $oJResp.StringOf("rate_response.rates[i].carrier_nickname")
$sCarrier_friendly_name = $oJResp.StringOf("rate_response.rates[i].carrier_friendly_name")
$sValidation_status = $oJResp.StringOf("rate_response.rates[i].validation_status")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("rate_response.rates[i].warning_messages")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("rate_response.rates[i].warning_messages[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("rate_response.rates[i].error_messages")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("rate_response.invalid_rates")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("rate_response.errors")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("tags")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("packages")
While $i < $iCount_i
$oJResp.I = $i
$sPackage_code = $oJResp.StringOf("packages[i].package_code")
$iWeightValue = $oJResp.IntOf("packages[i].weight.value")
$sWeightUnit = $oJResp.StringOf("packages[i].weight.unit")
$sDimensionsUnit = $oJResp.StringOf("packages[i].dimensions.unit")
$iLength = $oJResp.IntOf("packages[i].dimensions.length")
$iWidth = $oJResp.IntOf("packages[i].dimensions.width")
$iHeight = $oJResp.IntOf("packages[i].dimensions.height")
$sInsured_valueCurrency = $oJResp.StringOf("packages[i].insured_value.currency")
$insured_valueAmount = $oJResp.IntOf("packages[i].insured_value.amount")
$sReference1 = $oJResp.StringOf("packages[i].label_messages.reference1")
$sReference2 = $oJResp.StringOf("packages[i].label_messages.reference2")
$sReference3 = $oJResp.StringOf("packages[i].label_messages.reference3")
$sExternal_package_id = $oJResp.StringOf("packages[i].external_package_id")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("items")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"rate_options": {
"carrier_ids": [
"{{stamps_com}}",
"{{fedex}}",
"{{ups}}"
],
"service_codes": [
"usps_priority_mail",
"fedex_ground",
"ups_ground"
]
},
"shipment": {
"validate_address": "validate_and_clean",
"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/rates
Postman Collection Item JSON
{
"name": "Validate when getting rates",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response.rate_response.rates.length > 0) {",
" pm.collectionVariables.set(\"shipment_id\", response.shipment_id);",
" pm.collectionVariables.set(\"rate_id\", response.rate_response.rates[0].rate_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\"rate_options\": {\n\t\t\"carrier_ids\": [\n\t\t\t\"{{stamps_com}}\",\n\t\t\t\"{{fedex}}\",\n\t\t\t\"{{ups}}\"\n\t\t],\n\t\t\"service_codes\": [\n\t\t\t\"usps_priority_mail\",\n\t\t\t\"fedex_ground\",\n\t\t\t\"ups_ground\"\n\t\t]\n\t},\n\t\"shipment\": {\n\t\t\"validate_address\": \"validate_and_clean\",\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/rates",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"rates"
]
},
"description": "You can choose to validate the address as part of the rate request, which will help ensure that you get back the most accurate rates possible. Just set the `validate_address` field to either `validate_only` or `validate_and_clean`."
},
"response": [
{
"name": "Validate when getting rates",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"rate_options\": {\n\t\t\"carrier_ids\": [\n\t\t\t\"{{stamps_com}}\",\n\t\t\t\"{{fedex}}\",\n\t\t\t\"{{ups}}\"\n\t\t],\n\t\t\"service_codes\": [\n\t\t\t\"usps_priority_mail\",\n\t\t\t\"fedex_ground\",\n\t\t\t\"ups_ground\"\n\t\t]\n\t},\n\t\"shipment\": {\n\t\t\"validate_address\": \"validate_and_clean\",\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/rates",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"rates"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 16:07:21 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "13927"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "866b2c8a-744b-425a-8bb8-92c1eb15e01b"
}
],
"cookie": [
],
"body": "{\n \"rate_response\": {\n \"rates\": [\n {\n \"rate_id\": \"se-12502689\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121862\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 65.58\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": null,\n \"package_type\": null,\n \"delivery_days\": 4,\n \"guaranteed_service\": true,\n \"estimated_delivery_date\": \"2019-09-24T23:00:00Z\",\n \"carrier_delivery_days\": \"Tuesday 9/24 by 11:00 PM\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"UPS® Ground\",\n \"service_code\": \"ups_ground\",\n \"trackable\": true,\n \"carrier_code\": \"ups\",\n \"carrier_nickname\": \"ShipEngine Test Account - UPS\",\n \"carrier_friendly_name\": \"UPS\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502690\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121861\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 98.14\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": 7,\n \"package_type\": \"package\",\n \"delivery_days\": 2,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"USPS Priority Mail\",\n \"service_code\": \"usps_priority_mail\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"carrier_friendly_name\": \"Stamps.com\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502691\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121861\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 12.72\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": 7,\n \"package_type\": \"medium_flat_rate_box\",\n \"delivery_days\": 2,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"USPS Priority Mail\",\n \"service_code\": \"usps_priority_mail\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"carrier_friendly_name\": \"Stamps.com\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502692\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121861\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 6.98\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": 7,\n \"package_type\": \"small_flat_rate_box\",\n \"delivery_days\": 2,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"USPS Priority Mail\",\n \"service_code\": \"usps_priority_mail\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"carrier_friendly_name\": \"Stamps.com\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502693\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121861\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 17.47\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": 7,\n \"package_type\": \"large_flat_rate_box\",\n \"delivery_days\": 2,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"USPS Priority Mail\",\n \"service_code\": \"usps_priority_mail\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"carrier_friendly_name\": \"Stamps.com\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502694\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121861\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 6.48\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": 7,\n \"package_type\": \"flat_rate_envelope\",\n \"delivery_days\": 2,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"USPS Priority Mail\",\n \"service_code\": \"usps_priority_mail\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"carrier_friendly_name\": \"Stamps.com\",\n \"validation_status\": \"has_warnings\",\n \"warning_messages\": [\n \"Heads up! You've included custom dimensions for a package type with a standardized size. For more accurate rates, consider removing the dimensions for this shipment.\"\n ],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502695\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121861\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 7.03\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": 7,\n \"package_type\": \"flat_rate_padded_envelope\",\n \"delivery_days\": 2,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"USPS Priority Mail\",\n \"service_code\": \"usps_priority_mail\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"carrier_friendly_name\": \"Stamps.com\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502696\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121861\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 6.78\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"zone\": 7,\n \"package_type\": \"flat_rate_legal_envelope\",\n \"delivery_days\": 2,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-20T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"USPS Priority Mail\",\n \"service_code\": \"usps_priority_mail\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"carrier_nickname\": \"ShipEngine Test Account - Stamps.com\",\n \"carrier_friendly_name\": \"Stamps.com\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n },\n {\n \"rate_id\": \"se-12502697\",\n \"rate_type\": \"shipment\",\n \"carrier_id\": \"se-121863\",\n \"shipping_amount\": {\n \"currency\": \"usd\",\n \"amount\": 58.37\n },\n \"insurance_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"confirmation_amount\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"other_amount\": {\n \"currency\": \"usd\",\n \"amount\": 4.09\n },\n \"zone\": null,\n \"package_type\": null,\n \"delivery_days\": 3,\n \"guaranteed_service\": false,\n \"estimated_delivery_date\": \"2019-09-21T00:00:00Z\",\n \"carrier_delivery_days\": \"3\",\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"negotiated_rate\": false,\n \"service_type\": \"FedEx Ground®\",\n \"service_code\": \"fedex_ground\",\n \"trackable\": true,\n \"carrier_code\": \"fedex\",\n \"carrier_nickname\": \"ShipEngine Test Account - FedEx\",\n \"carrier_friendly_name\": \"FedEx\",\n \"validation_status\": \"valid\",\n \"warning_messages\": [],\n \"error_messages\": []\n }\n ],\n \"invalid_rates\": [],\n \"rate_request_id\": \"se-1437547\",\n \"shipment_id\": \"se-4160010\",\n \"created_at\": \"2019-09-18T16:07:21.3769021Z\",\n \"status\": \"completed\",\n \"errors\": []\n },\n \"shipment_id\": \"se-4160010\",\n \"carrier_id\": null,\n \"service_code\": null,\n \"external_shipment_id\": null,\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"created_at\": \"2019-09-18T16:07:20.62Z\",\n \"modified_at\": \"2019-09-18T16:07:20.62Z\",\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}"
}
]
}
