Explore the capabilities and functions of the Rating object.
The Rating object will provide shipping quotes by service level with a breakdown of surcharges, fees, and negotiated rate discounts that make up the quote.
The unique identifier for the object. The id for the rating object will always be prefixed with ship.
currency HASH
Hash providing information on the base currency sent in the request and provided for the response.
currency.id STRING
The unique identifier for the currency object.
currency.base STRING
The base currency as sent in the rating request, represented by a three-letter ISO code. All amounts in the rating object are listed in the base currency.
currency.date TIMESTAMP
The date in which the currency rate was pulled, in the ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ.
currency.rates HASH
Hash containing the currencies and exchange rates needed for conversion from the base currency.
errors HASH
Hash containing the details of any errors on the request.
errors.type STRING
The origin of the error. Possible values include fedex_apiups_apidhl_apiusps_apiinternal_errorzonos_configuration.
errors.message STRING
The descriptive reason for the error from the corresponding carrier.
errors.details HASH
Hash containing details on the service level that returned an error.
errors.details.id STRING
The unique identifier for the service level.
errors.details.service_level STRING
The service level with the carrier, e.g., standard.
errors.details.display_name STRING
The display name for the service level.
quotes LIST
The list of shipping quotes by service level.
quotes.id STRING
The unique identifier for the object. The id for the quotes object will always be prefixed with rtqt.
quotes.amount_subtotal DECIMAL
The total calculated shipping cost for the service level.
quotes.weight HASH
Hash providing information about the weight used for the quoted shipping cost.
quotes.weight.billable DECIMAL
The billable weight of the package used for the shipping quote.
quotes.weight.unit STRING
The unit of measurement for the weight.Possible values are pound, ounce, kilogram, and null.When null, pound will be used.
quotes.mode HASH
Hash containing detailed information on the service level.
quotes.mode.service_level STRING
The service_level with the carrier, e.g., standard. Common examples include: ups_express, ups_express_saver, ups_expedited, ups_economy, ups_standard, ups_mail_innovations_economy, ups_mail_innovations_priority, dhl_express, dhl_ecommerce_parcel_direct, fedex_priority, fedex_economy, usps_first_class_mail_international, usps_priority_mail_international, landmark_parcel, apc_parcel, point2point_standard, point2point_direct, point2point_packet, and fedex_international_ground. See the carrier docs for the full list of available service levels by carrier.
quotes.mode.display_name STRING
The display name for the service level.
quotes.mode.delivery_date_estimate TIMESTAMP
The estimated delivery date for the service level, in the ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ. This will be returned if available from the carrier API.
quotes.mode.transit_business_days INTEGER
The estimated number of transit days for the service level only counting business days as transit days. This will be returned if available from the carrier API.
quotes.mode.transit_days INTEGER
The estimated number of transit days for the service level. This will be returned if available from the carrier API.
quotes.mode.rates HASH
Hash containing detailed information on the breakdown of the shipping rate amount.
quotes.mode.rates.amount DECIMAL
The amount of the specific rate item.
quotes.mode.rates.note STRING
Additional details on what the rate item amount represents.
quotes.mode.rates.type STRING
The type of the rate item. Possible values include retail_shippingfuel_surchargecarrier_feenegotiated_discount.
quotes.packages LIST
A list of details on the packages being shipped.
quotes.packages.id STRING
The unique identifier for the packages object.
quotes.packages.weight HASH
Hash containing details of the weight for the package.
quotes.packages.weight.billable DEMICAL
The billable weight of the package.
quotes.packages.weight.dimensional DECIMAL
The dimension weight of the package.
quotes.packages.weight.factor INTEGER
The international weight factored use to calculate the dimensional weight for the package.
quotes.packages.weight.weight_unit STRING
A string with the unit of measurement for the weight.Possible values are poundouncekilogramnull.When null, pound will be used.
Rating object
Rating object
Explore the capabilities and functions of the Rating object.
The Rating object will provide shipping quotes by service level with a breakdown of surcharges, fees, and negotiated rate discounts that make up the quote.
Attributes
idSTRINGship.currencyHASHcurrency.idSTRINGcurrency.baseSTRINGcurrency.dateTIMESTAMPYYYY-MM-DDTHH:mm:ss.sssZ.currency.ratesHASHerrorsHASHerrors.typeSTRINGfedex_apiups_apidhl_apiusps_apiinternal_errorzonos_configuration.errors.messageSTRINGerrors.detailsHASHerrors.details.idSTRINGerrors.details.service_levelSTRINGstandard.errors.details.display_nameSTRINGquotesLISTquotes.idSTRINGrtqt.quotes.amount_subtotalDECIMALquotes.weightHASHquotes.weight.billableDECIMALquotes.weight.unitSTRINGpound,ounce,kilogram, andnull.Whennull,poundwill be used.quotes.modeHASHquotes.mode.service_levelSTRINGstandard. Common examples include:ups_express,ups_express_saver,ups_expedited,ups_economy,ups_standard,ups_mail_innovations_economy,ups_mail_innovations_priority,dhl_express,dhl_ecommerce_parcel_direct,fedex_priority,fedex_economy,usps_first_class_mail_international,usps_priority_mail_international,landmark_parcel,apc_parcel,point2point_standard,point2point_direct,point2point_packet, andfedex_international_ground. See the carrier docs for the full list of available service levels by carrier.quotes.mode.display_nameSTRINGquotes.mode.delivery_date_estimateTIMESTAMPYYYY-MM-DDTHH:mm:ss.sssZ. This will be returned if available from the carrier API.quotes.mode.transit_business_daysINTEGERquotes.mode.transit_daysINTEGERquotes.mode.ratesHASHquotes.mode.rates.amountDECIMALquotes.mode.rates.noteSTRINGquotes.mode.rates.typeSTRINGretail_shippingfuel_surchargecarrier_feenegotiated_discount.quotes.packagesLISTquotes.packages.idSTRINGquotes.packages.weightHASHquotes.packages.weight.billableDEMICALquotes.packages.weight.dimensionalDECIMALquotes.packages.weight.factorINTEGERquotes.packages.weight.weight_unitSTRINGpoundouncekilogramnull.Whennull,poundwill be used.{"id": "ship_5p67angIDnS91CyfpW55YZ","currency": {"id": "curr_1Rp9lhXSRXvEWVs97k2PHE","base": "USD","date": "2020-02-04T18:47:04.629+0000","rates": []},"errors": [{"details": {"id": "rtqt_7cz80Ny8dToSqoWlHTJJnP","display_name": "FedEx Express Saver","service_level": "FEDEX_EXPRESS_SAVER","message": "[868] Service is not allowed. ","type": "fedex_api"}}],"quotes": [{"id": "rtqt_4BUyxLEUeoU6zDdprCRoUV","amount_subtotal": 943.18,"mode": {"delivery_date_estimate": null,"display_name": "UPS Expedited ","rates": [{"amount": 848.31,"note": "UPS api: standard rate","type": "retail_shipping"},{"amount": 64.4,"note": "UPS api: fuel surcharge","type": "fuel_surcharge"},{"amount": 40,"note": "UPS api: extended area","type": "carrier_fee"},{"amount": -9.53,"note": "UPS negotiated discount","type": "negotiated_discount"}],"service_level": "UPS_WORLDWIDE_EXPEDITED","transit_business_days": null,"transit_days": null},"packages": [{"id": "1","weight": {"billable": 32,"dimensional": 30.7554,"factor": 139,"weight_unit": "pound"}}],"weight": {"billable": 32,"unit": "pound"}},{"id": "rtqt_1jyuPdiE5uIBcYzhO54DAb","amount_subtotal": 1058.86,"mode": {"delivery_date_estimate": null,"display_name": "UPS Saver ","rates": [{"amount": 957.26,"note": "UPS api: standard rate","type": "retail_shipping"},{"amount": 72.3,"note": "UPS api: fuel surcharge","type": "fuel_surcharge"},{"amount": 40,"note": "UPS api: extended area","type": "carrier_fee"},{"amount": -10.7,"note": "UPS negotiated discount","type": "negotiated_discount"}],"service_level": "UPS_SAVER","transit_business_days": null,"transit_days": null},"packages": [{"id": "1","weight": {"billable": 32,"dimensional": 30.7554,"factor": 139,"weight_unit": "pound"}}],"weight": {"billable": 32,"unit": "pound"}}]}Was this page helpful?