Remove cart item
const url = 'https://api.wink.travel/api/shopping-cart/a2f1c9d8-4e7b-4d3a-9f2c-1a6b5e8d3f42/item/b3e2d0c1-5f8c-4e4b-0a3d-2b7c6f9e4a53';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-2b7c6f9e4a53 \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Delete a single room reservation item from the specified cart. The cart total is recalculated automatically.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Unique shopping cart identifier containing the item to remove
Example
a2f1c9d8-4e7b-4d3a-9f2c-1a6b5e8d3f42Unique cart item identifier to remove from the cart
Example
b3e2d0c1-5f8c-4e4b-0a3d-2b7c6f9e4a53Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”Room reservation item removed from the cart and total recalculated automatically
Real-time priced snapshot of a shopping cart, enriched with live inventory pricing for each item. Used to display the total cost to the user before initiating checkout.
object
Unique shopping cart identifier
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of priced shopping cart items. Each entry is a separately booked room.
A single priced room reservation within a real-time shopping cart, including the hotel, stay details, ancillary add-ons, user preferences, and calculated totals in source, internal, and user-specified currencies.
object
Extra reservations of ancillaries (spas, meeting rooms, activities, etc.) that accompany the room booking.
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
object
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
Optional bedroom layout choice identifier if the property offers multiple layouts for this room type.
Commission percentage earned on this booking (as decimal, e.g., 0.10 for 10%).
Whether this booking qualifies for commission based on the sales channel.
Guest’s preferred currency for display and billing.
Date when guest departs the premises.
The property (hotel) where the stay occurs.
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Profile image of the general manager.
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in.
When the guest has to check out.
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 where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
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.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
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.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Year the property was constructed.
Unique hotel (property) record identifier.
Unique shopping cart item identifier
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Guest’s preferred language for booking confirmation and communication.
Lifestyle context that led the guest to this property (e.g., wellness, family, luxury).
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
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
Unique master rate identifier that made this room and rate plan available for sale.
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Special requests from the guest to the hotel (e.g., high floor, late check-in, welcome amenity).
Date when guest arrives on the premises.
The priced room stay with rate breakdown and total amounts.
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
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The actual amount of adults as determined by the hotel’s policy.
Ancillary services (spa, restaurant, activity, etc.) attached to this room stay.
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
object
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
Desired bedroom layout
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
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.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
The actual amount of children as determined by the hotel’s policy.
Rate plan-level extra charges
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
What the guest is paying extra for
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
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
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
object
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Guest assigned to this room stay (lead occupant). Null during search/availability; set at checkout.
object
First name
Full name
Last name
Optional profile record
object
Datetime this record was first created
Unique identifier for this record.
Datetime this record was last updated
Detailed customer information for this profile
object
Primary address line
Secondary address line
Date of birth in ISO 8601 format
Number of children
Country of citizenship
City name
Array of emergency contact information for the customer
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Country code (ISO 3166-1 alpha-2)
Identifies the gender of the customer.
Primary language (ISO 639-1 code)
Marital status of the traveler
Array of customer’s pets
object
Pet name
Pet type
Postal code
Preferred currency for monetary values (ISO 4217 code)
State or province
Customer preferences
object
Known allergies
Preferred hotel bed type
Beverage preferences
Preferred business services
Cuisine preference
Food preferences
Preferred food service facilities
Guest type classification
Preferred hotel chain name
Interest preferences
Meal preference
Pet-friendly preferences
Preferred accessibility features
Preferred hotel property amenities
Preferred hotel property locations
Preferred hotel property types
Preferred recreation services
Preferred hotel room amenities
Preferred hotel room locations
Preferred security features
Preference for smoking allowed rooms
Profile identifier
Indicates whether the user wants to share this profile of themselves with hotel(s)
User details
object
User email address
User first name
Full name
User last name
User phone number
Profile picture URL
User identifier
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Telephone
User identifier
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of perks that came with the master rate
Lightweight projection of a platform perk for use in public-facing APIs, search results, and rate configuration, omitting internal admin fields.
object
Datetime this record was first created
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Price details
object
Available
Chanel discount percent
object
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Extra child modifier in wink currency
Extra person modifier in wink currency
Rate premiums modifiers in wink currency
Rate discount modifiers in wink currency
Singe occupant modifier in wink currency
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
Maximum occupancy
Minimum occupancy
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Premium percent
Promotional codes
Promotional discount percent
Quantity
Source
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Extra child modifier in hotel currency
Extra person modifier in hotel currency.
Rate premiums modifiers in hotel currency
Rate discount modifiers in hotel currency
Single occupant modifier in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Extra child modifier in user specified currcency
Extra person modifier in user specified currency
Rate premiums modifiers in user specified currency
Rate discount modifiers in user specified currency
Single occupant modifier in user specified currency
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Number of identical room types.
Rate plan used for this stay
object
Everything included except alcohol
Everything included with alcohol
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Guest room details.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
A room type can have more than one bed configuration.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
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.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
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.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
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
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Absolute URL of room image that can be used as-is
Master rate identifier
Master rate internal name
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
User details for the person making this booking (name, email, phone).
object
First name
Last name
Telephone
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Example
{ "id": "a2f1c9d8-4e7b-4d3a-9f2c-1a6b5e8d3f42", "internalTotal": { "amount": 700, "currency": "USD" }, "itemList": [ { "ancillaries": [], "bedroomConfigurationIdentifier": "e6b3a1c9-2d7f-4a5b-8c0e-1f9d4a2b6c37", "commission": 0.1, "commissionable": true, "currency": "USD", "endDate": "2026-01-25", "hotelIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "identifier": "b3e2d0c1-5f8c-4e4b-0a3d-2b7c6f9e4a53", "language": "en", "lifestyle": "LIFESTYLE_HEALTH_FITNESS", "promotionalCodes": [ "WELCOMELUX25" ], "roomConfiguration": { "adults": 2, "children": 0 }, "roomRateIdentifier": "4d7c2b1e-9f3a-4b5c-8d0e-5e1f6a3c7b84", "specialRequests": "Please prepare the room with rose petals and champagne for our anniversary.", "startDate": "2026-01-20" } ], "sourceTotal": { "amount": 26250, "currency": "THB" }, "userSpecifiedCurrencyTotal": { "amount": 750, "currency": "USD" }}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable