Re-Fetch Availability with search ID

You can use this method to fetch complete availability of a previous search.

Method URL
GET api/v3/hotels/availability/<sid>?rates=<rates>

<rates>

  • Allowed values: “comprehensive” or “concise“
  • Recommanded is “concise”.
  • Concise will return only the rate with lowest price for all qualifying hotels.
  • Comprehensive will return a full set of room rates for all qualifying hotels.

Error Codes

HTTP Status Code Error Code Description
401 1102 Invalid API key
200 1501 No availability for the requested search criteria
200 1504 Invalid search ID or it might have expired
403 5003 Not authorised

Re-fetch Availability for a Single Hotel

You can use this method to re-fetch availability of a single hotel from a previous search.

Method URL
GET api/v3/hotels/availability/<sid>?hcode=<hcode>

<sid>

  • refers to the ‘search_id’ returned in the search response.
  • Response to this will be similar to the search response.with results for just one hotel.

Bundled Rates:

You can use this method to fetch rates which are custom bundled by GRNconnect. This is applicable only when you are searching for multiple rooms.

Request

Method URL
GET api/v3/hotels/availability/<sid>?hcode=&bundled=true
  • Response will be similar to the re-fetch with hotel-code method with all rates bundled.

Error Codes

HTTP Status Code Error Code Description
401 1102 Invalid API key
200 1501 No availability for the requested search criteria
200 1504 Invalid search ID or it might have expired
200 1507 Invalid hotel code
404 5002 Hotel not found
### Rate Re-check using rate_key

You shall use this method to fetch the updated rate and cancellation policies. It is mandatory to perform this check before booking if “rate_type” is “recheck” in search response.. Please do not use recheck endpoint for each rate for a hotel if the user do not proceed for booking i.e., recheck endpoint should not be called while displaying rates on the UI and should be called only once the user has selected a rate and proceeded for booking.

Request

Method URL
POST api/v3/hotels/availability/<sid>/rates/?action=recheck
Payload
Attribute Type Required Description
rate_key string REQUIRED Refers to rate key returned in search response.for the selected rate.
group_code string REQUIRED Refers to group code returned in search response.for the selected rate.
Sample Rate-Recheck Payload
{

    "group_code": "x2grb5tjur3xnniz4dgaqsuux3mklgh2vl3ifdjgryvuxknuk2is5w46ee",

    "rate_key": "wogadzlnwr4w5hs3v3tdex4fxcb7dboiul6opwbbreovxe5vjsdbbvfepvewxm55tjktjd7arzbrma3tvhvespmxzdgth3m62xwsq"

}

Response

The response will be similar to that of search response. Find the sample response below.

