Skip to content
docs
Guides
ES
Fulfillment & ShippingHolidays
settings:read

List non-working date ranges

Lists non-working date ranges with name search and active or year filters.

GET/v1/shipping/holidays

Lists non-working date ranges with name search and active or year filters.

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

Only active items.

year?string
Formatdate-time

Header Parameters

Authorization*string

OAuth 2.0 bearer token.

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/holidays" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "name": "Example resource",      "from": "2026-08-01",      "to": "2026-08-01",      "description": "Example description."    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}