Rate with Dry Ice Example Request

POST {{base_url}}/api/rating/:version/:requestoption?additionalinfo=

Request Params

KeyDatatypeRequiredDescription
additionalinfonullValid Values: timeintransit = The server rates with transit time information combined with requestoption in URL. Rate is the only valid request option for Ground Freight Pricing requests.

Request Body

{"RateRequest"=>{"Request"=>{"TransactionReference"=>{"CustomerContext"=>"CustomerContext", "TransactionIdentifier"=>"TransactionIdentifier"}}, "Shipment"=>{"Shipper"=>{"Name"=>"ShipperName", "Address"=>{"AddressLine"=>["ShipperAddressLine", "ShipperAddressLine", "ShipperAddressLine"], "City"=>"TIMONIUM", "StateProvinceCode"=>"MD", "PostalCode"=>"21093", "CountryCode"=>"US"}}, "ShipTo"=>{"Name"=>"ShipToName", "Address"=>{"AddressLine"=>["ShipToAddressLine", "ShipToAddressLine", "ShipToAddressLine"], "City"=>"Alpharetta", "StateProvinceCode"=>"GA", "PostalCode"=>"30005", "CountryCode"=>"US"}}, "ShipFrom"=>{"Name"=>"ShipFromName", "Address"=>{"AddressLine"=>["ShipFromAddressLine", "ShipFromAddressLine", "ShipFromAddressLine"], "City"=>"TIMONIUM", "StateProvinceCode"=>"MD", "PostalCode"=>"21093", "CountryCode"=>"US"}}, "Service"=>{"Code"=>"03", "Description"=>"Ground"}, "NumOfPieces"=>"1", "Package"=>{"PackagingType"=>{"Code"=>"02", "Description"=>"Packaging"}, "Dimensions"=>{"UnitOfMeasurement"=>{"Code"=>"IN", "Description"=>"Inches"}, "Length"=>"5", "Width"=>"5", "Height"=>"5"}, "PackageWeight"=>{"UnitOfMeasurement"=>{"Code"=>"LBS", "Description"=>"Pounds"}, "Weight"=>"1"}}}}}

HEADERS

KeyDatatypeRequiredDescription
transIDnullAn identifier unique to the request. Length 32
transactionSrcstringAn identifier of the client/source application that is making the request.Length 512
Content-Typestring

RESPONSES

status: OK

{"RateResponse":{"RatedShipment":{"BaseServiceCharge":{"CurrencyCode":"USD","MonetaryValue":"0.00"},"BillingWeight":{"UnitOfMeasurement":{"Code":"LBS","Description":"Pounds"},"Weight":"7.0"},"RatedPackage":{"BaseServiceCharge":{"CurrencyCode":"USD","MonetaryValue":"14.46"},"BillingWeight":{"UnitOfMeasurement":{"Code":"LBS","Description":"Pounds"},"Weight":"7.0"},"ItemizedCharges":[{"Code":"376","CurrencyCode":"USD","MonetaryValue":"0.00","SubType":"Urban"},{"Code":"375","CurrencyCode":"USD","MonetaryValue":"1.08"}],"ServiceOptionsCharges":{"CurrencyCode":"USD","MonetaryValue":"0.00"},"TotalCharges":{"CurrencyCode":"USD","MonetaryValue":"15.54"},"TransportationCharges":{"CurrencyCode":"USD","MonetaryValue":"15.54"},"Weight":"7.0"},"RatedShipmentAlert":[{"Code":"110971","Description":"Your invoice may vary from the displayed reference rates"},{"Code":"111531","Description":"No user level discount applied for this shipment."}],"Service":{"Code":"03","Description":""},"ServiceOptionsCharges":{"CurrencyCode":"USD","MonetaryValue":"0.00"},"TotalCharges":{"CurrencyCode":"USD","MonetaryValue":"15.54"},"TransportationCharges":{"CurrencyCode":"USD","MonetaryValue":"15.54"}},"Response":{"Alert":[{"Code":"110971","Description":"Your invoice may vary from the displayed reference rates"},{"Code":"111531","Description":"No user level discount applied for this shipment."}],"ResponseStatus":{"Code":"1","Description":"Success"},"TransactionReference":{"CustomerContext":"trans123","TransactionIdentifier":"xwsspta11bl6GskNQPcV4b"}}}}