Create the search request body with the following fields:

• city: Specify the unique city id for the required destination.

  • Get your city id using the List cities endpoint.
  • In this case for the use case provided, use the one assigned to Amsterdam -2140479.

• booker.country: Specify the country from which the search request is made.

  • Get your two-letter country code using the List countries endpoint.
  • In this case for the use case provided, use (nl).
  • This is required to ensure that the response complies with relevant laws on the display of taxes and fees.
  Note

  The country code must always be in lowercase.

• booker.platform: Specify the platform from which the search request is made.

  • In this case, for the use case provided, use (mobile).
  • This is required so that any platform-based prices and deals can be returned correctly.

• checkin, checkout: Specify the traveller's requested arrival and departure dates (use the YYYY-MM-DD format).

• guests.number_of_rooms and guests.number_of_adults: Specify the number of rooms the traveller needs (1), and the number of adults for the stay (2).

For the provided use case you should create a request body similar to this example:

{
"city": -2140479,
"booker": {
  "country": "nl",
  "platform": "mobile"
},
"checkin": "2023-11-06",
"checkout": "2023-11-08",
"guests": {
  "number_of_rooms": 1,
  "number_of_adults": 2
}
}

→ Try it yourself

To get details about a specific accommodation:

1. Go to the accommodations/search response.
2. Copy the returned accommodation’s unique identifier id.
3. Use it in your /accommodations/details request.
4. The returned response provides all the details about the selected accommodation.

Your request body should look like this:

{
"accommodations": [
    10507360
],
"extras": [
  "description",
  "facilities",
  "payment",
  "photos",
  "policies",
  "rooms"
],
"languages": [
  "en-gb"
]
}

You can optionally remove or include categories from the extras field to narrow down your response: description, facilities, payment, photos, policies, rooms.

→ Try it yourself

To retrieve the availability and prices of a specific accommodation:

1. Go to the accommodations/search response (in step 1).
2. And copy:

• The returned accommodation’s unique identifier id
• The values used for booker, checkin, checkout, and guestsin your search request (Refer to step 1).

3. Paste same values into your /accommodations/availability request.

Your request body should look like this:

{
  "accommodation": 10507360,
  "booker": {
    "platform": "desktop",
    "country": "nl"
  },
  "checkin": "2023-11-06",
  "checkout": "2023-11-08",
  "guests": {
    "number_of_rooms": 1,
    "number_of_adults": 2
  }
}

→ (Try it yourself)

Use the following fields to construct the request body for the preview order:

1. Go to the /accommodations/availability request (in step 4).

2. And copy the used values:

   • The value used for booker.platform (in this case mobile).
   • The booker.country (nl)
   • currency: Use EUR, because the traveller in the example is using your website from the Netherlands.
     • All prices in the response will be shown both in this currency (as booker_currency) and in the accommodation's local currency (as accommodation_currency.)
   • The accommodation’s unique identifier id
   • The used checkin and checkout dates.

3. Paste same values into your /orders/preview request.

4. Go to the /accommodations/availability response (in step 4)

5. Copy the following returned values:

   • recommendation.products.id: This is the id of the cheapest product that meets the search and availability criteria. In this case the value is 1050736002_377311511_0_2_0).
   • accommodation.products.allocation.number_of_adults: Specify the number of adults who will stay in the room used in the product.
     • In this case, use the recommendation.products.number_of_adults value (2)

6. Paste the selected values into your /orders/preview request.

Your request body should look like this example.

{
  "booker": {
    "platform": "mobile",
   "country": "nl"
  },
  "currency": "EUR",
  "accommodation": {
    "id": 10507360,
    "checkin": "2023-11-06",  
    "checkout": "2023-11-08",  
    "products": [
        {
          "id": "1050736002_377311511_0_2_0",
          "allocation": {
              "number_of_adults": 2
          }
        }

→ Try it yourself

Use the following fields to construct the request body:

• booker: Specify the address, email, name and telephone number details of the person who is making the booking (the traveller, in this example).
• order_token: Use the order_token returned in the /orders/preview response.
  • Pass this token to the /orders/create request.
  • Using this token reduces the risk of data mismatch errors between the endpoints and provides a more efficient booking experience.

In the payment object:

• card: Specify the card details provided by the traveller.
• include_receipt: Set to true to generate a receipt that you can provide to the traveller.
• method: Specify the payment method, in this case "card".
• timing: Choose pay_online_now, as this is the only supported option for the selected product.

Your request body should look like this example.

...
"booker": {
  "address": {
    "address_line": "Road-1, house-2",
    "city": "Amsterdam",
    "country": "nl",
    "post_code": "12345"
  },
  "email": "test.name@example.com",
  "name": {
    "first_name": "Test",
    "last_name": "Name"
  },
  "telephone": "12345678"
},
"order_token": "eyJhbGciOiJIUzI1NiJ9.eyJ....<truncated for display in this example>...QytoS0yU",
"payment": {
  "card": {
    "cardholder": "Test Name",
    "cvc": "123",
    "expiry_date": "2030-10",
    "number": "1234123412341234"
  },
  "include_receipt": true,
  "method": "card",
  "timing": "pay_online_now"
    },

}

→ Try it yourself