Sample Rate-Recheck Response:
{
    "hotel": {
        "acc_type": "0",
        "address": "Al Riqa Street Deira   Al Riqa Street",
        "category": 3.0,
        "city_code": "121449",
        "country": "AE",
        "description": "This elegant and contemporary hotel is conveniently located in the centre of Deira, only 9km from Dubai. Its reachable situation just 550 metres from Al Rigga metro station allows visitors to quickly access Dubai and get around with ease. The carefully designed rooms are spacious and generously filled with natural light to afford a complete escape for senses. Accommodations include a seating area, LCD TV with satellite channels, internet access and a private bathroom. Visitors may pamper their taste buds with exquisite cuisine served in charming atmosphere of the stylish rooftop restaurant spectacular panoramic city views, whilst refreshments are available in the welcoming bar and nightclubs. Leisure amenities include a fitness centre with cardiovascular equipment and free weights and an outdoor swimming pool, where to freshen up on the warm days.",
        "facilities": "Secured parking ; Nightclub ; 24-hour security ; Lounges/bars ; Guestroom wireless internet ; Bell staff/porter ; Pets allowed ; Public area air conditioned ; Wheelchair access ; Safe deposit box ; Currency exchange ; Room service ; 24-hour front desk ; Fitness center ; Poolside snack bar ; Parking ; Multilingual staff ; Elevators ; Restaurant ; Guestroom wired internet ; Laundry/Valet service ; Adjoining rooms ; Non-smoking rooms (generic)",
        "geolocation": {
            "latitude": 25.2153,
            "longitude": 55.2744
        },
        "hotel_code": "1848138",
        "images": {
            "main_image": "1848138/e39e083106ef34bc606af9e6daec54ca.jpg",
            "url": "https://images.grnconnect.com/1848138/e39e083106ef34bc606af9e6daec54ca.jpg"
        },
        "name": "Signature Inn",
        "rate": {
            "allotment": 30,
            "boarding_details": [
                "Room Only"
            ],
            "cancellation_policy": {
                "amount_type": "value",
                "cancel_by_date": "2022-12-11T23:59:59",
                "details": [
                    {
                        "currency": "USD",
                        "flat_fee": 56.0,
                        "from": "2022-12-12T00:00:00"
                    }
                ],
                "no_show_fee": {
                    "amount_type": "value",
                    "currency": "USD",
                    "flat_fee": 56.0
                },
                "under_cancellation": false
            },
            "credit_deduction": "immediate",
            "currency": "USD",
            "group_code": "xgirbylkwb6xtgj647fdssmex6nkls5n7k36ruq",
            "has_promotions": false,
            "includes_boarding": true,
            "no_of_rooms": 1,
            "non_refundable": false,
            "payment_type": [
                "AT_WEB"
            ],
            "price": 56.0,
            "price_details": {
                "net": [
                    {
                        "amount": 2.66,
                        "amount_type": "value",
                        "currency": "USD",
                        "included": true,
                        "name": "VAT"
                    },
                    {
                        "amount": 53.269999999999996,
                        "amount_type": "value",
                        "currency": "USD",
                        "included": true,
                        "name": "SupplierPrice"
                    },
                    {
                        "amount": 55.93,
                        "amount_type": "value",
                        "currency": "USD",
                        "included": true,
                        "name": "Total"
                    }
                ]
            },
            "rate_comments": {
                "pax_comments": "For this rate the infants will be converted to children with age 1."
            },
            "rate_key": "4phfnnrx4ausrfstusmwkhgu4hkohjxe6ky6lht52jdb37fgm2qrxgmsi5avxe4d5bdvz6xtv54bqebuxczwq5m72pobjl6gsgusxr4c42ou5a2fzn7d4pq6fmzoi4jt7ggsvxsuaqbharooroz46qp7skyl6lxhap7efpc66ffirw7wb4qclda3s2grdgtnaw4gijymajjcopw5xcahnqrhvdhe5zotbhnttcmpb2o5i7oaht6xwkbknm",
            "rate_type": "bookable",
            "room_code": "4tgevnrv5arerojf",
            "rooms": [
                {
                    "description": "Double Or Twin Room",
                    "no_of_adults": 2,
                    "no_of_children": 0,
                    "no_of_rooms": 1,
                    "room_reference": "sw6dbksvqyrcpwa",
                    "room_type": "Double Or Twin Room"
                }
            ],
            "supports_amendment": false,
            "supports_cancellation": true
        },
        "safe2stay": {
            "covid_19_safe_to_stay": "Y",
            "covid_19_safety_protocol": "This property advises that enhanced cleaning and guest safety measures are currently in place.<br>Property is officially certified under regional sanitization guidelines.<br>"
        }
    },
    "search_id": "nrfmgznuirkkyyfxs5m6s2fohy"
}

Auto Rate Re-check using rate_key (Optional)

You shall use this method to fetch the updated rate and cancellation policies. It is optional to perform. The request and response is same as Rate-Recheck. Although this method is returns the rate_type as bookable. It is mandatory to perform Rate Recheck to process a successful booking.The RateRecheck response should be considered as the final response before booking.

Request

Method URL
POST api/v3/hotels/availability/<sid>/rates/auto?action=recheck
Payload
Attribute Type Required Description
rate_key string REQUIRED Refers to rate key returned in search response for the selected rate.
group_code string REQUIRED Refers to group code returned in search response for the selected rate.
Sample Auto Rate-Recheck Payload
{
   "rate_key": "sska3qk44rpexiqu4tnriz3eau3vs",
   "group_code": "wcobnyltrv3xhbqi7lhg2f6q4hj2m",
}

Response

The response will be similar to that of search response. Find the sample response below.

