Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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": {
# "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 S Winchester Blvd",
# "city_locality": "San Jose",
# "state_province": "CA",
# "postal_code": "95128",
# "country_code": "US"
# },
# "packages": [
# {
# "weight": {
# "value": 17,
# "unit": "pound"
# },
# "dimensions": {
# "length": 36,
# "width": 12,
# "height": 24,
# "unit": "inch"
# }
# }
# ]
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("rate_options.carrier_ids[0]","{{stamps_com}}")
json.UpdateString("rate_options.carrier_ids[1]","{{fedex}}")
json.UpdateString("rate_options.carrier_ids[2]","{{ups}}")
json.UpdateString("rate_options.service_codes[0]","usps_priority_mail")
json.UpdateString("rate_options.service_codes[1]","fedex_ground")
json.UpdateString("rate_options.service_codes[2]","ups_ground")
json.UpdateString("shipment.ship_from.name","John Doe")
json.UpdateString("shipment.ship_from.company_name","Example Corp.")
json.UpdateString("shipment.ship_from.address_line1","4009 Marathon Blvd")
json.UpdateString("shipment.ship_from.city_locality","Austin")
json.UpdateString("shipment.ship_from.state_province","TX")
json.UpdateString("shipment.ship_from.postal_code","78756")
json.UpdateString("shipment.ship_from.country_code","US")
json.UpdateString("shipment.ship_from.phone","512-555-5555")
json.UpdateString("shipment.ship_to.name","Amanda Miller")
json.UpdateString("shipment.ship_to.address_line1","525 S Winchester Blvd")
json.UpdateString("shipment.ship_to.city_locality","San Jose")
json.UpdateString("shipment.ship_to.state_province","CA")
json.UpdateString("shipment.ship_to.postal_code","95128")
json.UpdateString("shipment.ship_to.country_code","US")
json.UpdateInt("shipment.packages[0].weight.value",17)
json.UpdateString("shipment.packages[0].weight.unit","pound")
json.UpdateInt("shipment.packages[0].dimensions.length",36)
json.UpdateInt("shipment.packages[0].dimensions.width",12)
json.UpdateInt("shipment.packages[0].dimensions.height",24)
json.UpdateString("shipment.packages[0].dimensions.unit","inch")
http.SetRequestHeader("API-Key","{{API_KEY}}")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.shipengine.com/v1/rates","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "rate_response": {
# "rates": [
# {
# "rate_id": "se-12443424",
# "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-12443425",
# "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-12443426",
# "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-12443427",
# "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-12443428",
# "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-12443429",
# "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-12443430",
# "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-12443431",
# "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-12443432",
# "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-1426058",
# "shipment_id": "se-4133871",
# "created_at": "2019-09-17T18:22:40.010591Z",
# "status": "completed",
# "errors": [
# ]
# },
# "shipment_id": "se-4133871",
# "carrier_id": null,
# "service_code": null,
# "external_shipment_id": null,
# "ship_date": "2019-09-17T00:00:00Z",
# "created_at": "2019-09-17T18:22:39.317Z",
# "modified_at": "2019-09-17T18:22:39.317Z",
# "shipment_status": "pending",
# "ship_to": {
# "name": "Amanda Miller",
# "phone": null,
# "company_name": null,
# "address_line1": "525 S Winchester Blvd",
# "address_line2": null,
# "address_line3": null,
# "city_locality": "San Jose",
# "state_province": "CA",
# "postal_code": "95128",
# "country_code": "US",
# "address_residential_indicator": "unknown"
# },
# "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
Rate_request_id = jResp.stringOf("rate_response.rate_request_id")
Shipment_id = jResp.stringOf("rate_response.shipment_id")
Created_at = jResp.stringOf("rate_response.created_at")
Status = jResp.stringOf("rate_response.status")
shipment_id = jResp.stringOf("shipment_id")
carrier_id = jResp.stringOf("carrier_id")
service_code = jResp.stringOf("service_code")
external_shipment_id = jResp.stringOf("external_shipment_id")
ship_date = jResp.stringOf("ship_date")
created_at = jResp.stringOf("created_at")
modified_at = jResp.stringOf("modified_at")
shipment_status = jResp.stringOf("shipment_status")
Name = jResp.stringOf("ship_to.name")
Phone = jResp.stringOf("ship_to.phone")
Company_name = jResp.stringOf("ship_to.company_name")
Address_line1 = jResp.stringOf("ship_to.address_line1")
Address_line2 = jResp.stringOf("ship_to.address_line2")
Address_line3 = jResp.stringOf("ship_to.address_line3")
City_locality = jResp.stringOf("ship_to.city_locality")
State_province = jResp.stringOf("ship_to.state_province")
Postal_code = jResp.stringOf("ship_to.postal_code")
Country_code = jResp.stringOf("ship_to.country_code")
Address_residential_indicator = jResp.stringOf("ship_to.address_residential_indicator")
ship_fromName = jResp.stringOf("ship_from.name")
ship_fromPhone = jResp.stringOf("ship_from.phone")
ship_fromCompany_name = jResp.stringOf("ship_from.company_name")
ship_fromAddress_line1 = jResp.stringOf("ship_from.address_line1")
ship_fromAddress_line2 = jResp.stringOf("ship_from.address_line2")
ship_fromAddress_line3 = jResp.stringOf("ship_from.address_line3")
ship_fromCity_locality = jResp.stringOf("ship_from.city_locality")
ship_fromState_province = jResp.stringOf("ship_from.state_province")
ship_fromPostal_code = jResp.stringOf("ship_from.postal_code")
ship_fromCountry_code = jResp.stringOf("ship_from.country_code")
ship_fromAddress_residential_indicator = jResp.stringOf("ship_from.address_residential_indicator")
warehouse_id = jResp.stringOf("warehouse_id")
return_toName = jResp.stringOf("return_to.name")
return_toPhone = jResp.stringOf("return_to.phone")
return_toCompany_name = jResp.stringOf("return_to.company_name")
return_toAddress_line1 = jResp.stringOf("return_to.address_line1")
return_toAddress_line2 = jResp.stringOf("return_to.address_line2")
return_toAddress_line3 = jResp.stringOf("return_to.address_line3")
return_toCity_locality = jResp.stringOf("return_to.city_locality")
return_toState_province = jResp.stringOf("return_to.state_province")
return_toPostal_code = jResp.stringOf("return_to.postal_code")
return_toCountry_code = jResp.stringOf("return_to.country_code")
return_toAddress_residential_indicator = jResp.stringOf("return_to.address_residential_indicator")
confirmation = jResp.stringOf("confirmation")
customs = jResp.stringOf("customs")
external_order_id = jResp.stringOf("external_order_id")
order_source_code = jResp.stringOf("order_source_code")
Bill_to_account = jResp.stringOf("advanced_options.bill_to_account")
Bill_to_country_code = jResp.stringOf("advanced_options.bill_to_country_code")
Bill_to_party = jResp.stringOf("advanced_options.bill_to_party")
Bill_to_postal_code = jResp.stringOf("advanced_options.bill_to_postal_code")
Contains_alcohol = jResp.BoolOf("advanced_options.contains_alcohol")
Delivered_duty_paid = jResp.BoolOf("advanced_options.delivered_duty_paid")
Non_machinable = jResp.BoolOf("advanced_options.non_machinable")
Saturday_delivery = jResp.BoolOf("advanced_options.saturday_delivery")
Dry_ice = jResp.BoolOf("advanced_options.dry_ice")
Dry_ice_weight = jResp.stringOf("advanced_options.dry_ice_weight")
Freight_class = jResp.stringOf("advanced_options.freight_class")
Custom_field1 = jResp.stringOf("advanced_options.custom_field1")
Custom_field2 = jResp.stringOf("advanced_options.custom_field2")
Custom_field3 = jResp.stringOf("advanced_options.custom_field3")
insurance_provider = jResp.stringOf("insurance_provider")
Value = jResp.IntOf("total_weight.value")
Unit = jResp.stringOf("total_weight.unit")
i = 0
count_i = jResp.SizeOfArray("rate_response.rates")
while i < count_i
jResp.put_I(i)
rate_id = jResp.stringOf("rate_response.rates[i].rate_id")
rate_type = jResp.stringOf("rate_response.rates[i].rate_type")
carrier_id = jResp.stringOf("rate_response.rates[i].carrier_id")
v_Currency = jResp.stringOf("rate_response.rates[i].shipping_amount.currency")
Amount = jResp.stringOf("rate_response.rates[i].shipping_amount.amount")
insurance_amountCurrency = jResp.stringOf("rate_response.rates[i].insurance_amount.currency")
insurance_amountAmount = jResp.IntOf("rate_response.rates[i].insurance_amount.amount")
confirmation_amountCurrency = jResp.stringOf("rate_response.rates[i].confirmation_amount.currency")
confirmation_amountAmount = jResp.IntOf("rate_response.rates[i].confirmation_amount.amount")
other_amountCurrency = jResp.stringOf("rate_response.rates[i].other_amount.currency")
other_amountAmount = jResp.IntOf("rate_response.rates[i].other_amount.amount")
zone = jResp.stringOf("rate_response.rates[i].zone")
package_type = jResp.stringOf("rate_response.rates[i].package_type")
delivery_days = jResp.IntOf("rate_response.rates[i].delivery_days")
guaranteed_service = jResp.BoolOf("rate_response.rates[i].guaranteed_service")
estimated_delivery_date = jResp.stringOf("rate_response.rates[i].estimated_delivery_date")
carrier_delivery_days = jResp.stringOf("rate_response.rates[i].carrier_delivery_days")
ship_date = jResp.stringOf("rate_response.rates[i].ship_date")
negotiated_rate = jResp.BoolOf("rate_response.rates[i].negotiated_rate")
service_type = jResp.stringOf("rate_response.rates[i].service_type")
service_code = jResp.stringOf("rate_response.rates[i].service_code")
trackable = jResp.BoolOf("rate_response.rates[i].trackable")
carrier_code = jResp.stringOf("rate_response.rates[i].carrier_code")
carrier_nickname = jResp.stringOf("rate_response.rates[i].carrier_nickname")
carrier_friendly_name = jResp.stringOf("rate_response.rates[i].carrier_friendly_name")
validation_status = jResp.stringOf("rate_response.rates[i].validation_status")
j = 0
count_j = jResp.SizeOfArray("rate_response.rates[i].warning_messages")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("rate_response.rates[i].warning_messages[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("rate_response.rates[i].error_messages")
while j < count_j
jResp.put_J(j)
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("rate_response.invalid_rates")
while i < count_i
jResp.put_I(i)
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("rate_response.errors")
while i < count_i
jResp.put_I(i)
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("tags")
while i < count_i
jResp.put_I(i)
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("packages")
while i < count_i
jResp.put_I(i)
package_code = jResp.stringOf("packages[i].package_code")
weightValue = jResp.IntOf("packages[i].weight.value")
weightUnit = jResp.stringOf("packages[i].weight.unit")
dimensionsUnit = jResp.stringOf("packages[i].dimensions.unit")
Length = jResp.IntOf("packages[i].dimensions.length")
Width = jResp.IntOf("packages[i].dimensions.width")
Height = jResp.IntOf("packages[i].dimensions.height")
insured_valueCurrency = jResp.stringOf("packages[i].insured_value.currency")
insured_valueAmount = jResp.IntOf("packages[i].insured_value.amount")
Reference1 = jResp.stringOf("packages[i].label_messages.reference1")
Reference2 = jResp.stringOf("packages[i].label_messages.reference2")
Reference3 = jResp.stringOf("packages[i].label_messages.reference3")
external_package_id = jResp.stringOf("packages[i].external_package_id")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("items")
while i < count_i
jResp.put_I(i)
i = i + 1
end
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": {
"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 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"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": "Compare 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\"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 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\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": "To compare rates across multiple carriers, provide the shipment details and the list of carriers that you want rates for."
},
"response": [
{
"name": "Compare 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\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\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 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\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": "Tue, 17 Sep 2019 18:22:39 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "13902"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "45382f31-26c3-4d15-9673-4bcde0ccd77d"
}
],
"cookie": [
],
"body": "{\n \"rate_response\": {\n \"rates\": [\n {\n \"rate_id\": \"se-12443424\",\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-12443425\",\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-12443426\",\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-12443427\",\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-12443428\",\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-12443429\",\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-12443430\",\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-12443431\",\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-12443432\",\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-1426058\",\n \"shipment_id\": \"se-4133871\",\n \"created_at\": \"2019-09-17T18:22:40.010591Z\",\n \"status\": \"completed\",\n \"errors\": []\n },\n \"shipment_id\": \"se-4133871\",\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:22:39.317Z\",\n \"modified_at\": \"2019-09-17T18:22:39.317Z\",\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\": null,\n \"address_line3\": null,\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\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}"
}
]
}
