Remove item ancillary
const url = 'https://api.wink.travel/api/shopping-cart/a2f1c9d8-4e7b-4d3a-9f2c-1a6b5e8d3f42/item/b3e2d0c1-5f8c-4e4b-0a3d-2b7c6f9e4g53/ancillary/d5g4f2e3-7h0e-6g6d-2c5f-4d9e8h1g6i75';const options = { method: 'DELETE', headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://api.wink.travel/api/shopping-cart/a2f1c9d8-4e7b-4d3a-9f2c-1a6b5e8d3f42/item/b3e2d0c1-5f8c-4e4b-0a3d-2b7c6f9e4g53/ancillary/d5g4f2e3-7h0e-6g6d-2c5f-4d9e8h1g6i75 \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Detach an add-on (ancillary such as spa, activity, or service) from a cart item. The cart total is recalculated automatically.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Unique shopping cart identifier to update
Example
a2f1c9d8-4e7b-4d3a-9f2c-1a6b5e8d3f42Unique cart item identifier to update
Example
b3e2d0c1-5f8c-4e4b-0a3d-2b7c6f9e4g53Unique ancillary identifier to remove
Example
d5g4f2e3-7h0e-6g6d-2c5f-4d9e8h1g6i75Header Parameters
Section titled “Header Parameters ”Responses
Section titled “ Responses ”Ancillary removed from cart item successfully
object
Unique shopping cart identifier
List of priced shopping cart items. Each entry is a separately booked room.
object
Unique shopping cart item identifier
Unique hotel (property) record identifier.
Date when guest arrives on the premises.
Date when guest departs the premises.
Room configuration specifying guest occupancy and room requirements.
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Count of children of this age group in the room
Age of each child in this group (years)
Number of identical rooms with this configuration
Unique master rate identifier that made this room and rate plan available for sale.
Optional bedroom layout choice identifier if the property offers multiple layouts for this room type.
Extra reservations of ancillaries (spas, meeting rooms, activities, etc.) that accompany the room 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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Special requests from the guest to the hotel (e.g., high floor, late check-in, welcome amenity).
User details for the person making this booking (name, email, phone).
object
First name
Last name
Telephone
The property (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.
Profile image of the general manager.
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 room stay with rate breakdown and total amounts.
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 for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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.
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
Floor number on which this room type is located.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). 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.
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). 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.
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). 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 for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
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
Unique enum-like string identifier for this perk (e.g., PERK_GUARANTEED_UPGRADE). Enables backwards compatibility by persisting the identifier rather than relying on ordinal position.
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
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
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Absolute URL of room image that can be used as-is
object
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
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
User first name
User last name
User email address
User phone number
Profile picture URL
Full name
Detailed customer information for this profile
object
Identifies the gender of the customer.
Date of birth in ISO 8601 format
Marital status of the traveler
Number of children
Country of citizenship
Primary address line
Secondary address line
City name
State or province
Postal code
Country code (ISO 3166-1 alpha-2)
Preferred currency for monetary values (ISO 4217 code)
Primary language (ISO 639-1 code)
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
Preferred hotel property locations
Preferred hotel property types
Preferred hotel chain name
Preferred hotel property amenities
Preferred recreation services
Preferred business services
Preferred security features
Preferred accessibility features
Preference for smoking allowed rooms
Preferred hotel room locations
Preferred hotel bed type
Preferred food service facilities
Preferred hotel room amenities
Guest type classification
Meal preference
Cuisine preference
Interest preferences
Beverage preferences
Food preferences
Known allergies
Pet-friendly preferences
Full name
object
object
object
Whether this booking qualifies for commission based on the sales channel.
Commission percentage earned on this booking (as decimal, e.g., 0.10 for 10%).
Guest’s preferred language for booking confirmation and communication.
Guest’s preferred currency for display and billing.
Lifestyle context that led the guest to this property (e.g., wellness, family, luxury).
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 - valid authentication required
object
object
Forbidden
object
object
Shopping cart, item, or ancillary not found
object
Unique shopping cart identifier
List of priced shopping cart items. Each entry is a separately booked room.
object
Unique shopping cart item identifier
Unique hotel (property) record identifier.
Date when guest arrives on the premises.
Date when guest departs the premises.
Room configuration specifying guest occupancy and room requirements.
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Count of children of this age group in the room
Age of each child in this group (years)
Number of identical rooms with this configuration
Unique master rate identifier that made this room and rate plan available for sale.
Optional bedroom layout choice identifier if the property offers multiple layouts for this room type.
Extra reservations of ancillaries (spas, meeting rooms, activities, etc.) that accompany the room 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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Special requests from the guest to the hotel (e.g., high floor, late check-in, welcome amenity).
User details for the person making this booking (name, email, phone).
object
First name
Last name
Telephone
The property (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.
Profile image of the general manager.
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 room stay with rate breakdown and total amounts.
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 for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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.
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
Floor number on which this room type is located.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). 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.
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). 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.
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). 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 for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
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
Unique enum-like string identifier for this perk (e.g., PERK_GUARANTEED_UPGRADE). Enables backwards compatibility by persisting the identifier rather than relying on ordinal position.
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
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
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Absolute URL of room image that can be used as-is
object
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
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
User first name
User last name
User email address
User phone number
Profile picture URL
Full name
Detailed customer information for this profile
object
Identifies the gender of the customer.
Date of birth in ISO 8601 format
Marital status of the traveler
Number of children
Country of citizenship
Primary address line
Secondary address line
City name
State or province
Postal code
Country code (ISO 3166-1 alpha-2)
Preferred currency for monetary values (ISO 4217 code)
Primary language (ISO 639-1 code)
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
Preferred hotel property locations
Preferred hotel property types
Preferred hotel chain name
Preferred hotel property amenities
Preferred recreation services
Preferred business services
Preferred security features
Preferred accessibility features
Preference for smoking allowed rooms
Preferred hotel room locations
Preferred hotel bed type
Preferred food service facilities
Preferred hotel room amenities
Guest type classification
Meal preference
Cuisine preference
Interest preferences
Beverage preferences
Food preferences
Known allergies
Pet-friendly preferences
Full name
object
object
object
Whether this booking qualifies for commission based on the sales channel.
Commission percentage earned on this booking (as decimal, e.g., 0.10 for 10%).
Guest’s preferred language for booking confirmation and communication.
Guest’s preferred currency for display and billing.
Lifestyle context that led the guest to this property (e.g., wellness, family, luxury).
object
object
object
object
object
object
Example
{ "id": "", "itemList": ""}Internal Server Error
object
Example generated
{}