Load Configuration by Client ID
const url = 'https://api.wink.travel/api/public/configuration/client/';const options = {method: 'GET', headers: {'Wink-Version': '2.0'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.wink.travel/api/public/configuration/client/ \ --header 'Wink-Version: 2.0'Retrieve affiliate configuration by clientId in the path
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The clientId
Header Parameters
Section titled “Header Parameters ”Responses
Section titled “ Responses ”OK
object
Unique customization configuration identifier
Engine configuration name
Whether to append text to the existing booking customization page title.
Engine configuration record creator identifier
Name of company owner.
Sales channel sub-type.
Indicates whether this configuration is primary. A primary configuration cannot be removed.
If you want to track analytics with Google Analytics using your GA4 Measurement ID.
If you want to track analytics and you have a GTM Container ID, enter it here.
If you want your users to see Google Maps in your hosted booking customization, go to Google Maps and create an API key for your site.
Control which currency your users see prices in initially.
Control which language your users see text in initially.
Customize booking confirmation emails by adding a custom logo to your configuration.
If you are self-hosting our booking customization, let us know where it is hosted. Note: This url needs to be secured with SSL.
Flag to indicate you are self-hosting our booking customization and not using our default booking customization url.
Choose how you want our web components to look and more closely match with your own site style.
object
Primary color
Secondary color
Success color
Danger color
Warning color
Info color
Light color
Dark color
Body color
Muted color
White color
You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long and how many days in advance (this field), of today’s date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don’t use either of these options, the itinerary will default to today’s date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave startDate and endDate empty.
You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long (this field) and how many days in advance, of today’s date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don’t use either of these options, the itinerary will default to today’s date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave startDate and endDate empty.
Set a fixed itinerary start date. ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
Set a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
Control how many adults / children will be staying and how many rooms. Defaults to: One room, two adults.
Room Configuration
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
If true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate
If you’ve received special promotional codes from suppliers to give to your audience, you can choose to bake these code directly into the price by entering them here.
Action to complete once a user clicks on the CTA button on inventory.
Show unavailable inventory card when inventory not currently for sale. Otherwise, it displays a normal card but without the price.
Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page.
This feature flag controls whether to let a user move away from the hotel landing page using search.
Choose how you want our web component cards laid out.
Choose how you large you want our web component cards to be.
Tracking pixels to fire on key booking events.
object
Unique identifier for this tracking pixel
User-friendly name for this tracking pixel
Type of tracking pixel delivery mechanism
Tracking pixel provider
Consent category for GDPR/CCPA compliance
Whether this tracking pixel is currently active
Provider-specific pixel ID (e.g., Facebook Pixel ID, Google Ads Conversion ID)
Optional access token for providers that require authentication
Custom JavaScript code for CUSTOM provider type. Will be injected into the page.
Custom image URL for IMAGE type pixels. Will be loaded as a 1x1 tracking pixel.
Page types where this pixel should fire. Empty list or containing ALL means fire on all pages.
Event triggers that cause this pixel to fire, with optional custom parameters.
object
The event type that triggers this pixel
Custom key-value parameters to include with the event
object
Parameter name (e.g., ‘currency’, ‘value’, ‘content_id’)
Parameter value. Can be a static value or a placeholder like ‘{booking.total}’
Custom font for the booking engine. Null means use the system default.
Example
{ "identifier": "", "name": "", "appendToPageTitle": "", "ownerIdentifier": "", "ownerName": "", "subType": "TRIP_PAY", "primary": false, "googleAnalyticsMeasurementId": "", "googleTagManagerContainerId": "", "googleMapsAPIKey": "", "defaultCurrency": "USD", "defaultLanguage": "en", "logoImageIdentifier": "", "hostedBookingEngineUrl": "https://ota.wink.travel", "selfHosted": false, "themeColors": "", "numberOfAdvanceDays": "", "numberOfStayDays": "", "startDate": "", "endDate": "", "roomConfigurations": "", "useDays": false, "promotionalCodes": "", "wcBookClickAction": "FORWARD_TO_IBE", "showUnavailableCard": false, "showRankings": false, "showSearch": false, "layout": "INFORMATIONAL", "cardLayout": "HORIZONTAL", "trackingPixels": "", "fontId": "UI_SANS_SERIF"}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}