POST /orders/preview

This endpoint returns the total final price with final charges, as well as the price breakdown and payment/cancellation policies for each product passed in the input.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

X-Affiliate-Id Integer Yes

Include here your Affiliate identifier number

Request body fields

Name Type Required Description
booker Object Yes

The booker's information.

booker.platform String Yes

The booker platform for showing the platform based deals and prices.

Possible values:

  • "android"
  • "desktop"
  • "mobile"
  • "tablet"
  • "ios"
booker.travel_purpose String No

The travel purpose of the booker.

Possible values:

  • "business"
  • "leisure"
booker.user_groups[] Array No

The user groups that the booker is a member of.

booker.country String Yes

The booker country for showing the best price for that user and obeying laws regarding the display of taxes and fees.

currency String No

A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.

accommodation Object Yes

Input parameter with the checkin and checkout date and all the accommodation products to be ordered.

accommodation.id Integer No

A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling accommodations/details.

accommodation.checkout String No

The checkout date. Must be later than {checkin}. Must be between 1 and 90 days after {checkin}. Must be within 500 days in the future and in the format yyyy-mm-dd.

accommodation.products[] Array No
accommodation.products[].id String No

Unique ID of the product.

accommodation.products[].allocation Object No

The exact allocation of guests to a room.

accommodation.products[].allocation.number_of_adults Integer Yes

The number of adults for this room.

accommodation.products[].allocation.children[] Array No

The children ages for this room.

accommodation.checkin String No

The checkin date. Must be within 500 days in the future and in the format yyyy-mm-dd.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.