Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
' 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}}"
' }
Dim json As New ChilkatJsonObject
success = json.UpdateString("rate_options.carrier_ids[0]","{{stamps_com}}")
success = json.UpdateString("rate_options.carrier_ids[1]","{{fedex}}")
success = json.UpdateString("rate_options.carrier_ids[2]","{{ups}}")
success = json.UpdateString("rate_options.service_codes[0]","usps_priority_mail")
success = json.UpdateString("rate_options.service_codes[1]","fedex_ground")
success = json.UpdateString("rate_options.service_codes[2]","ups_ground")
success = json.UpdateString("shipment_id","{{shipment_id}}")
http.SetRequestHeader "API-Key","{{API_KEY}}"
http.SetRequestHeader "Content-Type","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://api.shipengine.com/v1/rates","application/json",json)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim rate_id As String
Dim rate_type As String
Dim v_Currency As String
Dim Amount As String
Dim insurance_amountCurrency As String
Dim insurance_amountAmount As Long
Dim confirmation_amountCurrency As String
Dim confirmation_amountAmount As Long
Dim other_amountCurrency As String
Dim other_amountAmount As Long
Dim zone As String
Dim package_type As String
Dim delivery_days As Long
Dim guaranteed_service As Long
Dim estimated_delivery_date As String
Dim carrier_delivery_days As String
Dim negotiated_rate As Long
Dim service_type As String
Dim trackable As Long
Dim carrier_code As String
Dim carrier_nickname As String
Dim carrier_friendly_name As String
Dim validation_status As String
Dim j As Long
Dim count_j As Long
Dim strVal As String
Dim package_code As String
Dim weightValue As Long
Dim weightUnit As String
Dim dimensionsUnit As String
Dim Length As Long
Dim Width As Long
Dim Height As Long
Dim insured_valueCurrency As String
Dim insured_valueAmount As Long
Dim Reference1 As String
Dim Reference2 As String
Dim Reference3 As String
Dim external_package_id As String
Dim Rate_request_id As String
Rate_request_id = jResp.StringOf("rate_response.rate_request_id")
Dim Shipment_id As String
Shipment_id = jResp.StringOf("rate_response.shipment_id")
Dim Created_at As String
Created_at = jResp.StringOf("rate_response.created_at")
Dim Status As String
Status = jResp.StringOf("rate_response.status")
Dim shipment_id As String
shipment_id = jResp.StringOf("shipment_id")
Dim carrier_id As String
carrier_id = jResp.StringOf("carrier_id")
Dim service_code As String
service_code = jResp.StringOf("service_code")
Dim external_shipment_id As String
external_shipment_id = jResp.StringOf("external_shipment_id")
Dim ship_date As String
ship_date = jResp.StringOf("ship_date")
Dim created_at As String
created_at = jResp.StringOf("created_at")
Dim modified_at As String
modified_at = jResp.StringOf("modified_at")
Dim shipment_status As String
shipment_status = jResp.StringOf("shipment_status")
Dim Name As String
Name = jResp.StringOf("ship_to.name")
Dim Phone As String
Phone = jResp.StringOf("ship_to.phone")
Dim Company_name As String
Company_name = jResp.StringOf("ship_to.company_name")
Dim Address_line1 As String
Address_line1 = jResp.StringOf("ship_to.address_line1")
Dim Address_line2 As String
Address_line2 = jResp.StringOf("ship_to.address_line2")
Dim Address_line3 As String
Address_line3 = jResp.StringOf("ship_to.address_line3")
Dim City_locality As String
City_locality = jResp.StringOf("ship_to.city_locality")
Dim State_province As String
State_province = jResp.StringOf("ship_to.state_province")
Dim Postal_code As String
Postal_code = jResp.StringOf("ship_to.postal_code")
Dim Country_code As String
Country_code = jResp.StringOf("ship_to.country_code")
Dim Address_residential_indicator As String
Address_residential_indicator = jResp.StringOf("ship_to.address_residential_indicator")
Dim ship_fromName As String
ship_fromName = jResp.StringOf("ship_from.name")
Dim ship_fromPhone As String
ship_fromPhone = jResp.StringOf("ship_from.phone")
Dim ship_fromCompany_name As String
ship_fromCompany_name = jResp.StringOf("ship_from.company_name")
Dim ship_fromAddress_line1 As String
ship_fromAddress_line1 = jResp.StringOf("ship_from.address_line1")
Dim ship_fromAddress_line2 As String
ship_fromAddress_line2 = jResp.StringOf("ship_from.address_line2")
Dim ship_fromAddress_line3 As String
ship_fromAddress_line3 = jResp.StringOf("ship_from.address_line3")
Dim ship_fromCity_locality As String
ship_fromCity_locality = jResp.StringOf("ship_from.city_locality")
Dim ship_fromState_province As String
ship_fromState_province = jResp.StringOf("ship_from.state_province")
Dim ship_fromPostal_code As String
ship_fromPostal_code = jResp.StringOf("ship_from.postal_code")
Dim ship_fromCountry_code As String
ship_fromCountry_code = jResp.StringOf("ship_from.country_code")
Dim ship_fromAddress_residential_indicator As String
ship_fromAddress_residential_indicator = jResp.StringOf("ship_from.address_residential_indicator")
Dim warehouse_id As String
warehouse_id = jResp.StringOf("warehouse_id")
Dim return_toName As String
return_toName = jResp.StringOf("return_to.name")
Dim return_toPhone As String
return_toPhone = jResp.StringOf("return_to.phone")
Dim return_toCompany_name As String
return_toCompany_name = jResp.StringOf("return_to.company_name")
Dim return_toAddress_line1 As String
return_toAddress_line1 = jResp.StringOf("return_to.address_line1")
Dim return_toAddress_line2 As String
return_toAddress_line2 = jResp.StringOf("return_to.address_line2")
Dim return_toAddress_line3 As String
return_toAddress_line3 = jResp.StringOf("return_to.address_line3")
Dim return_toCity_locality As String
return_toCity_locality = jResp.StringOf("return_to.city_locality")
Dim return_toState_province As String
return_toState_province = jResp.StringOf("return_to.state_province")
Dim return_toPostal_code As String
return_toPostal_code = jResp.StringOf("return_to.postal_code")
Dim return_toCountry_code As String
return_toCountry_code = jResp.StringOf("return_to.country_code")
Dim return_toAddress_residential_indicator As String
return_toAddress_residential_indicator = jResp.StringOf("return_to.address_residential_indicator")
Dim confirmation As String
confirmation = jResp.StringOf("confirmation")
Dim customs As String
customs = jResp.StringOf("customs")
Dim external_order_id As String
external_order_id = jResp.StringOf("external_order_id")
Dim order_source_code As String
order_source_code = jResp.StringOf("order_source_code")
Dim Bill_to_account As String
Bill_to_account = jResp.StringOf("advanced_options.bill_to_account")
Dim Bill_to_country_code As String
Bill_to_country_code = jResp.StringOf("advanced_options.bill_to_country_code")
Dim Bill_to_party As String
Bill_to_party = jResp.StringOf("advanced_options.bill_to_party")
Dim Bill_to_postal_code As String
Bill_to_postal_code = jResp.StringOf("advanced_options.bill_to_postal_code")
Dim Contains_alcohol As Long
Contains_alcohol = jResp.BoolOf("advanced_options.contains_alcohol")
Dim Delivered_duty_paid As Long
Delivered_duty_paid = jResp.BoolOf("advanced_options.delivered_duty_paid")
Dim Non_machinable As Long
Non_machinable = jResp.BoolOf("advanced_options.non_machinable")
Dim Saturday_delivery As Long
Saturday_delivery = jResp.BoolOf("advanced_options.saturday_delivery")
Dim Dry_ice As Long
Dry_ice = jResp.BoolOf("advanced_options.dry_ice")
Dim Dry_ice_weight As String
Dry_ice_weight = jResp.StringOf("advanced_options.dry_ice_weight")
Dim Freight_class As String
Freight_class = jResp.StringOf("advanced_options.freight_class")
Dim Custom_field1 As String
Custom_field1 = jResp.StringOf("advanced_options.custom_field1")
Dim Custom_field2 As String
Custom_field2 = jResp.StringOf("advanced_options.custom_field2")
Dim Custom_field3 As String
Custom_field3 = jResp.StringOf("advanced_options.custom_field3")
Dim insurance_provider As String
insurance_provider = jResp.StringOf("insurance_provider")
Dim Value As Long
Value = jResp.IntOf("total_weight.value")
Dim Unit As String
Unit = jResp.StringOf("total_weight.unit")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("rate_response.rates")
Do While i < count_i
jResp.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")
Do While j < count_j
jResp.J = j
strVal = jResp.StringOf("rate_response.rates[i].warning_messages[j]")
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("rate_response.rates[i].error_messages")
Do While j < count_j
jResp.J = j
j = j + 1
Loop
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("rate_response.invalid_rates")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("rate_response.errors")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("tags")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("packages")
Do While i < count_i
jResp.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
Loop
i = 0
count_i = jResp.SizeOfArray("items")
Do While i < count_i
jResp.I = i
i = i + 1
Loop
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}"
}
]
}
