Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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}}"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"rate_options.carrier_ids[0]","{{stamps_com}}")
CkJsonObject::ckUpdateString(json,"rate_options.carrier_ids[1]","{{fedex}}")
CkJsonObject::ckUpdateString(json,"rate_options.carrier_ids[2]","{{ups}}")
CkJsonObject::ckUpdateString(json,"rate_options.service_codes[0]","usps_priority_mail")
CkJsonObject::ckUpdateString(json,"rate_options.service_codes[1]","fedex_ground")
CkJsonObject::ckUpdateString(json,"rate_options.service_codes[2]","ups_ground")
CkJsonObject::ckUpdateString(json,"shipment_id","{{shipment_id}}")
CkHttp::ckSetRequestHeader(http,"API-Key","{{API_KEY}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.shipengine.com/v1/rates","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
rate_id.s
rate_type.s
v_Currency.s
Amount.s
insurance_amountCurrency.s
insurance_amountAmount.i
confirmation_amountCurrency.s
confirmation_amountAmount.i
other_amountCurrency.s
other_amountAmount.i
zone.s
package_type.s
delivery_days.i
guaranteed_service.i
estimated_delivery_date.s
carrier_delivery_days.s
negotiated_rate.i
service_type.s
trackable.i
carrier_code.s
carrier_nickname.s
carrier_friendly_name.s
validation_status.s
j.i
count_j.i
strVal.s
package_code.s
weightValue.i
weightUnit.s
dimensionsUnit.s
Length.i
Width.i
Height.i
insured_valueCurrency.s
insured_valueAmount.i
Reference1.s
Reference2.s
Reference3.s
external_package_id.s
Rate_request_id.s = CkJsonObject::ckStringOf(jResp,"rate_response.rate_request_id")
Shipment_id.s = CkJsonObject::ckStringOf(jResp,"rate_response.shipment_id")
Created_at.s = CkJsonObject::ckStringOf(jResp,"rate_response.created_at")
Status.s = CkJsonObject::ckStringOf(jResp,"rate_response.status")
shipment_id.s = CkJsonObject::ckStringOf(jResp,"shipment_id")
carrier_id.s = CkJsonObject::ckStringOf(jResp,"carrier_id")
service_code.s = CkJsonObject::ckStringOf(jResp,"service_code")
external_shipment_id.s = CkJsonObject::ckStringOf(jResp,"external_shipment_id")
ship_date.s = CkJsonObject::ckStringOf(jResp,"ship_date")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
modified_at.s = CkJsonObject::ckStringOf(jResp,"modified_at")
shipment_status.s = CkJsonObject::ckStringOf(jResp,"shipment_status")
Name.s = CkJsonObject::ckStringOf(jResp,"ship_to.name")
Phone.s = CkJsonObject::ckStringOf(jResp,"ship_to.phone")
Company_name.s = CkJsonObject::ckStringOf(jResp,"ship_to.company_name")
Address_line1.s = CkJsonObject::ckStringOf(jResp,"ship_to.address_line1")
Address_line2.s = CkJsonObject::ckStringOf(jResp,"ship_to.address_line2")
Address_line3.s = CkJsonObject::ckStringOf(jResp,"ship_to.address_line3")
City_locality.s = CkJsonObject::ckStringOf(jResp,"ship_to.city_locality")
State_province.s = CkJsonObject::ckStringOf(jResp,"ship_to.state_province")
Postal_code.s = CkJsonObject::ckStringOf(jResp,"ship_to.postal_code")
Country_code.s = CkJsonObject::ckStringOf(jResp,"ship_to.country_code")
Address_residential_indicator.s = CkJsonObject::ckStringOf(jResp,"ship_to.address_residential_indicator")
ship_fromName.s = CkJsonObject::ckStringOf(jResp,"ship_from.name")
ship_fromPhone.s = CkJsonObject::ckStringOf(jResp,"ship_from.phone")
ship_fromCompany_name.s = CkJsonObject::ckStringOf(jResp,"ship_from.company_name")
ship_fromAddress_line1.s = CkJsonObject::ckStringOf(jResp,"ship_from.address_line1")
ship_fromAddress_line2.s = CkJsonObject::ckStringOf(jResp,"ship_from.address_line2")
ship_fromAddress_line3.s = CkJsonObject::ckStringOf(jResp,"ship_from.address_line3")
ship_fromCity_locality.s = CkJsonObject::ckStringOf(jResp,"ship_from.city_locality")
ship_fromState_province.s = CkJsonObject::ckStringOf(jResp,"ship_from.state_province")
ship_fromPostal_code.s = CkJsonObject::ckStringOf(jResp,"ship_from.postal_code")
ship_fromCountry_code.s = CkJsonObject::ckStringOf(jResp,"ship_from.country_code")
ship_fromAddress_residential_indicator.s = CkJsonObject::ckStringOf(jResp,"ship_from.address_residential_indicator")
warehouse_id.s = CkJsonObject::ckStringOf(jResp,"warehouse_id")
return_toName.s = CkJsonObject::ckStringOf(jResp,"return_to.name")
return_toPhone.s = CkJsonObject::ckStringOf(jResp,"return_to.phone")
return_toCompany_name.s = CkJsonObject::ckStringOf(jResp,"return_to.company_name")
return_toAddress_line1.s = CkJsonObject::ckStringOf(jResp,"return_to.address_line1")
return_toAddress_line2.s = CkJsonObject::ckStringOf(jResp,"return_to.address_line2")
return_toAddress_line3.s = CkJsonObject::ckStringOf(jResp,"return_to.address_line3")
return_toCity_locality.s = CkJsonObject::ckStringOf(jResp,"return_to.city_locality")
return_toState_province.s = CkJsonObject::ckStringOf(jResp,"return_to.state_province")
return_toPostal_code.s = CkJsonObject::ckStringOf(jResp,"return_to.postal_code")
return_toCountry_code.s = CkJsonObject::ckStringOf(jResp,"return_to.country_code")
return_toAddress_residential_indicator.s = CkJsonObject::ckStringOf(jResp,"return_to.address_residential_indicator")
confirmation.s = CkJsonObject::ckStringOf(jResp,"confirmation")
customs.s = CkJsonObject::ckStringOf(jResp,"customs")
external_order_id.s = CkJsonObject::ckStringOf(jResp,"external_order_id")
order_source_code.s = CkJsonObject::ckStringOf(jResp,"order_source_code")
Bill_to_account.s = CkJsonObject::ckStringOf(jResp,"advanced_options.bill_to_account")
Bill_to_country_code.s = CkJsonObject::ckStringOf(jResp,"advanced_options.bill_to_country_code")
Bill_to_party.s = CkJsonObject::ckStringOf(jResp,"advanced_options.bill_to_party")
Bill_to_postal_code.s = CkJsonObject::ckStringOf(jResp,"advanced_options.bill_to_postal_code")
Contains_alcohol.i = CkJsonObject::ckBoolOf(jResp,"advanced_options.contains_alcohol")
Delivered_duty_paid.i = CkJsonObject::ckBoolOf(jResp,"advanced_options.delivered_duty_paid")
Non_machinable.i = CkJsonObject::ckBoolOf(jResp,"advanced_options.non_machinable")
Saturday_delivery.i = CkJsonObject::ckBoolOf(jResp,"advanced_options.saturday_delivery")
Dry_ice.i = CkJsonObject::ckBoolOf(jResp,"advanced_options.dry_ice")
Dry_ice_weight.s = CkJsonObject::ckStringOf(jResp,"advanced_options.dry_ice_weight")
Freight_class.s = CkJsonObject::ckStringOf(jResp,"advanced_options.freight_class")
Custom_field1.s = CkJsonObject::ckStringOf(jResp,"advanced_options.custom_field1")
Custom_field2.s = CkJsonObject::ckStringOf(jResp,"advanced_options.custom_field2")
Custom_field3.s = CkJsonObject::ckStringOf(jResp,"advanced_options.custom_field3")
insurance_provider.s = CkJsonObject::ckStringOf(jResp,"insurance_provider")
Value.i = CkJsonObject::ckIntOf(jResp,"total_weight.value")
Unit.s = CkJsonObject::ckStringOf(jResp,"total_weight.unit")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"rate_response.rates")
While i < count_i
CkJsonObject::setCkI(jResp, i)
rate_id = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].rate_id")
rate_type = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].rate_type")
carrier_id = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].carrier_id")
v_Currency = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].shipping_amount.currency")
Amount = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].shipping_amount.amount")
insurance_amountCurrency = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].insurance_amount.currency")
insurance_amountAmount = CkJsonObject::ckIntOf(jResp,"rate_response.rates[i].insurance_amount.amount")
confirmation_amountCurrency = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].confirmation_amount.currency")
confirmation_amountAmount = CkJsonObject::ckIntOf(jResp,"rate_response.rates[i].confirmation_amount.amount")
other_amountCurrency = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].other_amount.currency")
other_amountAmount = CkJsonObject::ckIntOf(jResp,"rate_response.rates[i].other_amount.amount")
zone = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].zone")
package_type = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].package_type")
delivery_days = CkJsonObject::ckIntOf(jResp,"rate_response.rates[i].delivery_days")
guaranteed_service = CkJsonObject::ckBoolOf(jResp,"rate_response.rates[i].guaranteed_service")
estimated_delivery_date = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].estimated_delivery_date")
carrier_delivery_days = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].carrier_delivery_days")
ship_date = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].ship_date")
negotiated_rate = CkJsonObject::ckBoolOf(jResp,"rate_response.rates[i].negotiated_rate")
service_type = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].service_type")
service_code = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].service_code")
trackable = CkJsonObject::ckBoolOf(jResp,"rate_response.rates[i].trackable")
carrier_code = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].carrier_code")
carrier_nickname = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].carrier_nickname")
carrier_friendly_name = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].carrier_friendly_name")
validation_status = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].validation_status")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"rate_response.rates[i].warning_messages")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"rate_response.rates[i].warning_messages[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"rate_response.rates[i].error_messages")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"rate_response.invalid_rates")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"rate_response.errors")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"packages")
While i < count_i
CkJsonObject::setCkI(jResp, i)
package_code = CkJsonObject::ckStringOf(jResp,"packages[i].package_code")
weightValue = CkJsonObject::ckIntOf(jResp,"packages[i].weight.value")
weightUnit = CkJsonObject::ckStringOf(jResp,"packages[i].weight.unit")
dimensionsUnit = CkJsonObject::ckStringOf(jResp,"packages[i].dimensions.unit")
Length = CkJsonObject::ckIntOf(jResp,"packages[i].dimensions.length")
Width = CkJsonObject::ckIntOf(jResp,"packages[i].dimensions.width")
Height = CkJsonObject::ckIntOf(jResp,"packages[i].dimensions.height")
insured_valueCurrency = CkJsonObject::ckStringOf(jResp,"packages[i].insured_value.currency")
insured_valueAmount = CkJsonObject::ckIntOf(jResp,"packages[i].insured_value.amount")
Reference1 = CkJsonObject::ckStringOf(jResp,"packages[i].label_messages.reference1")
Reference2 = CkJsonObject::ckStringOf(jResp,"packages[i].label_messages.reference2")
Reference3 = CkJsonObject::ckStringOf(jResp,"packages[i].label_messages.reference3")
external_package_id = CkJsonObject::ckStringOf(jResp,"packages[i].external_package_id")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"items")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