Sample Auto Rate-Recheck Response:
{
    "hotel": {
        "acc_type": "0",
        "address": "Al Rigga Road, P.O.Box 49185, Dubai",
        "category": 3.0,
        "city_code": "121449",
        "country": "AE",
        "description": "<p><b>Property Location</b> <br />With a stay at Signature Inn Deira Dubai in Dubai (Deira), you'll be within a 5-minute drive of Dubai Creek and BurJuman Mall. This hotel is 1.9 mi (3 km) from City Centre Deira and 2.3 mi (3.6 km) from Gold Souk.</p><p><b>Rooms</b> <br />Make yourself at home in one of the 80 guestrooms.</p><p><b>Amenities</b> <br />Don't miss out on recreational opportunities including a nightclub and a fitness center.</p><p><b>Dining</b> <br />Enjoy a meal at the restaurant or snacks in the hotel's coffee shop/cafe. Relax with your favorite drink at the bar/lounge or the poolside bar.</p><p><b>Business, Other Amenities</b> <br />Featured amenities include wired Internet access (surcharge), dry cleaning/laundry services, and a 24-hour front desk. Self parking (subject to charges) is available onsite.</p>",
        "facilities": "Lounges/bars ; Elevators ; Fitness center ; Restaurant ; Poolside snack bar ; Nightclub ; Safe deposit box ; Multilingual staff ; 24-hour front desk ; Bell staff/porter ; Laundry/Valet service ; Guestroom wired internet ; Outdoor pool ; Parking",
        "geolocation": {
            "latitude": 25.26579,
            "longitude": 55.32146
        },
        "hotel_code": "1848138",
        "images": {
            "main_image": "1848138/e39e083106ef34bc606af9e6daec54ca.jpg",
            "url": "https://images.grnconnect.com/1848138/e39e083106ef34bc606af9e6daec54ca.jpg"
        },
        "name": "Signature Inn Hotel Deira",
        "rate": {
            "boarding_details": [
                "Room Only"
            ],
            "cancellation_policy": {
                "amount_type": "value",
                "cancel_by_date": "2022-12-09T23:59:58",
                "details": [
                    {
                        "currency": "INR",
                        "flat_fee": 5976.0,
                        "from": "2022-12-09T23:59:59"
                    }
                ],
                "no_show_fee": {
                    "amount_type": "value",
                    "currency": "INR",
                    "flat_fee": 5976.0
                },
                "under_cancellation": false
            },
            "credit_deduction": "immediate",
            "currency": "INR",
            "group_code": "xciav53swn3gtnif7xmtetus5lmk5rvk6w2q",
            "has_promotions": false,
            "includes_boarding": true,
            "no_of_rooms": 1,
            "non_refundable": false,
            "pan_required": true,
            "payment_type": [
                "AT_WEB"
            ],
            "price": 5976.0,
            "price_details": {
                "GST": [
                    {
                        "amount": 0.0,
                        "amount_type": "value",
                        "currency": "INR",
                        "included": true,
                        "name": "Total"
                    }
                ],
                "net": [
                    {
                        "amount": 5975.87,
                        "amount_type": "value",
                        "currency": "INR",
                        "included": true,
                        "name": "SupplierPrice"
                    },
                    {
                        "amount": 0.0,
                        "amount_type": "value",
                        "currency": "INR",
                        "included": true,
                        "name": "ServiceFee"
                    },
                    {
                        "amount": 5975.87,
                        "amount_type": "value",
                        "currency": "INR",
                        "included": true,
                        "name": "Total"
                    }
                ]
            },
            "rate_comments": {
                "checkin_begin_time": "12:00 PM",
                "checkin_end_time": "11:30 AM",
                "checkout_time": "1:00 PM",
                "comments": "Tax / Fee like Resort fee or any other taxes that are directly payable to the Hotel to city/government are not includes in the rate. </br> Child OR 3rd Adult will be sharing the same bedding unless extra bed is mentioned. </br> Booked Bedding Type & Bedding Preferences are shared with Hotel, however it’s subject to availability.\n    Please check country/city specific guidelines for COVID related  rules and restrictions for travelers. Check-in and stay at hotel is subject to travelers producing all documents as per COVID guidelines stated by local authorities.\n    If a child stays on existing bedding (free of charge), room benefits are not provided. Customer will have to pay for additional charge for the child to the hotel directly e.g. breakfast charges for child.\n    If holder is not one of the paxes, one of the adult paxes will be considered as holder. Please note that the food inclusion might not always correspond to the number of people staying in the room.\n    ",
                "hotel_remarks": "general:Estimated total amount of taxes & fees for this booking:10.00 Utd. Arab Emir. Dirham payable on arrival.  Check-in hour 14:00-.Car park YES (With additional debit notes).Due to the pandemic, accommodation and service providers may implement processes and policies to help protect the safety of all of us. This may result in the unavailability or changes in certain services and amenities that are normally available from them.More info click here https://cutt.ly/MT8BJcv (15/05/2020-31/12/2022).",
                "mealplan": "Room Only",
                "pax_comments": "For this rate the infants will be converted to children with age 1."
            },
            "rate_key": "4devnmrw5bvwtcyp6dfckso4wsg6ve7uu27y7lls3vdr5kpodlih3axtenphvzx76fltndfxzmavisbu664fa5gss7ig3j6ax7wshr4c46pqa",
            "rate_type": "bookable",
            "room_code": "43gevmzr5arerojf",
            "rooms": [
                {
                    "children_ages": [
                        3
                    ],
                    "description": "Standard Double standard double bed : Room Only",
                    "no_of_adults": 1,
                    "no_of_children": 1,
                    "no_of_rooms": 1,
                    "room_reference": "qoyv5ptvuz4xhdqa43hw2f6x5lmk5s5c6i",
                    "room_type": "Standard Double"
                }
            ],
            "supports_amendment": false,
            "supports_cancellation": true
        },
        "safe2stay": {
            "covid_19_safe_to_stay": "Y",
            "covid_19_safety_protocol": "This property advises that enhanced cleaning and guest safety measures are currently in place.<br>"
        }
    },
    "search_id": "hd6elu255bomggmp2wxn5igzzq"
}

Error Codes

HTTP Status Code Error Code Description
404 1504 Invalid search Id or it may have expired
200 2001 Invalid group code
200 2004 The booking item is not available/sold out
200 2008 The rate_key is invalid or expired
200 5101 Field[name] is required
200 5102 group_code value/type is invalid
200 5102 rate_key value/type is invalid
200 5140 Unknown Error at Supplier’s end
200 5146 Not Authorised at supplier’s end
200 5147 Supplier API is currently unavailable