Skip to main content
GET
/
v1
/
shipping_zones
List
curl --request GET \
  --url https://{defaultHost}/v1/shipping_zones \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/shipping_zones"
  },
  "data": [
    {
      "id": "98fb147f-6804-4059-be54-21bfdfb33b9c",
      "object": "shipping_zone",
      "name": "USA",
      "territories": [
        {
          "country": "US",
          "states": [
            "NY",
            "CA"
          ]
        }
      ],
      "postal_codes": [],
      "shipping_profile": "67c1cdfb-1f1c-46bc-9c05-f3fba7ddcab8",
      "created_at": 1771429909,
      "updated_at": 1771429909
    }
  ]
}

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_profile_ids[]
string[]

Only return objects that belong to the given shipping profile.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.