Skip to content
Guides
ES
API reference
stablesettings:read

List shipping zones

Get a paginated list of shipping zones with optional filtering

GET/v1/shipping/zones

Get a paginated list of shipping zones with optional filtering

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
isActive?boolean

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/shipping/zones"
{  "data": [    {      "id": "string",      "storeId": "string",      "code": "string",      "name": "string",      "description": null,      "countryCodes": [        "string"      ],      "provinceCodes": [        "string"      ],      "cityNames": [        "string"      ],      "districtNames": [        "string"      ],      "postalCodes": [        "string"      ],      "isActive": true,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}