Skip to main content
POST
/
live-rates
cURL
curl https://api.goshippo.com/live-rates \
  -H "Authorization: ShippoToken <API_TOKEN>" \
  -H "Content-Type: application/json"
--data-raw '{
    "address_from": {
       "name": "S. Hippo",
       "company": "Shippo",
       "street1": "731 Market St #200",
       "street_no": "",
       "street2": "",
       "street3": "",
       "city": "San Francisco",
       "state": "CA",
       "zip": "94103",
       "country": "US"
    },
    "address_to": {
       "name": "Bob Bloat",
       "company": "SF Zoo",
       "street1": "Sloat Blvd. & Upper Great Hwy.",
       "street_no": "",
       "street2": "",
       "street3": "",
       "city": "San Francisco",
       "state": "CA",
       "zip": "94132",
       "country": "US"
    },
    "line_items": [
       {
          "quantity": 1,
          "total_price": "12.00",
          "currency": "USD",
          "weight": "1.0",
          "weight_unit": "lb",
          "title": "Hippo Snax",
          "manufacture_country": "US",
          "sku": "HM-123"
       }
   ],
   "parcel": {
      "length": "10",
      "width": "15",
      "height": "10",
      "distance_unit": "in",
      "weight": "1",
      "mass_unit": "lb"
   }
}'
{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "count": 123,
  "results": [
    {
      "amount": "5.5",
      "amount_local": "5.5",
      "currency": "USD",
      "currency_local": "USD",
      "estimated_days": 2,
      "title": "Shipping Option 1"
    }
  ]
}

Authorizations

​
Authorization
string
header
default:ShippoToken shippo_test_d41a6f04796998570c521a50828eae8e3cccf0eb
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Headers

​
SHIPPO-API-VERSION
string
default:2018-02-08

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

Example:

"2018-02-08"

Body

application/json

Generate rates at checkout

​
address_to
required

The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.

​
line_items
Line Item · object[]
required

Array of Line Item objects

​
address_from

The sender address, which includes your name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.

​
parcel

Object ID for an existing User Parcel Template OR a fully formed Parcel object.

Example:

"5df144dca289442cv7a06"

Response

Paginated list of live rates

​
next
string
Example:

"baseurl?page=3&results=10"

​
previous
string
Example:

"baseurl?page=1&results=10"

​
count
integer<int64>
Example:

123

​
results
Live Rate · object[]