Retrieve Shipment Rates

When you rate multiple shipments, ShipStation API returns a list of rates with information about each one, such as the costs and the estimated delivery date. Each of these rates is specific to the shipment information provided in the rate request.

ShipStation API stores this shipment information as a shipment object and each rate is associated with a shipment_id. You can then retrieve the rates later using this shipment_id.

Example Request & Response

GET /v1/shipments/:shipment_id/rates

This example retrieves the rates for "shipment_id": se-2102034 (see line 3 of the example response).

1
2
3
GET /v1/shipments/se-2102034/rates HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example Response

The response includes a list of rates for "shipment_id": se-2102034. Each rate includes a rate_id that you can use to create a label.

Due to the length of the response, we have truncated this example to only show a single rate.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
[
  {
    "shipment_id": "se-2102034",
    "status": "completed",
    "created_at": "2019-07-25T15:24:46.657Z",
    "rates": [
      {
        "rate_id": "se-11744390",
        "rate_type": "shipment",
        "carrier_id": "se-123890",
        "shipping_amount": {
          "currency": "usd",
          "amount": 9.37
        },
        "insurance_amount": {
          "currency": "usd",
          "amount": 0.00
        },
        "confirmation_amount": {
          "currency": "usd",
          "amount": 0.00
        },
        "other_amount": {
          "currency": "usd",
          "amount": 0.00
        },
        "rate_details": [
          {
            "rate_detail_type": "shipping",
            "carrier_description": null,
            "carrier_billing_code": "Base Rate",
            "carrier_memo": null,
            "amount": {
              "currency": "usd",
              "amount": 9.37
            },
            "billing_source": "Carrier"
          }
        ],
        "delivery_days": 3,
        "guaranteed_service": false,
        "delivery_date": "2019-07-25T05:00:00.000Z",
        "carrier_delivery_days": "Friday by 11:00 PM",
        "ship_date": "2019-07-25T05:00:00.000ZPlus3$",
        "negotiated_rate": false,
        "service_type": "UPS® Ground",
        "service_code": "ups_ground",
        "trackable": true,
        "validation_status": "valid",
        "warning_messages": [],
        "error_messages": [],
        "carrier_code": "ups",
        "carrier_nickname": "UPS-28A1R9",
        "carrier_friendly_name": "UPS"
      }
    ],
    "invalid_rates": [],
    "errors": null
  }
]