Skip to main content
GET
/
v1
/
shipping_rates
List
curl --request GET \
  --url https://{defaultHost}/v1/shipping_rates \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/shipping_rates"
  },
  "data": [
    {
      "id": "9cd3c646-1d8f-4f35-96c6-2d23bdd0b7ac",
      "object": "shipping_rate",
      "calculatable_type": "flat",
      "calculatable": {
        "currency": "usd",
        "amount": 750
      },
      "shipping_method": "eff3c082-b4a8-41cd-8b78-37e2d9c61951",
      "shipping_zone": "d5f51fab-7d7b-4059-b18a-314398f1a640",
      "created_at": 1780925633,
      "updated_at": 1780925633
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
shipping_zone_ids[]
string[]

Only return objects that belong to the given shipping zone.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.