API reference
Search
K
Links
Comment on page

List all shipping zones

How to fetch a collection of shipping zones via API
To fetch a collection of shipping zones, send a GET request to the /api/shipping_zones endpoint.

Request

GET https://yourdomain.commercelayer.io/api/shipping_zones

Example

Request
Response
The following request fetches a collection of shipping zones:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/shipping_zones/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "shipping_zones",
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_zones/xYZkjABcde"
},
"attributes": {
"name": "Europe (main countries)",
"country_code_regex": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT",
"not_country_code_regex": "AT|BE|BG|CZ|DK|EE|DE",
"state_code_regex": "A[KLRZ]|C[AOT]|D[CE]|FL",
"not_state_code_regex": "A[KLRZ]|C[AOT]",
"zip_code_regex": "(?i)(JE1|JE2|JE3|JE4|JE5)",
"not_zip_code_regex": "(?i)(JE1|JE2|JE3)",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_zones/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/shipping_zones/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/shipping_zones/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/shipping_zones/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 shipping_zones (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/shipping_zones?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/shipping_zones?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/shipping_zones?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of shipping zones can be sorted by the following fields:
  • name
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Filterable fields

The list of shipping zones can be filtered by the following fields:

Attributes

  • name
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin
  • metadata

Relationships

  • attachments