Last Update Date 13.07.2023

Request Url

http://api.stage.paximum.com/v1/search/hotels

Request Model

Attribute Type Required Description
Destinations Array (Destination) Yes Destination information to search
Rooms Array (Room) Yes Room information to search. Max 4 rooms
Attribute Type Required Description
Adults Int Yes Adult count of room.
ChildrenAges Array (Int) No Child ages if exist.
CheckInDate String Yes CheckInDate format (yyyy-MM-dd)
CheckOutDate String Yes CheckOutDate format (yyyy-MM-dd)
Currency String Yes Currency of search (2 letter ISO code)
CustomerNationality String Yes Nationality of customers (2 letter ISO code)
FilterUnAvailable Bool No If you send true you will get only available offers
FilterDistinct Bool No
WithPromotion Bool No
IncludeHotelContent Bool No If you send true you will get hotel content information
OnlyBestOffers Bool No If you send true you will get only best offer for per hotel and you have to continue with checkHotelAvailability,
otherwise continue with checkAvailability
Language String No Language of search
TimeOut Int No Expected response time (second)
IsPreSearch Bool No For cache search prices, If you send true, you cannot use offers for booking.

Maximum number of hotels for a single request is 200. If you search for 1000 hotels, you can send 5 requests in parallel. No limit for parallel requests.
Maximum number of rooms for a single request is 4.
Maximum number of adults for a single room is 9.
Maximum number of adults for a single request is 20.

Request Sample

    
{
    "destinations": [{
        "type": "hotel",
        "id": "100122"
    }],
    "rooms": [{
        "adults": 2,
        "childrenAges": []
    }],
    "checkinDate": "2016-01-01",
    "checkoutDate": "2016-01-04",
    "currency": "EUR",
    "customerNationality": "TR",
    "filterUnavailable": false,
    "withPromotion": false,
    "IncludeHotelContent": false,
    "language": "tr",
    "timeout": 0,
    "onlyBestOffers": false,
    "isPreSearch": false
}

Response Model

