Rate
After a Shipment is successfully created, it will
automatically fetch Rates.
You can limit the CarrierAccounts
to use for rating by passing the carrier_accounts parameter upon Shipment creation.
There are three rate types: the actual rate that will be purchased,
rate and currency, the published non-discounted rate,
list_rate and list_currency, and the rate if purchased
from the post office, retail_rate and retail_currency.
id
string
Unique, begins with 'rate_'
object
string
"Rate"
mode
string
"test" or "production"
service
string
The name of the service level to use
carrier
string
The name of the carrier
carrier_account_id
string
The ID of the
CarrierAccount used to generate this rateshipment_id
string
ID of the Shipment this rate belongs to
rate
string
The actual rate quote for this service
currency
string
The currency for the rate
retail_rate
string
The retail rate is the in-store rate given with no account
retail_currency
string
The currency for the retail rate
list_rate
string
The list rate is the non-negotiated rate given for having an account with the carrier
list_currency
string
The currency for the list rate
delivery_days
integer
The delivery days for this service
delivery_date
string
The date for delivery
delivery_date_guaranteed
boolean
Indicates if delivery window is guaranteed (
true) or not (false)billing_type
string
Billing type of the rate
created_at
datetime
When the
Rate was createdupdated_at
datetime
When the
Rate was last updatedRate Object
{
"id": "rate_baa35256609648be87726a3e2dfebdac",
"object": "Rate",
"created_at": "2024-01-24T00:07:18Z",
"updated_at": "2024-01-24T00:07:18Z",
"mode": "test",
"service": "Priority",
"carrier": "USPS",
"rate": "7.33",
"currency": "USD",
"retail_rate": "15.20",
"retail_currency": "USD",
"list_rate": "10.89",
"list_currency": "USD",
"billing_type": "easypost",
"delivery_days": 2,
"delivery_date": null,
"delivery_date_guaranteed": false,
"est_delivery_days": 2,
"shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
"carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
}
No service levels for Chronopost.
No service levels for JP Post.
No service levels for Kuroneko Yamato.
No service levels for La Poste.
No service levels for PostNL.
No service levels for UPS iParcel.
No service levels for Yanwen.
BETA: This feature is in Beta and subject to change. For feedback or questions, please contact our Support team.
You can retrieve Rates without creating a Shipment object using this endpoint.
This endpoint is ideal when wanting to display or compare rates without creating Shipment objects.
The Rate objects returned by this endpoint do not include IDs.
Request Parameters
reference
i.e. "my-reference"
An optional field that may be used in place of
id in other API endpointsto_address
i.e. Address
Can be specified by ID or attributes to create a new one, and be verified inline. See Create an Address
from_address
i.e. Address
Can be specified by ID or attributes to create a new one, and be verified inline. See Create an Address
parcel
i.e. Parcel
The
Parcel being shipped.carrier_accounts
i.e. ["ca_..."]
List of CarrierAccounts to use for rating.
service
i.e. "Priority"
The service of the carrier
POST /
1$ curl -X POST https://api.easypost.com/beta/rates \
2 -u "EASYPOST_API_KEY": \
3 -H "Content-Type: application/json" \
4 -d '{
5 "shipment": {
6 "to_address": {
7 "name": "Dr. Steve Brule",
8 "street1": "179 N Harbor Dr",
9 "city": "Redondo Beach",
10 "state": "CA",
11 "zip": "90277",
12 "country": "US",
13 "phone": "8573875756",
14 "email": "dr_steve_brule@gmail.com"
15 },
16 "from_address": {
17 "name": "EasyPost",
18 "street1": "417 Montgomery Street",
19 "street2": "5th Floor",
20 "city": "San Francisco",
21 "state": "CA",
22 "zip": "94104",
23 "country": "US",
24 "phone": "4153334445",
25 "email": "support@easypost.com"
26 },
27 "parcel": {
28 "length": "20.2",
29 "width": "10.9",
30 "height": "5",
31 "weight": "65.0"
32 }
33 }
34}'Response
1{
2 "from_address": {
3 "object": "Address",
4 "name": "EasyPost",
5 "street1": "417 Montgomery Street",
6 "street2": "5th Floor",
7 "city": "San Francisco",
8 "state": "CA",
9 "zip": "94104",
10 "country": "US",
11 "phone": "4153334445",
12 "email": "support@easypost.com"
13 },
14 "to_address": {
15 "object": "Address",
16 "name": "Dr. Steve Brule",
17 "street1": "179 N Harbor Dr",
18 "city": "Redondo Beach",
19 "state": "CA",
20 "zip": "90277",
21 "country": "US",
22 "phone": "8573875756",
23 "email": "dr_steve_brule@gmail.com"
24 },
25 "rates": [
26 {
27 "object": "Rate",
28 "mode": "test",
29 "service": "Priority",
30 "carrier": "USPS",
31 "rate": "7.33",
32 "currency": "USD",
33 "retail_rate": "15.20",
34 "retail_currency": "USD",
35 "list_rate": "10.89",
36 "list_currency": "USD",
37 "billing_type": "easypost",
38 "delivery_days": 2,
39 "delivery_date": null,
40 "delivery_date_guaranteed": false,
41 "est_delivery_days": 2,
42 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
43 },
44 {
45 "object": "Rate",
46 "mode": "test",
47 "service": "GroundAdvantage",
48 "carrier": "USPS",
49 "rate": "6.79",
50 "currency": "USD",
51 "retail_rate": "13.15",
52 "retail_currency": "USD",
53 "list_rate": "9.41",
54 "list_currency": "USD",
55 "billing_type": "easypost",
56 "delivery_days": 3,
57 "delivery_date": null,
58 "delivery_date_guaranteed": false,
59 "est_delivery_days": 3,
60 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
61 },
62 {
63 "object": "Rate",
64 "mode": "test",
65 "service": "First",
66 "carrier": "USPS",
67 "rate": "6.79",
68 "currency": "USD",
69 "retail_rate": "13.15",
70 "retail_currency": "USD",
71 "list_rate": "9.41",
72 "list_currency": "USD",
73 "billing_type": "easypost",
74 "delivery_days": 3,
75 "delivery_date": null,
76 "delivery_date_guaranteed": false,
77 "est_delivery_days": 3,
78 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
79 },
80 {
81 "object": "Rate",
82 "mode": "test",
83 "service": "ParcelSelect",
84 "carrier": "USPS",
85 "rate": "6.79",
86 "currency": "USD",
87 "retail_rate": "13.15",
88 "retail_currency": "USD",
89 "list_rate": "9.41",
90 "list_currency": "USD",
91 "billing_type": "easypost",
92 "delivery_days": 3,
93 "delivery_date": null,
94 "delivery_date_guaranteed": false,
95 "est_delivery_days": 3,
96 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
97 },
98 {
99 "object": "Rate",
100 "mode": "test",
101 "service": "Express",
102 "carrier": "USPS",
103 "rate": "49.60",
104 "currency": "USD",
105 "retail_rate": "57.40",
106 "retail_currency": "USD",
107 "list_rate": "49.60",
108 "list_currency": "USD",
109 "billing_type": "easypost",
110 "delivery_days": null,
111 "delivery_date": null,
112 "delivery_date_guaranteed": false,
113 "est_delivery_days": null,
114 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
115 }
116 ],
117 "options": {
118 "currency": "USD",
119 "payment": {
120 "type": "SENDER"
121 },
122 "date_advance": 0
123 },
124 "parcel": {
125 "object": "Parcel",
126 "length": 20.2,
127 "width": 10.9,
128 "height": 5.0,
129 "weight": 65.9
130 },
131 "messages": []
132}You can regenerate the Rates of a Shipment at any time.
This is ideal when shipments aren't bought the same day as they were created and you want the most up-to-date rates available.
This operation respects the carrier_accounts attribute.
POST /
1curl -X POST https://api.easypost.com/v2/shipments/shp_.../rerate \
2 -u "EASYPOST_API_KEY":Response
1{
2 "rates": [
3 {
4 "id": "rate_baa35256609648be87726a3e2dfebdac",
5 "object": "Rate",
6 "created_at": "2024-01-24T00:07:18Z",
7 "updated_at": "2024-01-24T00:07:18Z",
8 "mode": "test",
9 "service": "Priority",
10 "carrier": "USPS",
11 "rate": "7.33",
12 "currency": "USD",
13 "retail_rate": "15.20",
14 "retail_currency": "USD",
15 "list_rate": "10.89",
16 "list_currency": "USD",
17 "billing_type": "easypost",
18 "delivery_days": 2,
19 "delivery_date": null,
20 "delivery_date_guaranteed": false,
21 "est_delivery_days": 2,
22 "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
23 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
24 },
25 {
26 "id": "rate_2bab14cc52364f2b9bc2ccf3ca7b3862",
27 "object": "Rate",
28 "created_at": "2024-01-24T00:07:18Z",
29 "updated_at": "2024-01-24T00:07:18Z",
30 "mode": "test",
31 "service": "GroundAdvantage",
32 "carrier": "USPS",
33 "rate": "6.79",
34 "currency": "USD",
35 "retail_rate": "13.15",
36 "retail_currency": "USD",
37 "list_rate": "9.41",
38 "list_currency": "USD",
39 "billing_type": "easypost",
40 "delivery_days": 3,
41 "delivery_date": null,
42 "delivery_date_guaranteed": false,
43 "est_delivery_days": 3,
44 "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
45 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
46 },
47 {
48 "id": "rate_e378828036014066810f573b11e3422c",
49 "object": "Rate",
50 "created_at": "2024-01-24T00:07:18Z",
51 "updated_at": "2024-01-24T00:07:18Z",
52 "mode": "test",
53 "service": "First",
54 "carrier": "USPS",
55 "rate": "6.79",
56 "currency": "USD",
57 "retail_rate": "13.15",
58 "retail_currency": "USD",
59 "list_rate": "9.41",
60 "list_currency": "USD",
61 "billing_type": "easypost",
62 "delivery_days": 3,
63 "delivery_date": null,
64 "delivery_date_guaranteed": false,
65 "est_delivery_days": 3,
66 "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
67 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
68 },
69 {
70 "id": "rate_6989382e7baf477e90b024d4b2adb123",
71 "object": "Rate",
72 "created_at": "2024-01-24T00:07:18Z",
73 "updated_at": "2024-01-24T00:07:18Z",
74 "mode": "test",
75 "service": "ParcelSelect",
76 "carrier": "USPS",
77 "rate": "6.79",
78 "currency": "USD",
79 "retail_rate": "13.15",
80 "retail_currency": "USD",
81 "list_rate": "9.41",
82 "list_currency": "USD",
83 "billing_type": "easypost",
84 "delivery_days": 3,
85 "delivery_date": null,
86 "delivery_date_guaranteed": false,
87 "est_delivery_days": 3,
88 "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
89 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
90 },
91 {
92 "id": "rate_d1795faa20de435089eac68b61ae37dc",
93 "object": "Rate",
94 "created_at": "2024-01-24T00:07:18Z",
95 "updated_at": "2024-01-24T00:07:18Z",
96 "mode": "test",
97 "service": "Express",
98 "carrier": "USPS",
99 "rate": "49.60",
100 "currency": "USD",
101 "retail_rate": "57.40",
102 "retail_currency": "USD",
103 "list_rate": "49.60",
104 "list_currency": "USD",
105 "billing_type": "easypost",
106 "delivery_days": null,
107 "delivery_date": null,
108 "delivery_date_guaranteed": false,
109 "est_delivery_days": null,
110 "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
111 "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
112 }
113 ]
114}