Class: Api::ReservationsController — Guestfolio API Documentation

index

Get the list of reservations for a hotel

URL

GET /api/hotels/:id/reservations

Optional Parameters

page String
Page number requested
per_page String
Results to be shown per page
search Hash
String

reservation_number

Response Object

Array of reservation details

Examples

Request

(Optional)

"search": [
    "reservation_number": "1234"
]

Response

{

"total_count": 6,
"total_pages": 3,
"reservations": [
    {
        "id": 2,
        "pms_key":"98776",
        "profile_pms_key": "456789",
        "reservation_number": "1234",
        "check_in": "2014-07-01",
        "check_out": "2014-07-02",
        "title": "Mr",
        "first_name": "First",
        "last_name": "Last",
        "email": "email@guestfolio.com",
        "rate_code": "INT",
        "suppress_rate": false,
        "room_revenue": "159.00",
        "room_revenue_tax": "15.90",
        "room_code": "KNG",
        "room_number": "100",
        "adults": 2,
        "children": 1,
        "source": "ABC",
        "language": "en",
        "reserved_at: "2014-12-13T10:21:50-08:00",
        "created_at": "2012-12-13T10:20:50-08:00",
        "updated_at": "2012-12-15T12:18:26-08:00",
        "status": "reserved",
        "sign_in_count": 1,
        "_links": {
            "self": {
                "href": "https://guestfolio.net/api/hotels/1/reservations/1"
            },
            "admin_link": {
                "href": "https://guestfolio.net/reservations/1?hotel_id=1"
            },
            "guest": {
                "href": "https://guestfolio.net/api/hotels/1/guests/1"
            }
        }
    },
    {
        "id": 2,
        "pms_key": "98777",
        "profile_pms_key": "456790",
        "reservation_number": "4321",
        "check_in": "2013-01-09",
        "check_out": "2013-01-10",
        "title": "Mr",
        "first_name": "First",
        "last_name": "Last",
        "email": "email@guestfolio.com",
        "rate_code": "INT",
        "suppress_rate": false,
        "room_revenue": "189.00",
        "room_revenue_tax": "18.90",
        "room_code": "QN",
        "room_number": "300",
        "adults": 2,
        "children": 1,
        "source": "ABC",
        "language": "en",
        "reserved_at: "2014-12-13T10:21:50-08:00",
        "created_at": "2012-12-13T10:20:50-08:00",
        "updated_at": "2012-12-15T12:18:26-08:00",
        "status": "reserved",
        "sign_in_count": 1,
        "_links": {
            "self": {
                "href": "https://guestfolio.net/api/hotels/1/reservations/2"
            },
            "admin_link": {
                "href": "https://guestfolio.net/reservations/1?hotel_id=1"
            },
            "guest": {
                "href": "https://guestfolio.net/api/hotels/1/guests/1"
            }
        }
    }
],
"_links": {
    "self": {
        "href": "https://guestfolio.net/api/hotels/1/reservations?page=2"
    }
    "previous": {
        "href": "https://guestfolio.net/api/hotels/1/reservations?page=1"
    }
    "next": {
        "href": "https://guestfolio.net/api/hotels/1/reservations?page=3"
    }
}

}

create

Create a new reservation

URL

POST /api/hotels/:id/reservations

Required Parameters

reservation_number String
check_in String
check_out String
email String
status String

Optional Parameters

pms_key String
guest Hash
Guest key value pairs for language and pms_key

String

pms_key

String

language
first_name String
last_name String
street String
city String
state String
country String
rates Hash
The reservation rate hash including date and amount
rate_code String
room_code String
room_revenue String
adults Integer
children Integer
market_segment String
source String
extra_values Hash
Any extra value key value pairs, eg:

String

{ key => value }

Response Object

The reservation details

Examples

Request

{

"guest": {
    "language": "en",
    "pms_key": "7456456"
},
"pms_key":"98776",
"reservation_number": "4444",
"check_in": "2014-07-01",
"check_out": "2014-07-02",
"title": "Mr",
"first_name": "First",
"last_name": "Last",
"email": "email@guestfolio.com",
"street": "Street address",
"city": "Vancouver",
"state": "BC",
"country": "Canada",
"rate_code": "AAA",
"suppress_rate": false,
"room_revenue": "119.00",
"room_revenue_tax": "11.90",
"rates": [
 {
    "date": "2014-07-01",
    "amount": "79.50",
    "tax": "7.95",
    "room_code": "DBL",
    "room_number": "300"
 },
 {
    "date": "2014-07-02"
    "amount": "79.50"
    "tax": "7.95",
    "room_code": "DBL",
    "room_number": "300"
  }
],
"room_code": "DBL",
"room_number": "300",
"adults": 2,
"children": 0,
"source": "ABC",
"market_segment": "web",
"extra_values": {
    "deposit": "59.00",
    "guarantee": "Visa",
},
"status": "reserved"

}

Response

