orders

Cancel an order

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
order
required
string

ID of the order to cancel.

reason
required
string

The reason for cancelling this order.

post
/orders/cancel
Request samples
application/json
{ "order": "ABCD-1232-ffd1-2121", "reason": "I would like to book another property instead of this one." }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

object
Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": { "status": "successful" } }

Create an order

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
object

Additional information related to the accommodation order.

required
object

The booker's information.

order_token
required
string

A token containing the necessary data to be used for creating this order.

required
object

Payment related information for the order.

post
/orders/create
Request samples
application/json
{ "accommodation": { "label": "Sample label", }, "booker": { "company": "Booking B.V", "email": "test.name@booking.com", "language": "en-gb", "telephone": "12345678" }, "order_token": "sample-token", "payment": { "include_receipt": true, "method": "card", "timing": "pay_at_the_property" } }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

object
Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": { } }

List orders

This endpoint returns basic information for orders filtered according to the input.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
One of:
currency
required
string^[A-Z]{3}$

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. This input determines the currency used in the "booker_currency" fields in the output.

maximum_results
integer multiple of 10 [ 10 .. 100 ]
Default: 100

The maximum number of results to return.

object

The sorting parameters for the response.

required
object

Filtering orders by time range on basis of order "created" or "updated" time. Maximum time range is 7 days (1 week).

post
/orders/details
Request samples
application/json
{ "created": { "from": "2023-02-28T02:00:00+00:00", "to": "2023-02-28T02:00:00+00:00" }, "currency": "EUR", "maximum_results": 20, "sort": { "by": "updated", "direction": "descending" } }
Responses

200

Successful response.

Response Schema: application/json
Array of objects
object

Metadata about the request.

request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ ], "metadata": { "next_page": null, "total_results": 1 } }

List accommodation for orders

This endpoint returns all information for given accommodation orders

SecurityHTTP: BearerAuth
Request
Request Body schema: application/json
One of:
orders
required
Array of strings <= 100 items

List of order IDs for which details should be returned.

currency
string^[A-Z]{3}$

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.

extras
Array of strings

Input parameter to request for additional information about the accommodation order. It should be passed as a JSON array with one or more items.

Items Enum: "accommodation_details" "policies" "extra_charges"
post
/orders/details/accommodations
Request samples
application/json
{ "currency": "USD", "extras": [ "accommodation_details", "policies", "extra_charges" ], "reservations": [ 2321873123, 4666773123 ] }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Array of objects
Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ ] }

Preview an order

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.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
required
object

The booker's information.

currency
required
string^[A-Z]{3}$

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.

required
object

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

post
/orders/preview
Request samples
application/json
{ "booker": { "country": "nl", "platform": "mobile", "travel_purpose": "leisure", }, "currency": "EUR", "accommodation": { "id": 6745031, "checkin": "!START_DATE!", "checkout": "!END_DATE!", } }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

object
Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": { "order_token": "..." } }