Reservations API

Design

The Reservations API is designed customers who wish to retrieve details of Reservations in order to power their own login area, or to send “How was your stay?”-type emails.

Requests are scoped to – currently - one of two params:

1. Email

You tell us the customer’s email address, and we respond with a list of all Reservations made for that customer.

This enables you to be lazy about loading in data – you can initiate this API request when somebody logs in.

2. Departure Date

You tell us a departure date, and we’ll respond with a list of all Reservations with Bookings that depart on that date.

Request

1. Email

Make a GET request to the following endpoint, replacing {email} with the email address you wish to query.

https://app.staylists.com/api/v3/reservations.json?email={email}

2. Departure Date

Make a GET request to the following endpoint, replacing {departure_date} with the departure date you wish to query. Please supply the date in YYYY-MM-DD format.

https://app.staylists.com/api/v3/reservations.json?departure_date={departure_date}

Authentication

This request requires authentication

Response

When a Reservation (or many Reservations) exists

The outermost JSON object will contain a list (array) of Reservations made on your Staylist by the owner of the email address you supplied.

Each Reservation has details of:

• the Bookable Owner (the hotel, B&B, inn, or campsite)
• the Bookings (note this is an array as one Reservation could be for multiple rooms)

Each Booking has details of the Bookable – an abstraction to describe the particular type of accommodation that was stayed in (a room, pitch, cottage, apartment etc)

{
  "object": "List",
  "data": [
    {
      "id": 1102330,
      "object": "Reservation",
      "created_at": "2019-07-10T22:37:31.000+01:00",
      "guest_notes": "",
      "bookable_owner": {
        "id": 6525,
        "object": "BookableOwner",
        "subdomain": "bosaverntr19-ev",
        "name": "Bosavern House"
      },
      "bookings": [
        {
          "id": 1187639,
          "object": "Booking",
          "state": "confirmed",
          "start_date": "2019-07-29",
          "end_date": "2019-07-29",
          "amount_cents": 12500,
          "currency": "GBP"
          "bookable": {
            "id": 36465,
            "object": "Bookable",
            "name": "Family Suite with En-suite"
          }
        }
      ]
    },
    {
      "id": 1103778,
      "object": "Reservation",
      "created_at": "2019-07-11T22:23:46.000+01:00",
      "guest_notes": "",
      "bookable_owner": {
        "id": 4905,
        "object": "BookableOwner",
        "subdomain": "thehawkinn",
        "name": "The Hawk Inn"
      },
      "bookings": [
        {
          "id": 1189352,
          "object": "Booking",
          "state": "confirmed",
          "start_date": "2019-07-24",
          "end_date": "2019-07-24",
          "amount_cents": 9900,
          "currency": "GBP"
          "bookable": {
            "id": 30709,
            "object": "Bookable",
            "name": "Family Rooms"
          }
        }
      ]
    }
  ]
}

When there are no Reservations for this email address or departure date

{
  "object": "List",
  "data": []
}