{

"id": 3,
"guest": {
    "language": "en",
    "pms_key": "7456456"
},
"pms_key":"98776",
"reservation_number": "4444",
"check_in": "2014-07-01",
"check_out": "2014-07-02",
"title": "Mr",
"first_name": "First",
"last_name": "Last",
"email": "email@guestfolio.com",
"street": "Street address",
"city": "Vancouver",
"state": "BC",
"country": "Canada",
"rate_code": "AAA",
"suppress_rate": false,
"room_revenue": "119.00",
"room_revenue_tax": "11.90",
"rates": [
  {
    "date": "2014-07-01",
    "amount": "79.50",
    "tax": "7.95",
    "room_code": "DBL",
    "room_number": "300"
  },
  {
    "date": "2014-07-02"
    "amount": "79.50"
    "tax": "7.95",
    "room_code": "DBL",
    "room_number": "300"
  }
],
"room_code": "DBL",
"room_number": "300",
"adults": 2,
"children": 0,
"source": "ABC",
"market_segment": "web",
"extra_values": {
    "deposit": "59.00",
    "guarantee": "Visa"
},
"reserved_at: "2014-12-25T10:21:50-08:00",
"created_at": "2014-12-25T10:20:50-08:00",
"updated_at": "2014-12-25T10:20:50-08:00",
"status": "reserved",
"sign_in_count": 0,
"_links": {
    "self": {
        "href": "https://guestfolio.net/api/hotels/1/reservations/3"
    },
    "admin_link": {
        "href": "https://guestfolio.net/reservations/1?hotel_id=1"
    },
    "guest": {
        "href": "https://guestfolio.net/api/hotels/1/guests/1"
    }
}

}

show

Get a specific reservations details

URL

GET /api/hotels/:id/reservations/:id

Response Object

The reservation details

Examples

Request Response

{

"id": 1,
"guest": {
    "language": "en",
    "pms_key": "456789"
},
"pms_key":"98776",
"reservation_number": "1234",
"check_in": "2013-01-01",
"check_out": "2013-01-02",
"title": "Mr",
"first_name": "First",
"last_name": "Last",
"email": "email@guestfolio.com",
"street": "Street address",
"city": "Vancouver",
"state": "BC",
"country": "Canada",
"rate_code": "INT",
"suppress_rate": false,
"room_revenue": "159.00",
"room_revenue_tax": "15.90",
"rates": [
  {
    "date": "2013-01-01",
    "amount": "79.50",
    "tax": "7.95",
    "room_code": "DBL",
    "room_number": "300"
  },
  {
    "date": "2013-01-02"
    "amount": "79.50"
    "tax": "7.95",
    "room_code": "DBL",
    "room_number": "300"
  }
],
"room_code": "KNG",
"room_number": "100",
"adults": 2,
"children": 1,
"source": "ABC",
"created_at": "2012-12-13T10:20:50-08:00",
"updated_at": "2012-12-15T12:18:26-08:00",
"status": "reserved",
"sign_in_count": 1,
"extra_values": {
    "deposit": "59.00",
    "guarantee": "Visa",
},
"response_sets": [
  {
    "id": 1,
    "survey_id": 1,
    "reservation_id": 1
    "score": 90,
    "started_at": "2013-01-05T15:19:05-08:00",
    "completed_at": "2013-01-025T15:19:11-08:00",
    "_links": {
        "self": {
            "href": "https://guestfolio.net/api/hotels/1/surveys/1/response-sets/1"
        },
        "reservation": {
           "href": "https://guestfolio.net/api/hotels/1/reservation/1"
        },
        "survey": {
           "href": "https://guestfolio.net/api/hotels/1/surveys/1"
        }
    }
  }
],
"_links": {
    "self": {
        "href": "https://guestfolio.net/api/hotels/1/reservations/1"
    },
    "admin_link": {
        "href": "https://guestfolio.net/reservations/1?hotel_id=1"
    },
    "guest": {
        "href": "https://guestfolio.net/api/hotels/1/guests/1"
    }
}

}

The reservation hash includes full reservation information and links to additional associated API methods

update

Update an existing reservation with specific changed attributes

URL

PUT /api/hotels/:id/reservations/:id

Optional Parameters

reservation_number String
check_in String
check_out String
email String
status String
pms_key String
guest Hash
Guest key value pairs for language and pms_key

String

pms_key

String

language
first_name String
last_name String
street String
city String
state String
country String
rates Hash
The reservation rate hash including date and amount
rate_code String
room_code String
room_revenue String
adults Integer
children Integer
market_segment String
source String
extra_values Hash
Any extra value key value pairs, eg:

String

{ key => value }

Response Object

String
Empty string on success, check response code

Examples

Request

"first_name": "New First",
"last_name": "New Last",
"title": "Mrs"

Response

destroy

Delete an existing reservation

URL

DELETE /api/hotels/:id/reservations/:id

Guestfolio API Documentation

Reservations [1.1]

index

URL

Optional Parameters

Response Object

Examples

create

URL

Required Parameters

Optional Parameters

Response Object

Examples

show

URL

Response Object

Examples

update

URL

Optional Parameters

Response Object

Examples

destroy

URL