Add Shopping Cart Item
const url = 'https://api.wink.travel/api/shopping-cart/cart-1';const options = { method: 'PATCH', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"hotelIdentifier":"","startDate":"","endDate":"","nights":"","roomConfiguration":"","promotionalCodes":[""],"roomRateIdentifier":"","bedroomConfigurationIdentifier":"","ancillaries":[""],"specialRequests":"","user":"","language":"","currency":"","lifestyle":"LIFESTYLE_HEALTH_FITNESS","customizationIdentifier":"","validUser":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.wink.travel/api/shopping-cart/cart-1 \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "hotelIdentifier": "", "startDate": "", "endDate": "", "nights": "", "roomConfiguration": "", "promotionalCodes": [ "" ], "roomRateIdentifier": "", "bedroomConfigurationIdentifier": "", "ancillaries": [ "" ], "specialRequests": "", "user": "", "language": "", "currency": "", "lifestyle": "LIFESTYLE_HEALTH_FITNESS", "customizationIdentifier": "", "validUser": true }'Adds a new item to shopping cart.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Cart to update
Example
cart-1Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”object
Unique hotel record identifier.
Example
hotel-1Date when guest arrives on the premises.
Example
2021-01-31Date when guest departs the premises. Optional if nights is specified.
Example
2021-02-07Date when guest departs the premises. Optional if endDate is specified.
Example
1Room configuration is how the guest wants the room to support her accompanying guests.
object
Number of adults
Example
2Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Example
1The unique master rate that made the guest room / rate plan available for sale.
Example
master-rate-1Guest can optionally request a specific bedroom layout if the room type is set up with multiple layout choices.
Extra reservations of spas, meeting rooms etc that should accompany the room type booking.
object
Travel inventory identifier
Example
place-1Channel inventory identifier
Example
channel-blocking-1Travel blocking identifier
Example
place-1Date start time when reservation was made for.
Example
2017-12-22T03:07:58.742+0000Date end time when reservation was made for.
Example
2017-12-22T08:07:58.742+0000Quantity of the ancillary requested.
Example
2Ancillary identifier
Example
ancillary-1Inventory type
Example
PLACEA guest can send a special request to the hotel in free-text here.
Example
Can I please have rose petals on my pillows when I arrive?User object contains details of the person that made the booking.
object
First name
Example
JohnLast name
Example
SmithTelephone
Example
0123456789User’s language preference
Example
enUser’s currency preference
Example
USDControl which lifestyle the user used.
Example
LIFESTYLE_HEALTH_FITNESSAffiliate customization
Example
custom-1Responses
Section titled “ Responses ”OK
object
Shopping cart ID
List of priced shopping cart items. Each entry is a separately booked room.
object
Identifier for item in cart
Unique hotel record identifier.
Date when guest arrives on the premises.
Date when guest departs the premises.
Room configuration is how the guest wants the room to support her accompanying guests.
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
The unique master rate that made the guest room / rate plan available for sale.
Guest can optionally request a specific bedroom layout if the room type is set up with multiple layout choices.
Extra reservations of spas, meeting rooms etc that should accompany the room type booking.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
A guest can send a special request to the hotel in free-text here.
User object contains details of the person that made the booking.
object
First name
Last name
Telephone
The hotel where the stay occurs.
object
Unique hotel record identifier.
Hotel trade name
Hotel local name if different from the trade name or if it is the local language.
Name of hotel chain if applicable.
Name of hotel brand
Unique URL-friendly name slug of hotel
Event shorter name
Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.
Number of bookings for this property on the wink.travel platform.
Aggregate score based on all current user reviews.
Geo-location
object
Short and long welcome text
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Count of total reviews left by users at this property.
Contact details for reservations desk
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Property’s social network accounts
Social network
object
Type of social network.
URL or social network identifier to social network profile
Property images.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Property videos.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Basic property policy record.
object
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates how guests can access the Internet on the property.
Indicates where internet is available in and around the property.
Indicates whether parking is available at the property.
Indicates what type of parking is available at the property.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
If pets are allowed, property can further limit on weight.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
When the guest has to check out.
When the guest can check in.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Number of attractions property has listed on its profile.
Number of activites property has listed on its profile.
Number of places property has listed on its profile.
Number of restaurants property has on its profile.
Number of meeting rooms property has on its profile.
Number of spas property has on its profile.
Number of add-ons property has on its profile.
General manager related data.
object
Name of GM currently managing the property.
Cloudinary image identifier of GM currently managing the property.
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Localized welcome message from GM.
object
Longer text description
Indicate which language this description is written in.
Supported OTA specification LOC code. See OTA geoname data
Supported OTA specification SEG code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Supported OTA specification ARC code. See OTA geoname data
Year the property was constructed.
Currency code for property.
A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.
A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.
A property’s perk score is based on the type of perks that is offered to the guests across all master rates. There is no max score; it’s there to compare it against other properties.
A property’s package score is based on general availability and price for all packages and add-ons offered by the property. There is no max score; it’s there to compare it against other properties.
A property’s loyalty score is based on calculating how many available rate plans honor loyalty points. There is no max score; it’s there to compare it against other properties.
A property’s popular score is based on calculating number of bookings across room types. There is no max score; it’s there to compare it against other properties.
A property’s experience score is based on how calculating how many types of experiences are available and at what price ranges. There is no max score; it’s there to compare it against other properties.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Number of rooms / keys for this property.
Property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Whether property is active
The priced stay.
object
Guest room details.
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Maximum number of guest allowed in a room type.
Minimum number of guests allowed in a room type.
Defines the number of rooms of this type
Non-smoking indicator
A room type can have more than one bed configuration.
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
Number of square meters that defines the size of this room type.
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Number of bathrooms
Number of living rooms
Maximum number of rollaway beds allowed in this room type.
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data
Floor an which a room is located
Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data
Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data
Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Maximum number of cribs allowed in a room type.
Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data
The number of pax the room price was meant for
The number of children the room price was meant for
Number of identical room types.
Desired bedroom layout
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
The actual amount of adults as determined by the hotel’s policy.
The actual amount of children as determined by the hotel’s policy.
Price details
object
Base total in user specified currency.
object
Base total in hotel’s currency.
object
Base total in wink currency.
object
Extra person modifier in hotel currency.
Extra person modifier in wink currency
Extra person modifier in user specified currency
Extra child modifier in hotel currency
Extra child modifier in wink currency
Extra child modifier in user specified currcency
Single occupant modifier in hotel currency
Singe occupant modifier in wink currency
Single occupant modifier in user specified currency
Rate discount modifiers in hotel currency
Rate discount modifiers in wink currency
Rate discount modifiers in user specified currency
Rate premiums modifiers in hotel currency
Rate premiums modifiers in wink currency
Rate premiums modifiers in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
Channel / Membership modifier in user specified currency
Quantity
Minimum occupancy
Maximum occupancy
Source
Promotional discount percent
Chanel discount percent
Premium percent
Available
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Localized text of the discount
object
Longer text description
Indicate which language this description is written in.
Promotional codes
User-defined currency final price.
object
Source currency final price.
object
Internal currency final price.
object
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
object
object
object
Master rate identifier
Master rate internal name
Rate plan used for this stay
object
Rate plan identifier
Provides the name of the rate plan.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
Everything included except alcohol
Everything included with alcohol
List of perks that came with the master rate
object
Enum identifier identifier for this perk. Makes the persistent version backwards compatible.
Whether perk is guaranteed or not.
The platform value of this perk.
Localized description for this perk
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
This is how perks get sorted when in a list
Rate plan-level extra charges
object
List of extra charges that applies to the rate plan.
object
What the guest is paying extra for
object
List of localized descriptions for this fee.
object
Longer text description
Indicate which language this description is written in.
Rate plan level fixed fee amount in property currency
object
Rate plan fee type
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
object
object
object
Based on the itinerary, the cancellation policy could be taken directly from the rate plan or it could be a policy exception also listed on the rate plan
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Ancillary services (spa, restaurant, activity, etc.) attached to this room stay.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Absolute URL of room image that can be used as-is
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Guest assigned to this room stay (lead occupant). Null during search/availability; set at checkout.
object
User identifier
First name
Last name
Telephone
Optional profile record
object
Profile identifier
User identifier
Indicates whether the user wants to share this profile of themselves with hotel(s)
User details
object
First name
Last name
Telephone
Profile picture URL
Full name
Detailed customer information for this profile
object
Identifier the gender of the customer.
Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
Marital status of the traveler.
The number of children of the customer.
Name of the (self-professed) country that is clamided for citizenship.
Address line 1
Address line 2
City
State
Postal code
Country
Type of funds preferred for reviewing monetary values, in ISO 4217 codes
The primary language of the customer
Array of emergency contact information for the customer
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Array of customer’s pets
object
Pet name
Pet type
Customer preferences
object
Indicates preference for hotel property locations.
Indicates preference for hotel property types.
Identifies a preferred company by name.
Indicates preferences for hotel property amenities.
Indicates preference for the type of recreation services in a hotel
Indicates preference for type of business services in a hotel
Indicates preference of rtype of security features in a hotel
Indicates preferences for type of features required to meet the needs of persons with physical challenges, disabilities, etc.
Indicates preference for smooking allowed rooms..
Indicates preference for hotel room locations.
Indicates preferences for the size and features of hotel bed types.
Indicates preferences for type of food listener facilities in a hotel.
Indicates preferences for hotel room amenities.
Guest type
Indicates meal preference.
Indicates cuisine preference.
Indicates interest preference
Indicates beverage preference.
Indicates food preference.
Indicates allergies
Indicates pet preferences
Full name
object
object
object
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
User’s language preference
User’s currency preference
Control which lifestyle context your user was in.
object
object
object
object
object
object
Example
{ "id": "", "itemList": ""}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}