Affiliate identifier
{ "order": 509430129718799, "reason": "I would like to book another property instead of this one." }
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": { "status": "successful" } }
{ "accommodation": { "label": "Sample label", "products": [ { "id": "333", "bed_configuration": "123456", "guests": [ { "email": "test.name@booking.com", "name": "Test Name" } ] } ], "remarks": { "estimated_arrival_time": { "hour": 12 }, "special_requests": "We will need an extra cot." } }, "booker": { "address": { "address_line": "Road-1, house-2", "city": "Amsterdam", "country": "NL", "post_code": "11111" }, "company": "Booking B.V", "email": "test.name@booking.com", "language": "en-gb", "name": { "first_name": "Test", "last_name": "Name" }, "telephone": "12345678" }, "order_token": "sample-token", "payment": { "card": { "cardholder": "Test Name", "cvc": "111", "expiry_date": "2030-10", "number": "23333333333333" }, "include_receipt": true, "method": "card", "timing": "pay_at_the_property" } }
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": { "accommodation": { "order": "509430129718799", "pincode": "0000", "reservation": 12345678 }, "payment": { "receipt_url": "https://secure.booking.com/payment_receipt.html?bn=0000000000&pincode=0000&lang=en" } } }
This endpoint returns basic information for orders filtered according to the input.
| 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). |
{ "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" } }
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ { "id": "509430129718799", "accommodations": { "reservation": 12345677 }, "affiliate": 111111, "booker": { "address": { "city": "Amsterdam", "country": "nl" }, "email": "johndoe@booking.com", "language": "en-gb", "name": { "first_name": "john", "last_name": "doe" }, "platform": "mobile", "telephone": "+100000000", "travel_purpose": "business" }, "commission": { "actual_amount": 17.5, "estimated_amount": null }, "created": "2023-02-28T02:00:00+00:00", "currency": "EUR", "loyalty_reward": [ { "amount": 15, "currency": "USD", "eligible": true, "fulfillment_at": "2023-02-10", "fulfillment_by": "partner", "loyalty_data": [ { "name": "Email Id", "value": "john_doe@booking.com" }, { "name": "Loyalty ID", "value": "10101010" } ], "type": "point" } ], "price": { "commissionable": 160, "total": 170.01 }, "status": "booked", "updated": "2023-02-28T02:00:00+00:00" } ], "metadata": { "next_page": null, "total_results": 1 } }
This endpoint returns all information for given accommodation orders
| 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. |
{ "currency": "USD", "extras": [ "accommodation_details", "policies", "extra_charges" ], "reservations": [ 2321873123, 4666773123 ] }
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ { "id": "509430129718799", "accommodation": 123456, "accommodation_details": { "email": "test_hotel@booking.com", "location": { "address": "111 Street Road", "city": 20089219, "coordinates": { "latitude": 11.923274, "longitude": -92.716188 }, "country": "us", "post_code": "NY 1234" }, "name": "Test Booking Hotel USA", "telephone": "+19876543210" }, "accommodation_order_references": [ "12345", "ABED2312" ], "cancellation_details": { "at": "2022-11-09T00:00:00+00:00", "fee": { "accommodation_currency": 170.01, "booker_currency": 186.87 } }, "checkin": "2022-11-10", "checkout": "2022-11-10", "commission": { "actual_amount": null, "actual_percentage": null, "estimated_amount": { "accommodation_currency": 17.5, "booker_currency": 19.23 } }, "currency": { "accommodation": "EUR", "booker": "USD" }, "label": "One123", "pin_code": "1234", "price": { "commissionable": { "accommodation_currency": 164.01, "booker_currency": 180.27 }, "total": { "accommodation_currency": 170.01, "booker_currency": 186.87 } }, "products": [ { "allocation": { "adults": 2, "children": [ 3, 4, 5 ], "guests": 5 }, "guests": [ { "email": "test.name@booking.com", "name": "Test Name" } ], "policies": { "cancellation": [ { "from": null, "price": { "accommodation_currency": 170.01, "booker_currency": 186.87 } } ], "meal_plan": { "meals": [ "breakfast" ], "plan": "breakfast_included" }, "smoking_preference": "non-smoking" }, "price": { "base": { "accommodation_currency": 170.01, "booker_currency": 186.87 }, "extra_charges": { "conditional": [ ], "non_conditional": [ { "charge": 142, "mode": "per_person_per_night", "percentage": null, "total_amount": { "accommodation_currency": 6, "booker_currency": 6.6 }, "unit_amount": { "accommodation_currency": 3, "booker_currency": 3.3 } }, { "charge": 21, "mode": "percentage", "percentage": 9, "total_amount": { "accommodation_currency": 14.04, "booker_currency": 15.43 }, "unit_amount": null }, { "charge": 22, "mode": "percentage", "percentage": 7, "total_amount": { "accommodation_currency": 10.92, "booker_currency": 12 }, "unit_amount": null } ] }, "total": { "accommodation_currency": 200.97, "booker_currency": 220.9 } }, "room": 12345, "room_details": { "name": "Double Deluxe Room" }, "status": "booked" } ], "remarks": "We will need an extra cot. Need room on higher floor", "reservation": 12345678, "status": "booked" } ] }
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.
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. |
{ "booker": { "country": "nl", "platform": "mobile", "travel_purpose": "leisure", "user_groups": [ "genius2" ] }, "currency": "EUR", "accommodation": { "id": 6745031, "checkin": "!START_DATE!", "checkout": "!END_DATE!", "products": [ { "id": "674503106_275710478_0_2_0", "allocation": { "number_of_adults": 1, "children": [ 8 ] } }, { "id": "674503113_275710486_0_1_0", "allocation": { "number_of_adults": 1, "children": [ ] } } ] } }
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": { "accommodation": { "currency": { "accommodation": "EUR", "booker": null }, "price": { "base": { "accommodation_currency": 100, "booker_currency": null }, "total": { "accommodation_currency": 123, "booker_currency": null }, "extra_charges": { "conditional": [ ], "non_conditional": [ { "charge": 142, "total_amount": { "accommodation_currency": 6, "booker_currency": null } }, { "charge": 21, "total_amount": { "accommodation_currency": 14.67, "booker_currency": null } }, { "charge": 22, "total_amount": { "accommodation_currency": 11.41, "booker_currency": null } } ] } }, "general_policies": { "payment": { "pay_online_now": { "dates": [ { "at": "!TODAY!", "price": { "accommodation_currency": 177.65, "booker_currency": null } } ], "method_required": false, "methods": { "airplus": true, "cards": [ 1, 2, 3 ], "wallet": true } }, "pay_online_later": { "dates": [ { "at": "!TODAY!", "price": { "accommodation_currency": 0, "booker_currency": null } }, { "at": "!START_DATE-2!", "price": { "accommodation_currency": 177.65, "booker_currency": null } }, { "at": "!START_DATE!", "price": { "accommodation_currency": 0, "booker_currency": null } } ], "method_required": false, "methods": { "airplus": true, "cards": [ 1, 2, 3, 5 ], "wallet": true } }, "pay_at_the_property": { "dates": [ { "at": "!TODAY!", "price": { "accommodation_currency": 0, "booker_currency": null } }, { "at": "!START_DATE!", "price": { "accommodation_currency": 177.65, "booker_currency": null } } ], "method_required": true, "methods": { "airplus": true, "cards": [ 1, 2 ], "wallet": false } } } }, "products": [ { "id": "1000420_278556531_2_0_0", "policies": { "cancellation": [ { "from": "now", "price": { "accommodation_currency": 0, "booker_currency": null } }, { "from": "!START_DATE-2!T22:00:00+00:00", "price": { "accommodation_currency": 177.65, "booker_currency": null } } ], "meal_plan": { "meals": [ ], "plan": "no_plan" } }, "price": { "base": { "accommodation_currency": 155.96, "booker_currency": null }, "extra_charges": { "conditional": [ ], "non_conditional": [ { "charge": 142, "mode": "per_person_per_night", "percentage": null, "total_amount": { "accommodation_currency": 6, "booker_currency": null }, "unit_amount": 3 }, { "charge": 21, "mode": "percentage", "percentage": 9, "total_amount": { "accommodation_currency": 14.04, "booker_currency": null }, "unit_amount": null }, { "charge": 22, "mode": "percentage", "percentage": 7, "total_amount": { "accommodation_currency": 10.92, "booker_currency": null }, "unit_amount": null } ] }, "total": { "accommodation_currency": 186.92, "booker_currency": null } } }, { "id": "1000420_95127794_2_0_0", "policies": { "cancellation": [ { "from": "now", "price": { "accommodation_currency": 170, "booker_currency": null } } ], "meal_plan": { "meals": [ ], "plan": "no_plan" } }, "price": { "base": { "accommodation_currency": 162.98, "booker_currency": null }, "extra_charges": { "conditional": [ { "charge": 3, "condition": 30, "mode": "per_stay", "percentage": null, "total_amount": { "accommodation_currency": 10, "booker_currency": null }, "unit_amount": null } ], "non_conditional": [ { "charge": 142, "mode": "per_person_per_night", "percentage": null, "total_amount": { "accommodation_currency": 6, "booker_currency": null }, "unit_amount": { "accommodation_currency": 3, "booker_currency": null } }, { "charge": 21, "mode": "percentage", "percentage": 9, "total_amount": { "accommodation_currency": 14.67, "booker_currency": null }, "unit_amount": null }, { "charge": 22, "mode": "percentage", "percentage": 7, "total_amount": { "accommodation_currency": 11.41, "booker_currency": null }, "unit_amount": null } ] }, "total": { "accommodation_currency": 195.06, "booker_currency": null } } } ] }, "order_token": "..." } }