Rates

The Rates API allows you to retrieve shipping rates from available carriers.

The Rate Object

This section describes the different attributes available for a rate.

Attribute	Type	Description
amount	number	Total cost of pickup and delivery.
carrier_logo	string	Image URL for carrier logo.
carrier_name	string	Name of carrier executing shipment.
carrier_rate_description	string	Carrier description of rate e.g. UPS First Class.
carrier_reference	string	Unique identifier for carrier.
carrier_slug	string	Unique slug for carrier.
currency	string	Currency of rate amount.
delivery_date	date	Estimated delivery date for shipment.
delivery_eta	number	Estimated delivery time in minutes.
delivery_time	string	Human readable description of estimated time to deliver parcel.
id	string	Unique identifier for rate.
metadata	object	Provides additional information for a rate.
pickup_eta	number	Estimated pickup time in minutes.
pickup_time	string	Human readable description of estimated time to pickup parcel.
rate_id	string	Unique reference for rate.
used	boolean	Indicates if a rate has been used in a shipment request.
created_at	datetime	Time rate created.
updated_at	datetime	Time rate last updated.