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.
# {
# "rate_options": {
# "carrier_ids": [
# "{{stamps_com}}",
# "{{fedex}}",
# "{{ups}}"
# ],
# "service_codes": [
# "usps_priority_mail",
# "fedex_ground",
# "ups_ground"
# ]
# },
# "shipment_id": "{{shipment_id}}"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "rate_options.carrier_ids[0]" "{{stamps_com}}"
CkJsonObject_UpdateString $json "rate_options.carrier_ids[1]" "{{fedex}}"
CkJsonObject_UpdateString $json "rate_options.carrier_ids[2]" "{{ups}}"
CkJsonObject_UpdateString $json "rate_options.service_codes[0]" "usps_priority_mail"
CkJsonObject_UpdateString $json "rate_options.service_codes[1]" "fedex_ground"
CkJsonObject_UpdateString $json "rate_options.service_codes[2]" "ups_ground"
CkJsonObject_UpdateString $json "shipment_id" "{{shipment_id}}"
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/rates" "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)
# {
# "rate_response": {
# "rates": [
# {
# "rate_id": "se-12444425",
# "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-23T23:00:00Z",
# "carrier_delivery_days": "Monday 9/23 by 11:00 PM",
# "ship_date": "2019-09-17T00: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-12444426",
# "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-19T00:00:00Z",
# "carrier_delivery_days": "2",
# "ship_date": "2019-09-17T00: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-12444427",
# "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-19T00:00:00Z",
# "carrier_delivery_days": "2",
# "ship_date": "2019-09-17T00: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-12444428",
# "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-19T00:00:00Z",
# "carrier_delivery_days": "2",
# "ship_date": "2019-09-17T00: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-12444429",
# "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-19T00:00:00Z",
# "carrier_delivery_days": "2",
# "ship_date": "2019-09-17T00: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-12444430",
# "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-19T00:00:00Z",
# "carrier_delivery_days": "2",
# "ship_date": "2019-09-17T00: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-12444431",
# "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-19T00:00:00Z",
# "carrier_delivery_days": "2",
# "ship_date": "2019-09-17T00: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-12444432",
# "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-19T00:00:00Z",
# "carrier_delivery_days": "2",
# "ship_date": "2019-09-17T00: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-12444433",
# "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-20T00:00:00Z",
# "carrier_delivery_days": "3",
# "ship_date": "2019-09-17T00: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-1426242",
# "shipment_id": "se-4134271",
# "created_at": "2019-09-17T18:33:10.7692662Z",
# "status": "completed",
# "errors": [
# ]
# },
# "shipment_id": "se-4134271",
# "carrier_id": null,
# "service_code": null,
# "external_shipment_id": null,
# "ship_date": "2019-09-17T00:00:00Z",
# "created_at": "2019-09-17T18:31:35.03Z",
# "modified_at": "2019-09-17T18:31:35.03Z",
# "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": null,
# "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": null,
# "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
set Rate_request_id [CkJsonObject_stringOf $jResp "rate_response.rate_request_id"]
set Shipment_id [CkJsonObject_stringOf $jResp "rate_response.shipment_id"]
set Created_at [CkJsonObject_stringOf $jResp "rate_response.created_at"]
set Status [CkJsonObject_stringOf $jResp "rate_response.status"]
set shipment_id [CkJsonObject_stringOf $jResp "shipment_id"]
set carrier_id [CkJsonObject_stringOf $jResp "carrier_id"]
set service_code [CkJsonObject_stringOf $jResp "service_code"]
set external_shipment_id [CkJsonObject_stringOf $jResp "external_shipment_id"]
set ship_date [CkJsonObject_stringOf $jResp "ship_date"]
set created_at [CkJsonObject_stringOf $jResp "created_at"]
set modified_at [CkJsonObject_stringOf $jResp "modified_at"]
set shipment_status [CkJsonObject_stringOf $jResp "shipment_status"]
set Name [CkJsonObject_stringOf $jResp "ship_to.name"]
set Phone [CkJsonObject_stringOf $jResp "ship_to.phone"]
set Company_name [CkJsonObject_stringOf $jResp "ship_to.company_name"]
set Address_line1 [CkJsonObject_stringOf $jResp "ship_to.address_line1"]
set Address_line2 [CkJsonObject_stringOf $jResp "ship_to.address_line2"]
set Address_line3 [CkJsonObject_stringOf $jResp "ship_to.address_line3"]
set City_locality [CkJsonObject_stringOf $jResp "ship_to.city_locality"]
set State_province [CkJsonObject_stringOf $jResp "ship_to.state_province"]
set Postal_code [CkJsonObject_stringOf $jResp "ship_to.postal_code"]
set Country_code [CkJsonObject_stringOf $jResp "ship_to.country_code"]
set Address_residential_indicator [CkJsonObject_stringOf $jResp "ship_to.address_residential_indicator"]
set ship_fromName [CkJsonObject_stringOf $jResp "ship_from.name"]
set ship_fromPhone [CkJsonObject_stringOf $jResp "ship_from.phone"]
set ship_fromCompany_name [CkJsonObject_stringOf $jResp "ship_from.company_name"]
set ship_fromAddress_line1 [CkJsonObject_stringOf $jResp "ship_from.address_line1"]
set ship_fromAddress_line2 [CkJsonObject_stringOf $jResp "ship_from.address_line2"]
set ship_fromAddress_line3 [CkJsonObject_stringOf $jResp "ship_from.address_line3"]
set ship_fromCity_locality [CkJsonObject_stringOf $jResp "ship_from.city_locality"]
set ship_fromState_province [CkJsonObject_stringOf $jResp "ship_from.state_province"]
set ship_fromPostal_code [CkJsonObject_stringOf $jResp "ship_from.postal_code"]
set ship_fromCountry_code [CkJsonObject_stringOf $jResp "ship_from.country_code"]
set ship_fromAddress_residential_indicator [CkJsonObject_stringOf $jResp "ship_from.address_residential_indicator"]
set warehouse_id [CkJsonObject_stringOf $jResp "warehouse_id"]
set return_toName [CkJsonObject_stringOf $jResp "return_to.name"]
set return_toPhone [CkJsonObject_stringOf $jResp "return_to.phone"]
set return_toCompany_name [CkJsonObject_stringOf $jResp "return_to.company_name"]
set return_toAddress_line1 [CkJsonObject_stringOf $jResp "return_to.address_line1"]
set return_toAddress_line2 [CkJsonObject_stringOf $jResp "return_to.address_line2"]
set return_toAddress_line3 [CkJsonObject_stringOf $jResp "return_to.address_line3"]
set return_toCity_locality [CkJsonObject_stringOf $jResp "return_to.city_locality"]
set return_toState_province [CkJsonObject_stringOf $jResp "return_to.state_province"]
set return_toPostal_code [CkJsonObject_stringOf $jResp "return_to.postal_code"]
set return_toCountry_code [CkJsonObject_stringOf $jResp "return_to.country_code"]
set return_toAddress_residential_indicator [CkJsonObject_stringOf $jResp "return_to.address_residential_indicator"]
set confirmation [CkJsonObject_stringOf $jResp "confirmation"]
set customs [CkJsonObject_stringOf $jResp "customs"]
set external_order_id [CkJsonObject_stringOf $jResp "external_order_id"]
set order_source_code [CkJsonObject_stringOf $jResp "order_source_code"]
set Bill_to_account [CkJsonObject_stringOf $jResp "advanced_options.bill_to_account"]
set Bill_to_country_code [CkJsonObject_stringOf $jResp "advanced_options.bill_to_country_code"]
set Bill_to_party [CkJsonObject_stringOf $jResp "advanced_options.bill_to_party"]
set Bill_to_postal_code [CkJsonObject_stringOf $jResp "advanced_options.bill_to_postal_code"]
set Contains_alcohol [CkJsonObject_BoolOf $jResp "advanced_options.contains_alcohol"]
set Delivered_duty_paid [CkJsonObject_BoolOf $jResp "advanced_options.delivered_duty_paid"]
set Non_machinable [CkJsonObject_BoolOf $jResp "advanced_options.non_machinable"]
set Saturday_delivery [CkJsonObject_BoolOf $jResp "advanced_options.saturday_delivery"]
set Dry_ice [CkJsonObject_BoolOf $jResp "advanced_options.dry_ice"]
set Dry_ice_weight [CkJsonObject_stringOf $jResp "advanced_options.dry_ice_weight"]
set Freight_class [CkJsonObject_stringOf $jResp "advanced_options.freight_class"]
set Custom_field1 [CkJsonObject_stringOf $jResp "advanced_options.custom_field1"]
set Custom_field2 [CkJsonObject_stringOf $jResp "advanced_options.custom_field2"]
set Custom_field3 [CkJsonObject_stringOf $jResp "advanced_options.custom_field3"]
set insurance_provider [CkJsonObject_stringOf $jResp "insurance_provider"]
set Value [CkJsonObject_IntOf $jResp "total_weight.value"]
set Unit [CkJsonObject_stringOf $jResp "total_weight.unit"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "rate_response.rates"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set rate_id [CkJsonObject_stringOf $jResp "rate_response.rates[i].rate_id"]
set rate_type [CkJsonObject_stringOf $jResp "rate_response.rates[i].rate_type"]
set carrier_id [CkJsonObject_stringOf $jResp "rate_response.rates[i].carrier_id"]
set v_Currency [CkJsonObject_stringOf $jResp "rate_response.rates[i].shipping_amount.currency"]
set Amount [CkJsonObject_stringOf $jResp "rate_response.rates[i].shipping_amount.amount"]
set insurance_amountCurrency [CkJsonObject_stringOf $jResp "rate_response.rates[i].insurance_amount.currency"]
set insurance_amountAmount [CkJsonObject_IntOf $jResp "rate_response.rates[i].insurance_amount.amount"]
set confirmation_amountCurrency [CkJsonObject_stringOf $jResp "rate_response.rates[i].confirmation_amount.currency"]
set confirmation_amountAmount [CkJsonObject_IntOf $jResp "rate_response.rates[i].confirmation_amount.amount"]
set other_amountCurrency [CkJsonObject_stringOf $jResp "rate_response.rates[i].other_amount.currency"]
set other_amountAmount [CkJsonObject_IntOf $jResp "rate_response.rates[i].other_amount.amount"]
set zone [CkJsonObject_stringOf $jResp "rate_response.rates[i].zone"]
set package_type [CkJsonObject_stringOf $jResp "rate_response.rates[i].package_type"]
set delivery_days [CkJsonObject_IntOf $jResp "rate_response.rates[i].delivery_days"]
set guaranteed_service [CkJsonObject_BoolOf $jResp "rate_response.rates[i].guaranteed_service"]
set estimated_delivery_date [CkJsonObject_stringOf $jResp "rate_response.rates[i].estimated_delivery_date"]
set carrier_delivery_days [CkJsonObject_stringOf $jResp "rate_response.rates[i].carrier_delivery_days"]
set ship_date [CkJsonObject_stringOf $jResp "rate_response.rates[i].ship_date"]
set negotiated_rate [CkJsonObject_BoolOf $jResp "rate_response.rates[i].negotiated_rate"]
set service_type [CkJsonObject_stringOf $jResp "rate_response.rates[i].service_type"]
set service_code [CkJsonObject_stringOf $jResp "rate_response.rates[i].service_code"]
set trackable [CkJsonObject_BoolOf $jResp "rate_response.rates[i].trackable"]
set carrier_code [CkJsonObject_stringOf $jResp "rate_response.rates[i].carrier_code"]
set carrier_nickname [CkJsonObject_stringOf $jResp "rate_response.rates[i].carrier_nickname"]
set carrier_friendly_name [CkJsonObject_stringOf $jResp "rate_response.rates[i].carrier_friendly_name"]
set validation_status [CkJsonObject_stringOf $jResp "rate_response.rates[i].validation_status"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "rate_response.rates[i].warning_messages"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "rate_response.rates[i].warning_messages[j]"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "rate_response.rates[i].error_messages"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "rate_response.invalid_rates"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "rate_response.errors"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "tags"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "packages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set package_code [CkJsonObject_stringOf $jResp "packages[i].package_code"]
set weightValue [CkJsonObject_IntOf $jResp "packages[i].weight.value"]
set weightUnit [CkJsonObject_stringOf $jResp "packages[i].weight.unit"]
set dimensionsUnit [CkJsonObject_stringOf $jResp "packages[i].dimensions.unit"]
set Length [CkJsonObject_IntOf $jResp "packages[i].dimensions.length"]
set Width [CkJsonObject_IntOf $jResp "packages[i].dimensions.width"]
set Height [CkJsonObject_IntOf $jResp "packages[i].dimensions.height"]
set insured_valueCurrency [CkJsonObject_stringOf $jResp "packages[i].insured_value.currency"]
set insured_valueAmount [CkJsonObject_IntOf $jResp "packages[i].insured_value.amount"]
set Reference1 [CkJsonObject_stringOf $jResp "packages[i].label_messages.reference1"]
set Reference2 [CkJsonObject_stringOf $jResp "packages[i].label_messages.reference2"]
set Reference3 [CkJsonObject_stringOf $jResp "packages[i].label_messages.reference3"]
set external_package_id [CkJsonObject_stringOf $jResp "packages[i].external_package_id"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "items"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
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 '{
"rate_options": {
"carrier_ids": [
"{{stamps_com}}",
"{{fedex}}",
"{{ups}}"
],
"service_codes": [
"usps_priority_mail",
"fedex_ground",
"ups_ground"
]
},
"shipment_id": "{{shipment_id}}"
}'
https://api.shipengine.com/v1/rates
Postman Collection Item JSON
{
"name": "Compare rates for a shipment",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response.rate_response.rates.length > 0) {",
" 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_id\": \"{{shipment_id}}\"\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/rates",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"rates"
]
},
"description": "If you've already created a shipment in ShipEngine, then you can easily compare rates using the `shipment_id`."
},
"response": [
{
"name": "Compare rates for a shipment",
"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_id\": \"{{shipment_id}}\"\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": "Tue, 17 Sep 2019 18:33:10 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "13899"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "5824483d-bb0d-4dfd-bb6c-86f657a87119"
}
],
"cookie": [
],
"body": "{\n \"rate_response\": {\n \"rates\": [\n {\n \"rate_id\": \"se-12444425\",\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-23T23:00:00Z\",\n \"carrier_delivery_days\": \"Monday 9/23 by 11:00 PM\",\n \"ship_date\": \"2019-09-17T00: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-12444426\",\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-19T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-17T00: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-12444427\",\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-19T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-17T00: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-12444428\",\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-19T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-17T00: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-12444429\",\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-19T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-17T00: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-12444430\",\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-19T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-17T00: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-12444431\",\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-19T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-17T00: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-12444432\",\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-19T00:00:00Z\",\n \"carrier_delivery_days\": \"2\",\n \"ship_date\": \"2019-09-17T00: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-12444433\",\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-20T00:00:00Z\",\n \"carrier_delivery_days\": \"3\",\n \"ship_date\": \"2019-09-17T00: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-1426242\",\n \"shipment_id\": \"se-4134271\",\n \"created_at\": \"2019-09-17T18:33:10.7692662Z\",\n \"status\": \"completed\",\n \"errors\": []\n },\n \"shipment_id\": \"se-4134271\",\n \"carrier_id\": null,\n \"service_code\": null,\n \"external_shipment_id\": null,\n \"ship_date\": \"2019-09-17T00:00:00Z\",\n \"created_at\": \"2019-09-17T18:31:35.03Z\",\n \"modified_at\": \"2019-09-17T18:31:35.03Z\",\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\": null,\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\": null,\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}"
}
]
}
