Booking

Two methods are made available for bookings: preview and reservation.

Endpoint HTTP
/publisher/v3.0/book/preview/.json POST
/publisher/v3.0/book/reservation/.json POST

Preview

HTTP POST: /publisher/v3.0/book/preview/.json

The preview method is for use on pre-checkout pages to display nightly rates, discounts, subtotal, taxes, fees, and totals.

Preview Attributes:
Attribute Type Required Default Definition
key string yes   Your API key
property_id int yes   The property ID
accommodation_id int yes   The room ID
rate_code string yes   The rate plan for the room
checkin string yes   YYYY-MM-DD
checkout string yes   YYYY-MM-DD
rooms array yes   An array of room objects. See room definition
discount_code string no   Discount code
currency string no   Three letter ISO currency code. If not supplied will default to setting in the CRS Admin
{
   "key":"MyKey",
   "property_id":"3144",
   "accommodation_id":"123",
   "rate_code":"REZ",
   "checkin":"2019-01-29",
   "checkout":"2019-01-31",
   "discount_code": "",
   "rooms":[  
      {  
         "adults":2,
         "children":0
      }
   ],
   "meta_data":{
      "session_id":"1aa1b1671982e8539aeed0fcd2aadc54",
      "user_agent":"Mozilla\/5.0 (X11; Linux x86_64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/63.0.3239.132 Safari\/537.36",
      "ip":"127.0.0.1",
   }
}
Preview Response:

The preview response is similar to a property/available.json response, but contains a complete breakdown of taxes and fees. See full response.

Reservation

HTTP POST: /publisher/v3.0/book/reservation/.json

The reservation method processes the submitted information and returns a confirmation number upon success.

Reservation Attributes:

All required attributes from preview

Attribute Type Required Default Definition
rooms array yes   Array of room objects, see below
guest obj yes   See guest object below
payment obj yes   See payment object below
Guest Object
Attribute Type Required Default Definition
first_name obj yes   Guest first name
last_name obj yes   Guest first name
email obj yes   Guest email address
phone obj yes   Guest phone number
note obj no   An optional note to the hotel
addresses array no   Array of objects
Address Object
Attribute Type Required Default Definition
type string yes   Always Billing
line_1 string yes   Street address
line_2 string no   Apartment, Suite, etc…
country string yes   Two character ISO country code
postal_code string yes   Postal code
region string * yes   Non-US reservations only. Province, State, or Administrative Region
state string * yes   US reservations only
Payment Object
Attribute Type Required Default Definition
cardholder string yes   Cardholders name
month string yes   Two character month (00-12)
year int yes   Four digit year
cvv string yes   CVV or CVV2
postal_code string yes   Postal code
Room Object
Attribute Type Required Default Definition
name string yes   Name of guest to put the room under
adults int yes   Amount of adults
children int no 0 Amount of children
bed_type string no 0 Required if bed type option was specified
Reservation Request
{
   "key":"MyKey",
   "property_id":"3144",
   "accommodation_id":"123",
   "rate_code":"REZ",
   "checkin":"2019-01-29",
   "checkout":"2019-01-31",
   "rooms":[
      {
         "name":"RootRez",
         "adults":"2",
         "children":"0",
         "bed_type":false
      }
   ],
   "guest":{
      "first_name":"RootRez",
      "last_name":"RootRez",
      "email":"root@rootrez.com",
      "phone":"8019791437",
      "note":"testing again",
      "addresses":[
         {
            "type":"Billing",
            "line_1":"123",
            "city":"Park City",
            "country":"US",
            "postal_code":"84098",
            "region":"",
            "state":"UT"
         }
      ]
   },
   "payment":{
      "cardholder":"Root Rez",
      "number":"4111111111111111",
      "month":"12",
      "year":"2019",
      "cvv":"644",
      "postal_code":"84098"
   },
   "meta_data":{
      "session_id":"v8klth26ft8qotr09bttk1db53",
      "user_agent":"Mozilla\/5.0 (X11; Linux x86_64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/59.0.3071.104 Safari\/537.36",
      "ip":"127.0.0.1"
   }
}
Reservation Response

View the reservation response.