v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Rates

Retrieve shipment rates

Returns a paginated list of rates associated with a shipment. Rates for shipments older than 390 days are not returned.

get/shipments/{ShipmentId}/rates

Path parameters

ShipmentIdstring required

Object ID of the shipment to update

Query parameters

pageinteger

The page number you want to select

resultsinteger

The number of results to return per page (max 100)

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Response

Paginated list of rates

nextstring
previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "amount": "5.5",
      "amount_local": "5.5",
      "currency": "USD",
      "currency_local": "USD",
      "arrives_by": "08:30:00",
      "carrier_account": "078870331023437cb917f5187429b093",
      "duration_terms": "Delivery in 1 to 3 business days",
      "estimated_days": 2,
      "included_insurance_price": "1.05",
      "messages": [
        {
          "source": "UPS",
          "code": "carrier_timeout",
          "text": "UPS API did not respond. Please try again in a few minutes."
        }
      ],
      "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
      "object_owner": "pp@gmail.com",
      "provider": "USPS",
      "provider_image_75": "https://cdn2.goshippo.com/providers/75/USPS.png",
      "provider_image_200": "https://cdn2.goshippo.com/providers/200/USPS.png",
      "servicelevel": {
        "name": "Priority Mail Express",
        "token": "usps_priority_express",
        "parent_servicelevel": {
          "name": "Priority Mail Express",
          "token": "usps_priority_express"
        }
      },
      "shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
      "zone": "1"
    }
  ]
}