Skip to content
Guides
ES
API reference
stablesettings:read

List holidays

Get a paginated list of holidays with optional filtering

GET/v1/shipping/holidays

Get a paginated list of holidays 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
year?string
Formatdate-time

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"
{  "data": [    {      "id": "string",      "storeId": "string",      "name": "string",      "from": "2019-08-24",      "to": "2019-08-24",      "description": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}