Sign in
Packages

List availability rules for a package

Returns all AvailabilityRules configured on the given Package. Availability rules carve up the working calendar into windows when the package can or cannot be booked — useful for blocking holidays, restricting weekend hours, or making the package available only during specific seasons.

Rule semantics: any is_available: false rule overrides any is_available: true rule for the same time period. Results are paginated.

get/shop/packages/{packageId}/availability-rules

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

A paginated list of AvailabilityRules on a Package.

Example response

{
  "data": [
    {
      "date_from": "2021-02-15",
      "date_to": "2021-02-15",
      "time_from": "11:00",
      "time_to": "17:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.