openapi: 3.1.0
info:
title: Booking.com Demand Accommodations Orders API
version: '3.1'
summary: "The Booking.com Demand API enables Affiliate Partners to access Booking.com's travel inventory, including accommodations, car rentals, and flights. \n\nUse Demand API to search, retrieve details, check availability, manage bookings and run reports using orders details.\n\n- RESTful API with JSON responses.\n- Make HTTPS POST requests to interact with endpoints.\n- Requires authentication using your Affiliate ID and token credentials.\n\n[Check the try out guide!](/demand/docs/getting-started/try-out-the-api)\n"
x-last-validated: '2026-06-02'
x-generated-from: documentation
description: This API collection is specific for the stay part of the connected trip. Use these endpoints to search for stays such as hotels and apartments, check availability, retrieve reviews, and get detailed property information.
servers:
- url: https://demandapi.booking.com/3.1
description: Production environment
- url: https://demandapi-sandbox.booking.com/3.1
description: Sandbox environment
security:
- BearerAuth: []
tags:
- name: Orders
x-displayName: Orders
description: 'Enables management of booking orders within the Demand API. Use these endpoints to preview and create new orders, check order details, cancel or modify existing orders. This collection is required to integrate booking and order management functionality. '
paths:
/orders/preview:
post:
summary: Booking.com Preview an Order
description: 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.
operationId: ordersPreview
parameters:
- $ref: '#/components/parameters/AffiliateIdHeader'
tags:
- Orders
requestBody:
content:
application/json:
schema:
title: OrdersPreviewInput
type: object
properties:
booker:
title: OrdersPreviewBookerOutput
description: The booker's information.
type: object
properties:
country:
description: The booker country for showing the best price for that user and obeying laws regarding the display of taxes and fees.
type: string
pattern: ^[a-z]{2}$
platform:
description: The booker platform for showing the platform based deals and prices.
type: string
enum:
- android
- desktop
- ios
- mobile
- tablet
travel_purpose:
description: The travel purpose of the booker.
type: string
enum:
- business
- leisure
user_groups:
description: The user groups that the booker is a member of.
type: array
items:
type: string
enum:
- authenticated
required:
- country
- platform
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
accommodation:
title: OrdersPreviewAccommodationInput
description: Input parameter with the checkin and checkout date and all the accommodation products to be ordered.
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
checkin:
description: The checkin date. Must be within 500 days in the future and in the format yyyy-mm-dd.
type: string
format: date
checkout:
description: 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.
type: string
format: date
products:
type: array
items:
title: OrdersPreviewProductInput
description: Input parameter with the product id and the desired allocation for that product
type: object
properties:
id:
description: Unique ID of the product.
type: string
allocation:
title: OrdersPreviewAccommodationAllocationOutput
description: The exact allocation of guests to a room.
type: object
properties:
children:
description: The children ages for this room.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults for this room.
type: integer
minimum: 1
required:
- number_of_adults
required:
- booker
- accommodation
example:
booker:
country: nl
platform: mobile
travel_purpose: leisure
user_groups:
- authenticated
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: []
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: OrdersPreviewOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
title: OrdersPreviewDataOutput
description: ''
type: object
properties:
accommodation:
title: OrdersPreviewAccommodationOutput
description: The products to order related to an accommodation
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
currency:
title: OrdersPreviewCurrencyOutput
type: object
properties:
accommodation:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
booker:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
general_policies:
properties:
payment:
title: AccommodationsProductPaymentTimingsDates
description: ''
type: object
properties:
pay_online_now:
title: AccommodationsPayOnlineNow
type:
- object
- 'null'
properties:
dates:
description: Schedule specifying the instalments for paying the order for the "pay_online_now" option. For each,entry in the schedule, a charge will be made at the time of that entry.
type: array
items:
title: AccommodationsPaymentSchedule
type: object
properties:
at:
description: The date at which this instalment will be charged.
type: string
format: date
price:
description: The amount charged in this instalment.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
method_required:
description: Whether a payment method is required for this payment timing.
type: boolean
methods:
title: AccommodationsPaymentMethods
type: object
description: The payment methods available for the payment timing selected.
properties:
airplus:
description: Whether airplus can be used as a payment method for this order.
type: boolean
cards:
description: The cards available to pay.
type: array
items:
description: A signed integer number that uniquely identifies a payment type. Examples of payment types are the different credit and debit cards. The full list can be obtained by calling common/payments/cards.
type: integer
minimum: 1
wallet:
description: Whether wallet can be used as a payment method for this order.
type: boolean
nullable: true
pay_online_later:
title: AccommodationsPayOnlineLater
type: object
properties:
dates:
description: Schedule specifying the instalments for paying the order for this product for the "pay_online_later" option. For each entry in the schedule, a charge will be made at the time of that entry.
type: array
items:
title: AccommodationsPaymentSchedule
type: object
properties:
at:
description: The date at which this instalment will be charged.
type: string
format: date
price:
description: The amount charged in this instalment.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
method_required:
description: Whether a payment method is required for this payment timing.
type: boolean
methods:
title: AccommodationsPaymentMethods
type: object
description: The payment methods available for the payment timing selected.
properties:
airplus:
description: Whether airplus can be used as a payment method for this order.
type: boolean
cards:
description: The cards available to pay.
type: array
items:
description: A signed integer number that uniquely identifies a payment type. Examples of payment types are the different credit and debit cards. The full list can be obtained by calling common/payments/cards.
type: integer
minimum: 1
wallet:
description: Whether wallet can be used as a payment method for this order.
type: boolean
nullable: true
nullable: true
pay_at_the_property:
title: AccommodationsPayAtTheProperty
type: object
properties:
dates:
description: Schedule specifying the instalments for paying the order for this product for the "pay_at_the_property" option. For each entry in the schedule, a charge will be made at the time of that entry.
type: array
items:
title: AccommodationsPaymentSchedule
type: object
properties:
at:
description: The date at which this instalment will be charged.
type: string
format: date
price:
description: The amount charged in this instalment.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
method_required:
description: Whether a payment method is required for this payment timing.
type: boolean
methods:
title: AccommodationsPaymentMethods
type: object
description: The payment methods available for the payment timing selected.
properties:
airplus:
description: Whether airplus can be used as a payment method for this order.
type: boolean
cards:
description: The cards available to pay.
type: array
items:
description: A signed integer number that uniquely identifies a payment type. Examples of payment types are the different credit and debit cards. The full list can be obtained by calling common/payments/cards.
type: integer
minimum: 1
wallet:
description: Whether wallet can be used as a payment method for this order.
type: boolean
nullable: true
nullable: true
price:
title: OrdersPreviewProductSumPriceOutput
description: The price components of all the products selected summed
type: object
properties:
base:
description: The sum base price of all products selected. Does not include any extra charges.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The price that will be charged by Booking.com when online payments are used. This field does not apply to the "pay_at_the_property" timing.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
total:
description: The total sum price. Includes all extra charges of all products.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
extra_charges:
description: The sum of charges for all products selected, grouped by charge type.
conditional:
description: The sum of conditional charges for all products selected, grouped by charge type.
type: array
items:
$ref: ../accommodations/dataTypes.json#/conditionalChargeMultiCurrencySummary
non_conditional:
description: The sum of non-conditional charges for all products selected, grouped by charge type.
type: array
items:
$ref: ../accommodations/dataTypes.json#/conditionalChargeMultiCurrencySummary
products:
type: array
items:
title: OrdersPreviewProductOutput
description: The returned information of the product selected
type: object
properties:
id:
description: Unique ID of the product.
type: string
bundle:
description: The bundle ID of the product comprising of value added products.
type: integer
deal:
title: Deal
description: This specifies the deal tagging for the product.
type:
- object
- 'null'
properties:
discount_percentage:
description: Discount percentage of the applied deal.
type: integer
minimum: 1
public_price:
description: Original price of this product, before applying any discounts.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
tags:
description: The tags of all the applied deals.
type: array
items:
type: string
enum:
- black_friday
- limited_time_deal
- logged_in_deal
- mobile_rate
- seasonal_deal
inventory:
title: InventoryOutput
type: object
properties:
third_party:
type: boolean
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type:
description: Type of inventory - either net or sell rates.
type: string
enum:
- net
- sell
policies:
title: AccommodationsProductDetailedPoliciesMultiCurrency
description: The policies for this product.
type: object
properties:
cancellation:
description: The cancellation policy schedule for this product.
type: array
items:
title: AccommodationsProductDetailedCancellationPolicyMultiCurrency
type: object
properties:
from:
description: The time from which this cancellation fee applies. `now` means from booking time.
oneOf:
- type: string
format: date-time
- type: string
pattern: now
- type: 'null'
price:
description: The cancellation fee.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
meal_plan:
title: AccommodationsProductMealPlanPolicy
description: The meal plan policy for this product.
type: object
properties:
meals:
description: The meals included in the meal plan.
type: array
items:
type: string
enum:
- breakfast
- dinner
- lunch
plan:
description: The meal plan included in this product.
type: string
enum:
- all_inclusive
- breakfast_included
- full_board
- half_board
- no_plan
price:
title: OrdersPreviewProductPriceOutput
description: The price components of this product. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The price that will be charged by Booking.com when online payments are used. This field does not apply to the "pay_at_the_property" timing.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
extra_charges:
title: OrdersPreviewProductExtraChargesOutput
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
conditional:
description: Charges that might apply under a specific condition.
type: array
items:
title: AccommodationsConditionalChargeMultiCurrency
description: Charges that might apply under a specific condition.
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
condition:
description: A signed integer number that uniquely identifies the condition ID. Find the full list in the Pricing guidelines.
type:
- integer
- 'null'
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
non_conditional:
description: All non-conditional charges that will necessarily be paid
type: array
items:
title: AccommodationsChargeMultiCurrency
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
chargeable_online:
description: Whether this charge is chargeable online or not. Not applicable to "pay_at_the_property" timing.
type: boolean
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
total:
description: The total price. Includes all extra charges.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
room:
description: A signed long number that uniquely identifies an accommodation property room. The full list can be obtained by calling [accommodations/details](#/accommodations/details).
type: number
minimum: 1
nullable: true
third_party_inventory:
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type: boolean
occupancy_mismatch:
description: "Details any mismatch between the requested occupancy and the product's capacity. \n-When one or more guests cannot be accommodated, the object contains those that can be accommodated (allocated) and those that cannot (unallocated). \n-If all requested guests fit, the object is null."
title: OccupancyMismatchOutput
type:
- object
- 'null'
properties:
allocated:
description: The guests from the original request that the product can accommodate.
title: OccupancyOutput
type: object
properties:
number_of_adults:
description: The number of adults.
type: integer
minimum: 0
children:
description: The ages of the children. Null or absent if no children fit.
type:
- array
- 'null'
items:
type: integer
minimum: 0
maximum: 17
required:
- number_of_adults
- children
unallocated:
description: The guests from the original request that could not be accommodated by this product.
title: OccupancyOutput
type: object
properties:
number_of_adults:
description: The number of adults.
type: integer
minimum: 0
children:
description: The ages of the children. Null or absent if no children fit.
type:
- array
- 'null'
items:
type: integer
minimum: 0
maximum: 17
required:
- number_of_adults
- children
required:
- allocated
- unallocated
example:
allocated:
number_of_adults: 1
children: null
unallocated:
number_of_adults: 1
children: null
order_token:
description: A token containing the necessary data to be used on subsequent requests to [orders/create].
type: string
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
accommodation:
id: 6745031
currency:
accommodation: EUR
booker: 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
price:
base:
accommodation_currency: 100
booker_currency: null
chargeable_online:
accommodation_currency: 100
booker_currency: null
total:
accommodation_currency: 123
booker_currency: null
extra_charges:
conditional: []
non_conditional:
- charge: 142
chargeable_online: true
total_amount:
accommodation_currency: 6
booker_currency: null
- charge: 21
chargeable_online: false
total_amount:
accommodation_currency: 14.67
booker_currency: null
- charge: 22
chargeable_online: true
total_amount:
accommodation_currency: 11.41
booker_currency: null
products:
- id: '1000420_278556531_2_0_0'
bundle: null
deal: null
inventory:
third_party: false
type: sell
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
chargeable_online:
accommodation_currency: 186.92
booker_currency: null
extra_charges:
conditional: []
non_conditional:
- charge: 142
chargeable_online: true
mode: per_person_per_night
percentage: null
total_amount:
accommodation_currency: 6
booker_currency: null
unit_amount: 3
- charge: 21
chargeable_online: false
mode: percentage
percentage: 9
total_amount:
accommodation_currency: 14.04
booker_currency: null
unit_amount: null
- charge: 22
chargeable_online: true
mode: percentage
percentage: 7
total_amount:
accommodation_currency: 10.92
booker_currency: null
unit_amount: null
total:
accommodation_currency: 186.92
booker_currency: null
third_party_inventory: false
- id: tpi-1000420_95127794_2_0_0
deal: null
inventory:
third_party: true
type: sell
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
third_party_inventory: true
order_token: '...'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orders/create:
post:
summary: Booking.com Create an Order
description: Use this endpoint to confirm the booking and proceed the payment.
operationId: ordersCreate
parameters:
- $ref: '#/components/parameters/AffiliateIdHeader'
tags:
- Orders
requestBody:
content:
application/json:
schema:
title: OrderCreateInput
type: object
properties:
accommodation:
title: OrderCreateAccommodationInput
description: Additional information related to the accommodation order.
type: object
properties:
label:
description: A label for this order. This can be read back later while fetching this order details.
type: string
products:
description: ''
type: array
items:
title: OrderCreateProductInformationInput
description: Additional information related to each product related to the products in this order.
type: object
properties:
id:
description: ID for this product. `Please note that this MUST match the product IDs used for related /orders/preview request.`
type: string
bed_configuration:
description: Bed configuration ID to select for this product. `Please note that it can not be guaranteed that the selected bed_configuration will be available.`
type: string
guests:
description: The guest details for this product.
type: array
items:
title: OrderCreateGuestInput
type: object
properties:
email:
description: The email address of the guest.
type: string
name:
description: The name of the guest.
type: string
required:
- email
- name
required:
- id
remarks:
title: OrderCreateRemarksInput
description: Optional remarks from the guest.
type: object
properties:
estimated_arrival_time:
title: EstimatedArrivalTimeInput
description: Estimated arrival time of the guests.
type: object
properties:
hour:
description: Approximate hour of arrival to the hotel. Allowed values are from 0 to 23. This time should be within the hotel reception hours, or will be ignored otherwise with a warning will be appended to special_requests.
type: integer
minimum: 0
maximum: 23
next_day:
description: Set this to true, if the hour selected is for the day after checkin.
type: boolean
default: 'false'
required:
- hour
special_requests:
description: Optional comments or requests from the guest. Special requests cannot be guaranteed – but the property will do its best to meet your needs.
type: string
booker:
title: OrderCreateBookerInput
description: The booker's information.
type: object
properties:
address:
title: OrderCreateAddressInput
description: The booker's address to be used for creating this order. All fields of this object are required if the /accommodations/details endpoint indicates that the booker's address is necessary by returning booker_address_required=true.
type: object
properties:
address_line:
description: The details of this address.
type: string
city:
description: The city for this address.
type: string
country:
description: The country for this address.
type: string
pattern: ^[a-z]{2}$
example: nl
post_code:
description: Post code for this address.
type: string
required:
- country
company:
description: The booker's company name.
type: string
email:
description: The booker's email address.
type: string
language:
description: 'A [IETF language tag code](https://en.wikipedia.org/wiki/IETF_language_tag) that uniquely identifies a supported human language or dialect. **Note:** Demand API only accepts lowercase for the language codes. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
name:
title: OrderCreateBookerNameInput
description: The name of the booker.
type: object
properties:
first_name:
type: string
last_name:
type: string
required:
- first_name
- last_name
telephone:
description: The booker's telephone number.
type: string
required:
- address
- email
- name
- telephone
order_token:
description: A token containing the necessary data to be used for creating this order.
type: string
payment:
title: OrderCreatePaymentInput
description: Payment related information for the order.
type: object
properties:
airplus:
description: All information related to airplus payment. `This is required if airplus is selected as payment method.`
type: object
properties:
dbi:
title: OrderCreateDbiInput
description: Descriptive billing information(dbi) details to pass to AirPlus.
type: object
properties:
accounting_code:
description: Accounting code to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
accounting_unit:
description: Accounting unit to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
cost_centre:
description: Cost centre to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
department_code:
description: Department code to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
employee_number:
description: Employee number to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
internal_account:
description: Internal account to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
order_number:
description: Order number to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
project_number:
description: Project number to pass in descriptive billing information.
type: string
minLength: 1
maxLength: 17
number:
description: 12 digit Airplus Number.
type: string
required:
- number
business_information:
title: OrderCreateBusinessInformationInput
description: All business related information for billing and authorisation form. This must be included for the payments that require authorisation form.
type: object
properties:
authorisation_form:
title: OrderCreateAuthorisationFormInput
description: Information that is relevant for generating an authorisation form.
type: object
properties:
chargeable_items:
description: Items which can be charged using a provided virtual credit card.
type: array
items:
type: string
enum:
- alcohol
- breakfast
- food_beverage
- internet
- parking
- phone
- taxes
billing:
title: OrderCreateBillingInput
description: All information to be used in the invoice.
type: object
properties:
address:
title: OrderCreateBusinessAddressInput
description: The address to bill this reservation
type: object
properties:
address_line:
description: The details of this address.
type: string
city:
description: The city for this address.
type: string
country:
description: The country for this address.
type: string
pattern: ^[a-z]{2}$
example: nl
post_code:
description: Post code for this address.
type: string
email:
description: Email to send the invoice to.
type: string
vat:
description: VAT number to be used in the invoice.
type: string
required:
- email
- vat
company:
description: Company that will issue an authorisation form for the virtual credit card and used in the invoice.
type: string
required:
- company
card:
title: OrderCreateCardInput
description: Card information for executing the payment.
type: object
properties:
authentication:
title: OrderCreateCardAuthenticationInput
description: Card authentication information for executing the payment.
type: object
properties:
riskified:
title: OrderCreateRiskifiedInput
description: Riskified information for external fraud verification.
type: object
properties:
ip_address:
description: The booker's IP address.
type: string
format: ipv4
session_id:
description: Riskified provided session_id for external fraud verification.
type: string
required:
- ip_address
- session_id
sca_exemption:
description: The type of SCA exemption to be applied to the payment.
type: string
enum:
- moto
- virtual
3d_secure:
title: OrderCreate3dSecureInput
description: 3-factor authentication information for the card.
type: object
properties:
authentication_value:
description: Cardholder Authentication Verification Value.
type: string
cavv:
deprecated: true
description: Deprecated. Do not use
type: string
eci:
description: The electronic commerce indicator.
type: string
transaction:
description: The unique ID assigned by the DS to identify a single transaction.
type: string
required:
- authentication_value
- eci
- transaction
cardholder:
description: Name of the cardholder.
type: string
cvc:
description: 3 or 4 digits card validation code (CVC) of this card.
type: string
expiry_date:
description: 'Expiry date of the card. Format: YYYY-MM'
type: string
number:
description: Number of the card.
type: string
required:
- cardholder
- cvc
- expiry_date
- number
include_receipt:
description: This is used to determine whether to include payment `receipt_url` in the response or not.
type: boolean
method:
description: The payment method to be used for this order.
type: string
enum:
- airplus
- card
- wallet
timing:
description: Information about when to execute the payment.
type: string
enum:
- pay_at_the_property
- pay_online_later
- pay_online_now
required:
- timing
required:
- booker
- order_token
- payment
example:
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
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: OrderCreateOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
title: OrderCreateDataOutput
type: object
properties:
accommodation:
title: OrderCreateAccommodationOutput
description: All accommodation related information for this order.
type: object
properties:
order:
description: ID for this accommodation order.
type: string
pincode:
description: Pincode for this accommodation order.
type: string
reservation:
description: Reservation ID for this accommodation order.
type: integer
format: int64
third_party_inventory:
title: Third party inventory related information for the created order. This field is only available for third party inventory orders.
type: object
properties:
checkin_number:
description: The number required at the time of check-in. It allows guests to confirm their order at the accommodation.
type: string
example: '473026811'
confirmation_number:
description: The confirmation number, when used in conjunction with the pincode, helps verify the customer's order and facilitates efficient support during inquiries or troubleshooting.
type: string
example: '12365478936925814787'
payment:
title: OrderCreatePaymentOutput
description: All payment related information for this order.
type: object
properties:
authorisation_form_url:
description: Link to a virtual credit card''s authorisation form, valid for 7 minutes from issue. `This will only the added if the request has authorisation_form.`
type: string
format: uri
example: https://secure-admin.booking.com/airplus_auth_form_pdf.html?token=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&lang=en
receipt_url:
description: Link to the payment receipt of the order. `This will only be added if include_receipt is true.`
type: string
format: uri
example: https://secure.booking.com/payment_receipt.html?bn=0000000000&pincode=0000&lang=en
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
accommodation:
order: '509430129718799'
pincode: '0000'
reservation: 12345678
third_party_inventory:
checkin_number: '123456789'
confirmation_number: '12345678912345678912'
payment:
receipt_url: https://secure.booking.com/payment_receipt.html?bn=0000000000&pincode=0000&lang=en
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orders/details:
post:
summary: Booking.com Orders Details
description: This endpoint returns basic information for orders filtered according to the input.
operationId: ordersDetails
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Orders
requestBody:
content:
application/json:
schema:
oneOf:
- title: InputByUpdated
type: object
properties:
updated:
title: OrderDetailsDatetimeFilterInput
description: Filtering orders by time range on basis of order "created" or "updated" time. Maximum time range is 7 days (1 week).
type: object
properties:
from:
description: ISO 8601 timestamp in UTC, which indicates the timestamp from which you want to filter orders from (inclusive). The value should be within last 1 year.
type: string
format: date-time
to:
description: ISO 8601 timestamp in UTC, which indicates the timestamp till which you want to filter orders to (inclusive). It has to be greater than or equal to "from".
type: string
format: date-time
required:
- from
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
maximum_results:
description: The maximum number of results to return.
type: integer
multipleOf: 10
minimum: 10
maximum: 100
default: 100
sort:
title: OrderDetailsSortInput
description: The sorting parameters for the response.
type: object
properties:
by:
description: The way to sort your results.
type: string
enum:
- created
- updated
default: created
direction:
description: The direction you wish for your sort.by parameter to be sorted in.
type: string
enum:
- ascending
- descending
default: descending
required:
- by
- direction
extras:
description: Input parameter to request for additional information about this order.
type: array
items:
type: string
enum:
- payment
services:
description: Filter orders by included services.
type: array
items:
type: string
enum:
- accommodations
- cars
- flights
required:
- updated
- currency
- title: InputByCreated
type: object
properties:
created:
title: OrderDetailsDatetimeFilterInput
description: Filtering orders by time range on basis of order "created" or "updated" time. Maximum time range is 7 days (1 week).
type: object
properties:
from:
description: ISO 8601 timestamp in UTC, which indicates the timestamp from which you want to filter orders from (inclusive). The value should be within last 1 year.
type: string
format: date-time
to:
description: ISO 8601 timestamp in UTC, which indicates the timestamp till which you want to filter orders to (inclusive). It has to be greater than or equal to "from".
type: string
format: date-time
required:
- from
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
maximum_results:
description: The maximum number of results to return.
type: integer
multipleOf: 10
minimum: 10
maximum: 100
default: 100
sort:
title: OrderDetailsSortInput
description: The sorting parameters for the response.
type: object
properties:
by:
description: The way to sort your results.
type: string
enum:
- created
- updated
default: created
direction:
description: The direction you wish for your sort.by parameter to be sorted in.
type: string
enum:
- ascending
- descending
default: descending
required:
- by
- direction
extras:
description: Input parameter to request for additional information about this order.
type: array
items:
type: string
enum:
- payment
services:
description: Filter orders by included services.
type: array
items:
type: string
enum:
- accommodations
- cars
- flights
required:
- created
- currency
- title: InputByStart
type: object
properties:
start:
title: OrderDetailsDateFilterInput
description: Filter orders by date range, covering the "start" and "end" date. The maximum date range is up to 7 days (1 week).
type: object
properties:
from:
description: ISO 8601 date in "YYYY-MM-DD" format. It indicates from which date you want to filter the orders. You can filter orders up to 1 year in the past and 500 days in the future.
type: string
format: date
example: '2024-06-01'
to:
description: ISO 8601 date in "YYYY-MM-DD" format. It indicates until which date you want to filter the orders to (inclusive). It has to be greater than or equal to "from". It uses "from" value as default.
type: string
format: date
example: '2024-06-03'
required:
- from
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
maximum_results:
description: The maximum number of results to return.
type: integer
multipleOf: 10
minimum: 10
maximum: 100
default: 100
sort:
title: OrderDetailsSortInput
description: The sorting parameters for the response.
type: object
properties:
by:
description: The way to sort your results.
type: string
enum:
- created
- updated
default: created
direction:
description: The direction you wish for your sort.by parameter to be sorted in.
type: string
enum:
- ascending
- descending
default: descending
required:
- by
- direction
extras:
description: Input parameter to request for additional information about this order.
type: array
items:
type: string
enum:
- payment
services:
description: Filter orders by included services.
type: array
items:
type: string
enum:
- accommodations
- cars
- flights
required:
- start
- currency
- title: InputByEnd
type: object
properties:
end:
title: OrderDetailsDateFilterInput
description: Filter orders by date range, covering the "start" and "end" date. The maximum date range is up to 7 days (1 week).
type: object
properties:
from:
description: ISO 8601 date in "YYYY-MM-DD" format. It indicates from which date you want to filter the orders. You can filter orders up to 1 year in the past and 500 days in the future.
type: string
format: date
example: '2024-06-01'
to:
description: ISO 8601 date in "YYYY-MM-DD" format. It indicates until which date you want to filter the orders to (inclusive). It has to be greater than or equal to "from". It uses "from" value as default.
type: string
format: date
example: '2024-06-03'
required:
- from
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
maximum_results:
description: The maximum number of results to return.
type: integer
multipleOf: 10
minimum: 10
maximum: 100
default: 100
sort:
title: OrderDetailsSortInput
description: The sorting parameters for the response.
type: object
properties:
by:
description: The way to sort your results.
type: string
enum:
- created
- updated
default: created
direction:
description: The direction you wish for your sort.by parameter to be sorted in.
type: string
enum:
- ascending
- descending
default: descending
required:
- by
- direction
extras:
description: Input parameter to request for additional information about this order.
type: array
items:
type: string
enum:
- payment
services:
description: Filter orders by included services.
type: array
items:
type: string
enum:
- accommodations
- cars
- flights
required:
- end
- currency
- title: InputByOrders
type: object
properties:
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
orders:
description: List of order IDs for which details should be returned.
type: array
items:
description: Order ID for which details should be returned.
type: string
maxItems: 100
sort:
title: OrderDetailsSortInput
description: The sorting parameters for the response.
type: object
properties:
by:
description: The way to sort your results.
type: string
enum:
- created
- updated
default: created
direction:
description: The direction you wish for your sort.by parameter to be sorted in.
type: string
enum:
- ascending
- descending
default: descending
required:
- by
- direction
extras:
description: Input parameter to request for additional information about this order.
type: array
items:
type: string
enum:
- payment
services:
description: Filter orders by included services.
type: array
items:
type: string
enum:
- accommodations
- cars
- flights
required:
- orders
- currency
- title: InputByReservations
type: object
properties:
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
reservations:
description: List of reservation IDs for which details should be returned.
type: array
items:
type: string
maxItems: 100
sort:
title: OrderDetailsSortInput
description: The sorting parameters for the response.
type: object
properties:
by:
description: The way to sort your results.
type: string
enum:
- created
- updated
default: created
direction:
description: The direction you wish for your sort.by parameter to be sorted in.
type: string
enum:
- ascending
- descending
default: descending
required:
- by
- direction
extras:
description: Input parameter to request for additional information about this order.
type: array
items:
type: string
enum:
- payment
services:
description: Filter orders by included services.
type: array
items:
type: string
enum:
- accommodations
- cars
- flights
required:
- reservations
- currency
- title: InputByPage
type: object
properties:
page:
description: Pagination token used to retrieve the next page of results. Obtained from `next_page`.
type: string
extras:
description: Input parameter to request for additional information about this order.
type: array
items:
type: string
enum:
- payment
required:
- page
example:
created:
from: '2025-07-28T02:00:00+00:00'
to: '2025-07-28T02:00:00+00:00'
currency: EUR
maximum_results: 20
sort:
by: updated
direction: descending
extras:
- payment
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: OrderDetailsOutput
type: object
properties:
data:
type: array
items:
title: OrderDetailsDataOutput
description: All details for this order.
type: object
properties:
id:
description: The id for this order.
type: string
accommodations:
title: OrderDetailsAccommodationsOutput
type: object
properties:
inventory:
title: InventoryOutput
type: object
properties:
third_party:
type: boolean
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type:
description: Type of inventory - either net or sell rates.
type: string
enum:
- net
- sell
reservation:
description: This is the reservation id for the accommodation in this order.
type: integer
format: int64
affiliate:
description: The affiliate id used for this order.
type: integer
booker:
title: OrderDetailsBookerOutput
description: The booker's information.
type: object
properties:
address:
title: OrderDetailsAddressOutput
description: The booker's address for showing the best price for that user and obeying laws regarding the display of taxes and fees.
type: object
properties:
city:
description: The city for this address.
type:
- string
- 'null'
country:
description: The country for this address.
type:
- string
- 'null'
email:
description: The booker's email address.
type:
- string
- 'null'
language:
description: 'A [IETF language tag code](https://en.wikipedia.org/wiki/IETF_language_tag) that uniquely identifies a supported human language or dialect. **Note:** Demand API only accepts lowercase for the language codes. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
name:
title: OrderDetailsBookerNameOutput
description: The name of the booker.
type: object
properties:
first_name:
type:
- string
- 'null'
last_name:
type:
- string
- 'null'
platform:
description: The booker platform for showing the platform based deals and prices.
type: string
enum:
- app
- desktop
- mobile_browser
- tablet
- unknown
telephone:
description: The booker's telephone number.
type: string
nullable: true
travel_purpose:
description: The travel purpose of the booker.
type: string
enum:
- business
- leisure
- unknown
cars:
title: OrderDetailsCarsOutput
type: object
properties:
reservation:
description: This is the reservation id for the car in this order.
type: integer
format: int64
created:
description: Order creation time.
type: string
format: date-time
commission:
title: OrderDetailsCommissionOutput
description: Commission details for the partner for a given order.
type: object
properties:
actual_amount:
description: 'For accommodation: This is the final commission for this order (`null` if value is not yet available). For other travel services: It represents the estimated commission before billing and the final commission after billing.'
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
estimated_amount:
description: Estimated commission amount for this order. For accommodations, it will be `null` if the final commission amount is available.
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
currency:
description: Input currency used in "commission" and "price" output fields.
type: string
pattern: ^[A-Z]{3}$
example: EUR
flights:
title: OrderDetailsFlightsOutput
type: object
properties:
reservation:
description: This is the reservation id for flight in this order.
type: integer
format: int64
loyalty_reward:
nullable: true
description: Details of the loyalty rewards associated with this order.
type: array
items:
title: OrderDetailsLoyaltyRewardOutput
type: object
properties:
amount:
description: Reward amount, in the units of the specified reward type (such as cash, mile, point, etc.).
type: number
format: double
currency:
description: Currency used for reward calculation.
nullable: true
type: string
pattern: ^[A-Z]{3}$
example: EUR
eligible:
description: Whether the order is eligible for the reward.
type: boolean
fulfillment_at:
description: Date and time at which the reward should be fulfilled.
type: string
format: date
fulfillment_by:
description: Mode of fulfillment of the reward.
type: string
enum:
- partner
- booking.com
loyalty_data:
description: Loyalty data associated with this loyalty reward used to fulfill reward.
type: array
items:
title: OrderDetailsLoyaltyDataOutput
type: object
properties:
name:
description: Name of the loyalty data.
type: string
value:
description: Value of the loyalty data.
type: string
nullable: true
type:
description: Type of reward.
type: string
enum:
- cash
- mile
- point
- voucher
- voucher_money
- voucher_subscription
- voucher_percentage
payment:
title: OrderDetailsPaymentOutput
description: The payment details of this order.
type: object
properties:
accommodations:
title: OrderDetailsAccommodationPaymentOutput
description: The accommodation specific payment details of this order.
type: object
properties:
authorisation_form:
description: Link to the authorisation form of the order.
type: string
format: uri
example: https://secure-admin.booking.com/airplus_auth_form_pdf.html?token=AAAA&lang=en-us
nullable: true
receipt_url:
description: Link to the payment receipt of the order. `This will only be added if the payment is already charged.`
type: string
format: uri
example: https://secure.booking.com/payment_receipt.html?bn=0000000000&pincode=0000&lang=en
nullable: true
reservation:
description: Reservation ID for this accommodation order.
type: integer
format: int64
nullable: true
method:
description: The payment method of this order.
type: string
enum:
- airplus
- card
- wallet
paid:
description: The paid transactions for this order.
nullable: true
type: array
items:
title: OrderDetailsPaymentTransactionOutput
type: object
properties:
amount:
description: Amount of the transaction.
type: number
at:
description: Time of the transaction.
type: string
format: date-time
transaction_currency:
description: Currency in which the transaction took place.
type: string
pending:
description: The pending transactions for this order.
nullable: true
type: array
items:
title: OrderDetailsPaymentTransactionOutput
type: object
properties:
amount:
description: Amount of the transaction.
type: number
at:
description: Time of the transaction.
type: string
format: date-time
transaction_currency:
description: Currency in which the transaction took place.
type: string
timing:
description: The payment timing of this order.
type: string
enum:
- pay_at_the_property
- pay_online_later
- pay_online_now
price:
title: OrderDetailsPriceOutput
description: The price components of this order.
type: object
properties:
commissionable:
description: The commissionable price. Order price on which commission amount is calculated.
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
total:
description: The total price. Includes all extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
status:
description: Status of this order.
type: string
enum:
- booked
- cancelled
- cancelled_by_accommodation
- cancelled_by_guest
- no_show
- stayed
updated:
description: Time the order was last updated.
type: string
format: date-time
metadata:
title: MetadataOutput
description: Metadata about the request.
type: object
properties:
next_page:
description: Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter `page`).
type: string
nullable: true
total_results:
description: The total number of results available.
type: integer
minimum: 0
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: '509430129718799'
accommodations:
inventory:
third_party: false
type: sell
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_browser
telephone: '+100000000'
travel_purpose: business
commission:
actual_amount: 17.5
estimated_amount: null
created: '2025-07-28T02:00:00+00:00'
currency: EUR
flights: null
loyalty_reward:
- amount: 15
currency: USD
eligible: true
fulfillment_at: '2025-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: '2025-07-28T02:00:00+00:00'
metadata:
next_page: null
total_results: 1
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orders/details/accommodations:
post:
summary: Booking.com Orders with Accommodation Details
description: This endpoint returns all information for given accommodation orders, sorted by `bookingDate` in descending order
operationId: ordersDetailsAccommodations
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Orders
requestBody:
content:
application/json:
schema:
oneOf:
- title: AccommodationsDetailsInputByOrders
type: object
properties:
orders:
description: List of order IDs for which details should be returned.
type: array
items:
description: Order ID for which details should be returned.
type: string
maxItems: 100
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
extras:
description: Input parameter to request for additional information about the accommodation order. It should be passed as a JSON array with one or more items.
type: array
items:
type: string
enum:
- accommodation_details
- policies
- extra_charges
language:
description: Language in which translation should be provided. The default language is from settings
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
required:
- orders
- title: AccommodationsDetailsInputByReservations
type: object
properties:
reservations:
type: array
items:
description: Accommodation reservation id for which details have to be returned.
type: integer
format: int64
maxItems: 100
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
extras:
description: Input parameter to request for additional information about the accommodation order. It should be passed as a JSON array with one or more items.
type: array
items:
type: string
enum:
- accommodation_details
- policies
- extra_charges
language:
description: Language in which translation should be provided. The default language is from settings
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
required:
- reservations
example:
currency: USD
extras:
- policies
- extra_charges
reservations:
- 2321873123
- 4666773123
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: OrdersDetailsAccommodationsOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: OrdersDetailsAccommodationsOutput
description: Object containing all the information related to accommodation order.
type: object
properties:
id:
description: Order ID for this accommodation order.
type: string
accommodation:
description: Hotel ID for this accommodation order.
type: integer
accommodation_details:
title: OrdersAccommodationDetailsOutput
description: Accommodation details for this accommodation order (via 'extras=accommodation_details').
type: object
properties:
email:
description: Accommodation email.
type: string
location:
title: AccommodationLocationOutput
description: Accommodation location.
type: object
properties:
address:
description: Accommodation address.
type: string
city:
description: Accommodation city_id.
type: number
coordinates:
title: AccommodationCoordinatesOutput
description: Accommodation coordinates.
type: object
properties:
latitude:
description: Accommodation latitude coordinate.
type: number
longitude:
description: Accommodation longitude coordinate.
type: number
country:
description: Accommodation country.
type: string
pattern: ^[a-z]{2}$
example: nl
post_code:
description: Accommodation post code.
type: string
name:
description: Accommodation name.
type: string
telephone:
description: Accommodation telephone.
type: string
accommodation_order_references:
description: List of additional accommodation order references generated by the accommodation.
type: array
items:
type: string
booker:
title: OrderDetailsBookerOutput
description: The booker's information.
type: object
properties:
external_account:
description: This is a unique identifier that represents the account provided by the partner in Booking.com settings. This field is used to link a specific accommodation order to the corresponding account so is possible to accurately allocate loyalty points or other benefits in the partner's loyalty and rewards programs.
type: string
platform:
description: The booker platform for showing the platform based deals and prices.
type: string
enum:
- app
- desktop
- mobile_browser
- tablet
- unknown
cancellation_details:
title: OrderCancellationDetailsOutput
description: Fee charged for cancellation and the datetime at which the cancellation occurred. (If not cancelled, value is null).
type: object
properties:
at:
description: Cancellation datetime.
type: string
format: date-time
fee:
description: Cancellation fee.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
original_total_price:
description: The total amount that would have been charged if this order had not been cancelled. Includes all extra charges.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
checkin:
description: The checkin date of this accommodation order.
type: string
format: date
checkout:
description: The checkout date of this accommodation order.
type: string
format: date
commission:
title: OrderCommissionOutput
description: Commission details for the partner for this accommodation order.
type: object
properties:
actual_amount:
description: Actual commission amount for this accommodation order (`null` if value is not yet available).
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
actual_percentage:
description: Actual commission percentage for this accommodation order (`null` if value is not yet available).
type: number
format: double
nullable: true
estimated_amount:
description: Estimated commission amount for this accommodation order (`null` if the actual amount is given).
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
credit_slip:
description: '**DEPRECATED**, please use ''credit_slip_number''.'
type: integer
format: int64
deprecated: true
credit_slip_number:
description: The financial document issued by Booking.com to partners, detailing the payout amount and the associated transaction information. It serves as a formal record of the payment, ensuring transparency and facilitating accurate financial tracking for both parties.
type: string
nullable: true
currency:
title: OrderCurrencyOutput
description: Accommodation and booker currencies (booker will be `null`, if the request did not specify the currency).
type: object
properties:
accommodation:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
booker:
nullable: true
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
inventory:
title: InventoryOutput
type: object
properties:
third_party:
type: boolean
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type:
description: Type of inventory - either net or sell rates.
type: string
enum:
- net
- sell
key_collection_information:
type: array
items:
title: AccommodationsKeyCollectionInformationOutput
type: object
properties:
additional_instructions:
description: Free-text instructions that provide additional context or details about the key collection or check-in process, such as access codes, entry procedures, or contact information.
type: string
alternate_location:
title: AlternateLocationOutput
description: This is the alternate location where the key for this accommodation property can be collected. It is provided if the key is not available at the accommodation property itself but instead at another designated location.
type: object
properties:
address:
type: string
city:
type: string
postal_code:
type: string
checkin_method:
description: An enumeration that describes the check-in process and key collection method. This is typically applicable to non-hotel accommodations (such as houses or apartments) that do not have a 24-hour front desk.
type: string
enum:
- door_code
- lock_box
- reception
- secret_spot
- someone_will_meet
- unknown
key_location:
description: Location of the key to access this accommodation property.
type: string
enum:
- key_location_at_the_property
- key_location_different_place
- unknown
label:
description: The label created while booking given accommodation order.
type: string
nullable: true
pin_code:
description: The pin code of this accommodation order.
type: string
price:
title: AccommodationReservationPriceOutput
description: The price components of this accommodation order.
type: object
properties:
commissionable:
description: The commissionable price. Reservation price on which commission amount is calculated.
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
total:
description: The total price. Includes all extra charges.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
products:
type: array
items:
title: OrdersDetailsAccommodationsProductsOutput
description: The returned information of the product reserved.
type: object
properties:
allocation:
title: OrdersDetailsAccommodationsPropertiesOutput
description: The allocation of guests, adults and children for this product.
type: object
properties:
guests:
description: The number of guests reserved for this product.
type: integer
minimum: 1
adults:
description: The number of adults reserved for this product.
type: integer
minimum: 1
nullable: true
children:
description: The list of ages of all children reserved for this product.
type: array
items:
description: The age of a child
type: integer
maximum: 17
nullable: true
bundle:
title: BundlePostBookOutput
type: object
description: A bundle attached to the reservation that includes information about the value-added service in the specified language.
properties:
id:
type: integer
description: Bundle identifier
value_adds:
type: array
items:
title: ValueAddPostBookOutput
type: object
description: Value-added service with its type and descriptive text localised in specified language.
properties:
type:
description: Identifies the type of value-added benefit included in the bundle, such as complimentary services, monetary credits, percentage discounts, or experiential amenities. Enum values encode how the benefit is applied, including time scope (per day or per stay) and unit scope (per room or per adult).
type: string
enum:
- parking
- food_drink_credit_per_day_per_room
- food_drink_credit_per_day_per_adult
- property_credit_per_day_per_room
- food_drink_credit_per_stay_per_adult
- food_drink_credit_per_stay_per_room
- property_credit_per_day_per_adult
- property_credit_per_stay_per_adult
- property_credit_per_stay_per_room
- food_drink_discount
- property_discount
- early_checkin
- late_checkout
- late_checkin
- spa_daily
- spa_hourly
- spa_massage
- high_speed_internet
- airport_transfer
- safari_game_drive
- safari_walk
- pets_stay
- bottle_of_wine
- bottle_of_champagne
- park_sleep_fly
description:
type: array
description: Translated descriptive text in the requested language.
items:
type: string
guests:
description: The guest details for this product.
type: array
items:
title: GuestOutput
type: object
properties:
email:
description: The email address of the guest.
type: string
nullable: true
name:
description: The name of the guest.
type: string
policies:
title: AccommodationDetailsProductPoliciesOutput
description: The policies for this product. Requires `{"extras":["policies"]}`.
type: object
properties:
cancellation:
nullable: true
description: The cancellation policy schedule for this product.
type: array
items:
title: AccommodationsProductDetailedCancellationPolicyMultiCurrency
type: object
properties:
from:
description: The time from which this cancellation fee applies. `now` means from booking time.
oneOf:
- type: string
format: date-time
- type: string
pattern: now
- type: 'null'
price:
description: The cancellation fee.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
meal_plan:
title: AccommodationsProductMealPlanPolicy
description: The meal plan policy for this product.
type: object
properties:
meals:
description: The meals included in the meal plan.
type: array
items:
type: string
enum:
- breakfast
- dinner
- lunch
plan:
description: The meal plan included in this product.
type: string
enum:
- all_inclusive
- breakfast_included
- full_board
- half_board
- no_plan
smoking_preference:
description: Smoking Preference for this product.
type: string
enum:
- smoking
- non-smoking
nullable: true
price:
title: AccommodationDetailsProductPriceOutput
description: The price components of this product. 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
extra_charges:
title: OrdersProductExtraChargesOutput
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
conditional:
description: Charges that might apply under a specific condition.
type: array
items:
title: AccommodationsConditionalChargeMultiCurrency
description: Charges that might apply under a specific condition.
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
condition:
description: A signed integer number that uniquely identifies the condition ID. Find the full list in the Pricing guidelines.
type:
- integer
- 'null'
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
non_conditional:
description: All non-conditional charges that will necessarily be paid
type: array
items:
title: AccommodationsChargeMultiCurrency
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total:
description: The total price. Includes all extra charges.
nullable: true
title: AccommodationsPriceCurrency
type: object
properties:
accommodation_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
room:
description: The room id given to this product.
type: number
room_details:
title: RoomDetailsOutput
description: Room details for this product (via 'extras=accommodation_details').
type: object
properties:
name:
description: The room name given to this product.
type: string
room_reservation:
description: The room reservation id given to this product.
type: number
status:
description: Status of the product.
type: string
enum:
- booked
- cancelled
- cancelled_by_accommodation
- cancelled_by_guest
- no_show
- stayed
reservation:
description: Reservation ID for given accommodation order.
type: integer
format: int64
remarks:
description: Guest remarks added while creating order.
type: string
status:
description: Status of this accommodation order.
type: string
enum:
- booked
- cancelled
- cancelled_by_accommodation
- cancelled_by_guest
- no_show
- stayed
stay_probability:
description: 'Score that predicts the likelihood of a traveller''s intent to stay, based on internal calculations. A score of 0 indicates the highest likelihood of cancellation, while a score of 1 represents the highest likelihood of the traveller staying. Note: This score may not always be available.'
type: number
format: double
multipleOf: 0.01
minimum: 0
maximum: 1
nullable: true
example:
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
booker:
external_account: 13610217
platform: mobile
cancellation_details:
at: '2022-11-09T00:00:00+00:00'
fee:
accommodation_currency: 170.01
booker_currency: 186.87
original_total_price:
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
credit_slip_number: hsnl1223445
currency:
accommodation: EUR
booker: USD
inventory:
third_party: false
type: sell
key_collection_information:
- additional_instructions: The keys are in a keybox located next to the front door.
alternate_location:
address: abc
city: bdweb
postal_code: 1015XX
checkin_method: someone_will_meet
key_location: key_location_at_the_property
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
room_reservation: 1234567890
status: booked
remarks: We will need an extra cot. Need room on higher floor
reservation: 12345678
status: booked
stay_probability: 0.12
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orders/details/cars:
post:
summary: Booking.com Orders with Car Details
description: This endpoint returns car order details, sorted by `bookingDate` in descending order
operationId: ordersDetailsCars
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Orders
requestBody:
content:
application/json:
schema:
oneOf:
- title: CarsDetailsInputByOrders
type: object
properties:
orders:
description: List of order IDs for which details should be returned.
type: array
items:
description: Order ID for which details should be returned.
type: string
maxItems: 100
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
extras:
description: Optional extra information groups that the user can request. It should be passed as a JSON array with one or more items.
type: array
items:
type: string
enum:
- policies
required:
- orders
- title: CarsDetailsInputByReservations
type: object
properties:
reservations:
description: List of reservation IDs for which details should be returned.
type: array
items:
description: Order ID for which details should be returned.
type: string
maxItems: 100
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
extras:
description: Optional extra information groups that the user can request. It should be passed as a JSON array with one or more items.
type: array
items:
type: string
enum:
- policies
required:
- reservations
example:
currency: USD
extras:
- policies
orders:
- '123456789'
- 098765432
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: OrdersDetailsCarsOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: OrdersDetailsCarsOutput
description: Object containing all the information related to car order.
type: object
properties:
id:
description: Order ID for this car order.
type: string
affiliate:
description: The affiliate ID used for this order.
type: number
commission:
title: OrderCommissionOutput
description: Commission details for the partner for this car order.
type: object
properties:
actual_amount:
description: Actual commission amount for this car order (`null` if value is not yet available).
nullable: true
title: CarsPriceCurrency
type: object
properties:
depot_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
actual_percentage:
description: Actual commission percentage for this car order (`null` if value is not yet available).
type: number
format: double
nullable: true
estimated_amount:
description: Estimated commission amount for this car order (`null` if the actual amount is given).
nullable: true
title: CarsPriceCurrency
type: object
properties:
depot_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
currency:
title: OrderCurrencyOutput
description: Depot and booker currencies (booker will be `null`, if the request did not specify the currency).
type: object
properties:
depot:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
booker:
nullable: true
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
dropoff:
description: Drop-off depot location and time.
type: object
properties:
datetime:
description: Pickup/drop-off date and time. The specific time will only be available if the requester has access to personal information. Otherwise, it will be set to 00:00:00.
example: '2023-11-01T11:05:00+00:00'
format: date-time
type: string
label:
description: Identifier associated with the car booking.
type: string
nullable: true
pickup:
description: Pick up depot location and time.
type: object
properties:
datetime:
description: Pickup/drop-off date and time. The specific time will only be available if the requester has access to personal information. Otherwise, it will be set to 00:00:00.
example: '2023-11-01T11:05:00+00:00'
format: date-time
type: string
price:
title: CarReservationPriceOutput
description: The price breakdown for this car order.
type: object
properties:
commissionable:
description: The commissionable price, representing the car rental cost used to calculate the commission amount.
nullable: true
title: CarsPriceCurrency
type: object
properties:
depot_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
total:
description: The total price, including all extra charges.
title: CarsPriceCurrency
type: object
properties:
depot_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
products:
type: array
items:
title: OrdersDetailsCarsProductsOutput
description: The returned information of the product reserved.
type: object
properties:
car:
description: Related car id
type: integer
minimum: 1
policies:
description: The policies that apply to this product.
type: object
properties:
payment:
description: The payment policy that applies to this product.
type: object
properties:
timing:
description: The applied payment timing. For example 'pay_now'.
type: string
enum:
- pay_now
- pay_local
- unknown
required:
- timing
price:
title: CarDetailsProductPriceOutput
description: Detailed breakdown of the product's price components.
type: object
properties:
base:
description: The base price. This does not include any extra charges.
nullable: true
title: CarsPriceCurrency
type: object
properties:
depot_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
total:
description: The total price including any extra charges.
nullable: true
title: CarsPriceCurrency
type: object
properties:
depot_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
booker_currency:
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
status:
description: Status of the product.
type: string
enum:
- booked
- cancelled
- cancelled_by_accommodation
- cancelled_by_guest
- no_show
- stayed
reservation:
description: This is the reservation id for the car in this order.
type: integer
format: int64
status:
description: Status of this car order.
type: string
enum:
- booked
- cancelled
- cancelled_by_accommodation
- cancelled_by_guest
- no_show
- stayed
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: '123456789'
affiliate: 1234567
commission:
actual_amount:
depot_currency: 45.5
booker_currency: 66.34
actual_percentage: 0.25
estimated_amount:
depot_currency: 45.5
booker_currency: 66.34
currency:
depot: EUR
booker: USD
dropoff:
date: '2025-10-18T00:00:00'
label: One123
pickup:
date: '2025-10-15T00:00:00'
price:
commissionable:
depot_currency: 170.01
booker_currency: 186.87
total:
depot_currency: 170.01
booker_currency: 186.87
products:
- policies:
payment:
timing: pay_now
price:
base:
depot_currency: 170.01
booker_currency: 186.87
total:
depot_currency: 170.01
booker_currency: 186.87
status: booked
status: booked
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orders/details/flights:
post:
summary: Booking.com Orders with Flight Details
description: Use this endpoint to retrieve detailed information for one or more flight orders. - You can request car order details either by **order ID** or by **reservation ID**. - The response includes all relevant information for each order, such as booking and cancellation details, commission, pricing, and optional extras (for example, policies). Results are sorted by `bookingDate` in descending order, with the most recently booked orders listed first. It returns structured order data, including pricing, itinerary segments with IATA airport codes, etc. This endpoint is ideal for: - Displaying flight booking details in traveller dashboards or confirmation pages. - Generating post-booking communications and invoices. - Performing reporting or reconciliation tasks that require accurate itinerary and pricing data.
operationId: ordersDetailsFlights
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Orders
requestBody:
content:
application/json:
schema:
title: FlightsDetailsInput
type: object
properties:
currency:
description: 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.
type: string
pattern: ^[A-Z]{3}$
example: EUR
oneOf:
- title: FlightsDetailsInputByOrders
properties:
orders:
description: List of order IDs for which details should be returned. Mutually exclusive with 'reservations'.
type: array
items:
type: string
description: Flight order id for which details have to be returned.
maxItems: 100
required:
- orders
example:
currency: EUR
orders:
- '1234567890123456'
- '9876543210987654'
- title: FlightsDetailsInputByReservations
properties:
reservations:
description: List of reservation IDs for which details should be returned. Mutually exclusive with 'orders'.
type: array
items:
type: string
description: Flight reservation id for which details have to be returned.
maxItems: 100
required:
- reservations
example:
currency: EUR
reservations:
- '2321873123'
- '4666773123'
examples:
OrdersDetailsFlightsRequestExample:
summary: Default ordersDetailsFlights request
x-microcks-default: true
value:
currency: EUR
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: OrdersDetailsFlightsOutput
type: object
properties:
data:
type: array
items:
title: FlightsOutput
type: object
properties:
id:
description: Order id
type: string
reservation:
description: This is the reservation id for the travel service in this order.
type: string
currency:
title: CurrencyOutput
type: object
properties:
booker_currency:
description: The currency of the booker.
type: string
order_currency:
description: The currency in which the order was created.
type: string
itineraries:
type: array
items:
title: ItineraryOutput
type: object
properties:
arrival:
description: Arrival itinerary.
title: ItineraryPoint
type: object
properties:
airport:
description: A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling [common/locations/airports](#/common/locations/airports).
pattern: ^[A-Z]{3}$
type: string
date_time:
description: Date time of the itinerary.
type: string
format: date-time
departure:
description: Departure itinerary.
title: ItineraryPoint
type: object
properties:
airport:
description: A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling [common/locations/airports](#/common/locations/airports).
pattern: ^[A-Z]{3}$
type: string
date_time:
description: Date time of the itinerary.
type: string
format: date-time
label:
description: Identifier associated with the order.
type: string
price:
title: PriceOutput
type: object
properties:
booker_currency:
description: The price in the currency of the booker
type: number
format: double
order_currency:
description: The price in the currency in which order was created
type: number
format: double
status:
type: string
enum:
- booked
- cancelled
- unknown
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
example:
data:
- id: ORDER_ID
reservation: RESERVATION_ID
currency:
booker: EUR
order: USD
itineraries:
- departure:
airport: CAI
date_time: '2024-03-01T07:00:00+00:00'
arrival:
airport: LXR
date_time: '2024-03-01T08:10:00+00:00'
label: SAMPLE LABEL
price:
order_currency: 212.86
booker_currency: 197.87
status: booked
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orders/modify:
post:
summary: Booking.com Modify an Order
description: "Use this endpoint to modify certain aspects of an accommodation order, such as credit card details, checkin/checkout dates, and room configurations (guest allocation, guest names, and smoking preferences). \n - See the [Orders modification guide](/demand/docs/orders-api/order-modify) for examples and best practices.\n"
operationId: ordersModify
tags:
- Orders
requestBody:
content:
application/json:
schema:
oneOf:
- title: AccommodationModification
type: object
properties:
order:
type: string
description: Order ID to be modified
modification:
type: object
properties:
accommodation:
type: object
properties:
reservation:
type: integer
description: Reservation ID
change:
oneOf:
- title: DateChange
type: object
properties:
checkin:
type: string
format: date
description: New checkin date
checkout:
type: string
format: date
description: New checkout date
required:
- checkin
- checkout
- title: RoomChange
type: object
properties:
room_reservation:
type: integer
format: int64
description: Room reservation ID
allocation:
type: object
properties:
number_of_adults:
type: integer
guests:
description: Guest information for the room.
type: array
items:
type: object
properties:
name:
type: string
smoking_preference:
type: string
enum:
- no_preference
- non_smoking
- smoking
type:
description: Type of the accommodation change
type: string
enum:
- dates
- room
required:
- reservation
- type
- change
required:
- accommodation
required:
- order
- modification
- title: PaymentModification
type: object
properties:
order:
type: string
description: Order ID to be modified
modification:
type: object
properties:
payment:
type: object
properties:
change:
type: object
properties:
cardholder:
type: string
description: Cardholder name
cvc:
type: string
description: A 3 or 4 digit Card Verification Code (CVC) associated with the used card
expiry_date:
type: string
format: YYYY-MM
description: Card expiry date
number:
type: string
description: Card number
required:
- cardholder
- cvc
- expiry_date
- number
type:
description: Type of the payment change
type: string
enum:
- card
required:
- type
- change
required:
- payment
required:
- order
- modification
examples:
OrdersModifyRequestExample:
summary: Default ordersModify request
x-microcks-default: true
value: string
responses:
'200':
description: Successful modification
content:
application/json:
schema:
oneOf:
- title: AccommodationModificationResponse
type: object
properties:
modification:
type: object
properties:
accommodation:
type: object
properties:
new_price:
description: New price to be paid after the modification
type: number
format: double
status:
description: Status for this modification request.
type: string
enum:
- successful
- failed
- title: PaymentModificationResponse
type: object
properties:
modifications:
type: object
properties:
payment:
type: object
properties:
status:
description: Status for this modification request.
type: string
enum:
- successful
- failed
examples:
OrdersModify200Example:
summary: Default ordersModify 200 response
x-microcks-default: true
value: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orders/cancel:
post:
summary: Booking.com Cancel an Order
description: Use this endpoint to process an order cancellation. Refer to the [Cancellations guide](/demand/docs/orders-api/cancel-order) for instructions, tips and examples.
operationId: ordersCancel
parameters:
- $ref: '#/components/parameters/AffiliateIdHeader'
tags:
- Orders
requestBody:
content:
application/json:
schema:
title: OrdersCancelInput
type: object
properties:
order:
description: ID of the order to cancel.
type: string
reason:
description: The reason for cancelling this order.
type: string
request_property_approval:
description: (accommodations only) If the reservation has a cancellation fee, request the property to waive the fee and cancel for free. Subject to approval by the property.
type: string
required:
- order
- reason
example:
order: '509430129718799'
reason: I would like to book another property instead of this one.
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: OrdersCancelOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
title: OrdersCancelDataOutput
type: object
properties:
status:
description: Status for this cancellation request.
type: string
enum:
- successful
- failed
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
status: successful
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
parameters:
AffiliateIdHeader:
in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: string
x-tagGroups:
- name: Travel services
tags:
- Accommodations
- Cars
- name: Common
tags:
- Common/locations
- Common/payments
- Common/languages
- name: Orders
tags:
- Orders
- name: Messaging
tags:
- Messages
- Conversations
- Attachments