Attribute Type Description
SearchId String SearchId of the response
expiresOn DateTime Expiration date of response offers
Hotels Array (Hotel) Collection of hotels
Attribute Type Description
Id Int Hotel id
Name String Hotel name
Description String Hotel description
City Object Hotel city
Country Object Hotel country
Stars Double Hotel stars
Rating Double Hotel rating
ReviewUrl String Review url
Thumbnail String Hotel thumbnail (https://media.dev.paximum.com/hotelimages/+thumbnail)
Address String Hotel address
Themes Array (String) Hotel themes
Facilities Array Hotel facilities
Geolocation Object Hotel geolocation
IsFavorite Boolean
Offers Array (Object) Offers of the response

Response Sample

    
{
    "searchId": "eb4658f0-c35a-4d2f-82ef-8af9e655d915",
    "expiresOn": "2023-07-13T13:22:25.7394952Z",
    "hotels": [
        {
            "id": "326105",
            "name": "Bonnington Jumeirah Lakes Towers",
            "description": "The full service hotel in Dubai is located in the heart of Jumeirah Lakes Towers along Sheikh Zayed Road just opposite Dubai Marina. Dubai Airport is approximately 40 km away.",
            "city": {
                "id": "23675",
                "name": "Dubai"
            },
            "country": {
                "id": "AE",
                "name": "United Arab Emirates"
            },
            "stars": 5.0,
            "category": "Halal",
            "rating": 5.02083,
            "reviewUrl": "http://www.holidaycheck.com/hr/5ccd392d-344a-3885-a1f6-635e180957d3",
            "thumbnail": "326105/f43c9556bc945761a3fee263180a34a9.jpg",
            "address": "P.O. Box 37246 Dubai",
            "themes": [
                "Country House"
            ],
            "facilities": [
                "Air conditioning",
                "Lobby",
                "24-hour reception",
                "24-hour check-in",
                "Hotel Safe",
                "Currency Exchange",
                "Cloakroom",
                "Lifts",
                "Café",
                "Newspaper kiosk",
                "Shops",
                "Hairdresser",
                "Restaurant(s)",
                "Restaurant(s) with air conditioning ",
                "Restaurant(s) with non-smoking area",
                "WLAN access",
                "Room Service",
                "Car Park"
            ],
            "geolocation": {
                "longitude": 55.14167,
                "latitude": 25.06797
            },
            "isFavorite": false,
            "offers": [
                {
                    "id": "5cfb9734-6bec-4018-9133-9abe90a837b8",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "43",
                    "board": "ROOM ONLY",
                    "boardCategories": [
                        "Room only"
                    ],
                    "rooms": [
                        {
                            "id": "14debaa4-f641-4ac7-9cc6-e331c786a09b",
                            "typeId": "3718",
                            "type": "Standard Room",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 62.4901,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 62.4901,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 62.4901,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "ad309449-66cf-4d71-87d4-b6ac21b96d6c",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "50",
                    "board": "BED AND BREAKFAST",
                    "boardCategories": [
                        "Breakfast"
                    ],
                    "rooms": [
                        {
                            "id": "f53dfde6-e503-42c8-a8b0-d8a4a1a9aad0",
                            "typeId": "3718",
                            "type": "Standard Room",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 69.4323,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 69.4323,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 69.4323,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "64264e7e-945f-42e9-8b91-fea2d10c231f",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "43",
                    "board": "ROOM ONLY",
                    "boardCategories": [
                        "Room only"
                    ],
                    "rooms": [
                        {
                            "id": "421dfd4a-bb2b-40ce-922d-172785018e13",
                            "typeId": "3626",
                            "type": "1 King Deluxe Corner Single Sofa Bed",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 97.2011,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 97.2011,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 97.2011,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "12fb5389-d500-4b56-a887-3b08708d85fb",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "50",
                    "board": "BED AND BREAKFAST",
                    "boardCategories": [
                        "Breakfast"
                    ],
                    "rooms": [
                        {
                            "id": "811a69ef-a561-4d72-a7d3-dc721ccce589",
                            "typeId": "3626",
                            "type": "1 King Deluxe Corner Single Sofa Bed",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 104.1433,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 104.1433,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 104.1433,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "2d97562b-64c0-478b-a143-8ffe0b7500f1",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "43",
                    "board": "ROOM ONLY",
                    "boardCategories": [
                        "Room only"
                    ],
                    "rooms": [
                        {
                            "id": "81bcd587-38fd-4365-949b-a9b8daece1e3",
                            "typeId": "0",
                            "type": "Deluxe Corner Room",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 131.9224,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 131.9224,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 131.9224,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "abb7b2bf-a6fa-4749-af63-5e255433ccc2",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "50",
                    "board": "BED AND BREAKFAST",
                    "boardCategories": [
                        "Breakfast"
                    ],
                    "rooms": [
                        {
                            "id": "eb53d1f8-c671-4a85-b535-334a745dad7e",
                            "typeId": "0",
                            "type": "Deluxe Corner Room",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 138.8543,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 138.8543,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 138.8543,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "18b3a32d-f097-4b5d-ad2a-434ab9dfcaaf",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "4",
                    "board": "HALF BOARD",
                    "boardCategories": [
                        "Half board/modified American plan"
                    ],
                    "rooms": [
                        {
                            "id": "729a1ebe-424c-4d3b-b080-485b911630db",
                            "typeId": "3718",
                            "type": "Standard Room",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 155.5197,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 155.5197,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 155.5197,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "37e664c2-00c0-4daa-a9d0-2df3a0a1ef7f",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "4",
                    "board": "HALF BOARD",
                    "boardCategories": [
                        "Half board/modified American plan"
                    ],
                    "rooms": [
                        {
                            "id": "4f840f8b-7f9b-4ccb-bd78-ebb8ca96d495",
                            "typeId": "3626",
                            "type": "1 King Deluxe Corner Single Sofa Bed",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 190.2307,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 190.2307,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 190.2307,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "15bbe996-10df-4b40-8e33-c34dc7635ffc",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "43",
                    "board": "ROOM ONLY",
                    "boardCategories": [
                        "Room only"
                    ],
                    "rooms": [
                        {
                            "id": "e03783ab-5cfb-4e61-bc85-b36fb125c8f0",
                            "typeId": "0",
                            "type": "Family Room Standard",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 201.3444,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 201.3444,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 201.3444,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "d597e959-12a7-45e3-b389-23acecba4f63",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "50",
                    "board": "BED AND BREAKFAST",
                    "boardCategories": [
                        "Breakfast"
                    ],
                    "rooms": [
                        {
                            "id": "080df472-0c87-46bf-ab8e-41c338632379",
                            "typeId": "0",
                            "type": "Family Room Standard",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 208.2866,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 208.2866,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 208.2866,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "3db58e57-7acb-44b0-bb42-d3f85554468c",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "4",
                    "board": "HALF BOARD",
                    "boardCategories": [
                        "Half board/modified American plan"
                    ],
                    "rooms": [
                        {
                            "id": "aff3e46f-6c37-45f1-bacc-7d81436e9bdd",
                            "typeId": "0",
                            "type": "Deluxe Corner Room",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 224.9417,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 224.9417,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 224.9417,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "db30e2ec-a371-4889-89b7-6806fb700a7b",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "50",
                    "board": "BED AND BREAKFAST",
                    "boardCategories": [
                        "Breakfast"
                    ],
                    "rooms": [
                        {
                            "id": "5c2b2b0a-eb37-4462-bc4c-155ece2b3ec6",
                            "typeId": "49680",
                            "type": "Premium Double",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 249.9398,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 249.9398,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 249.9398,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "4d633e2b-a8e1-4241-81d3-66fb2291c0b4",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "4",
                    "board": "HALF BOARD",
                    "boardCategories": [
                        "Half board/modified American plan"
                    ],
                    "rooms": [
                        {
                            "id": "0ba3cfff-b90e-4866-b061-4b23f171617d",
                            "typeId": "0",
                            "type": "Family Room Standard",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 294.374,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 294.374,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 294.374,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                },
                {
                    "id": "0b179364-6992-4be8-84b0-1cb926fe12ae",
                    "expiresOn": "2023-07-13T13:22:25.7394952Z",
                    "hotelId": "326105",
                    "boardId": "4",
                    "board": "HALF BOARD",
                    "boardCategories": [
                        "Half board/modified American plan"
                    ],
                    "rooms": [
                        {
                            "id": "b37cb4f6-ac2f-4d79-8bb8-cba360f10ec5",
                            "typeId": "49680",
                            "type": "Premium Double",
                            "categories": [],
                            "promotions": [],
                            "travellers": [
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                },
                                {
                                    "type": "adult",
                                    "age": 0,
                                    "nationality": "DE"
                                }
                            ],
                            "price": {
                                "amount": 336.0272,
                                "currency": "EUR"
                            }
                        }
                    ],
                    "price": {
                        "amount": 336.0272,
                        "currency": "EUR"
                    },
                    "minimumSalePrice": {
                        "amount": 0.0,
                        "currency": "EUR"
                    },
                    "isB2CPrice": false,
                    "isSpecial": false,
                    "isAvailable": true,
                    "cancellationPolicies": [
                        {
                            "fee": {
                                "amount": 336.0272,
                                "currency": "EUR"
                            },
                            "afterDate": "2023-08-29T10:00:00Z"
                        }
                    ]
                }
            ],
            "ttydMember": false,
            "badges": [
                "exclusive",
                "recommended",
                "bestvalue",
                "specialoffer"
            ],
            "boardIdsOfHotel": [],
            "minimumPrice": {
                "amount": 62.4901,
                "currency": "EUR"
            },
            "maximumPrice": {
                "amount": 336.0272,
                "currency": "EUR"
            }
        }
    ]
}