Register Property
const url = 'https://api.wink.travel/api/property?leadId=lead-123';const options = { method: 'POST', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: 'null'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://api.wink.travel/api/property?leadId=lead-123' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullRegisters a new property with the minimum required dataset to onboard a property.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”A lead (property that exists in Google and was added as a Lead on Wink) record is required to create a property this way.
Example
lead-123Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”The values here override, or help complete, the lead data that is already in the database. Most times, it will be the address from Google that cannot be properly mapped and will need some human intervention.
object
Account email is where we will send KYC documents and other account specific mailings
Example
Account phone number is mostly used for KYC purchases
Example
+1 212 555 1212Unique hotel trade name. The hotel name must be unique. If there are multiple hotels with the same name, we recommend appending destination to the name. Verify uniqueness here.
Example
The Getaway resort - UbudLocal name of the hotel as it is referred to in the local language.
Example
Getaway Resorts LimitedLegal name of entity if other than name
Example
Legal AffiliateAccount 1Account’s main currency.
Example
GBPProperty address.
object
Address line 1
Example
234 Near da beachAddress line 2
Example
Pebble #5001City geo name ID
Example
897654State
Example
CAPostal / zip code
Example
90210County
Example
Alameda countyProperty local address.
object
Address line 1
Example
234 Near da beachAddress line 2
Example
Pebble #5001State
Example
CAPostal / zip code
Example
90210County
Example
Alameda countyCity name
Country
Country
Example
United StatesAddress 1, Address 2, City, State, Postal / Zip code, Country
Example
11 At home, Suite 3C, New York City, NY 10010, United StatesReservation desk information.
object
Example
{ "type": "POINT", "coordinates": [ 100.5581533, 13.7370197 ]}Whether to approve the incoming rating from Google Places
Example
trueWebsite of property
Example
www.brand.comReservation desk information.
object
Contact first name
Example
JohnContact last name
Example
SmithContact phone number
Example
+12125551212First and last name
Example
John SmithRevenue information.
object
Contact first name
Example
JohnContact last name
Example
SmithContact phone number
Example
+12125551212First and last name
Example
John SmithMarketing information.
object
Contact first name
Example
JohnContact last name
Example
SmithContact phone number
Example
+12125551212First and last name
Example
John SmithLeverages AI to pre-populate the description.
object
Use as title or short text description
Example
An example titleLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enProperty profile.
object
Textual description of property ambiance
Example
That 70s vibe.Property architecture
Example
1 (from taxonomy ARC)Textual description of property design elements
Example
A whole lot of wood.Textual description of property’s historic significance
Example
The 7 dwarfs lived here.Number of keys for this property
Example
40Number of stars for this propert.
Example
5Property location code
Example
1 (from taxonomy LOC)Property segment code
Example
2 (from taxonomy SEG)Property class code
Example
1 (from taxonomy PCT)Textual description of property style
Example
An unmistakable hint of Dior with a dab of GivenchyTextual name of property chain
Example
WunderbaumTextual name of property brand
Example
WunderbaumThe year the property was built
Example
1923Account agrees to let us use theor logo and images for marketing purposes (with proper credits).
Responses
Section titled “ Responses ”Created
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
User owner ID.
Parent ID. Because it’s all 1-1, it should be the same ID.
The App owner that created this record.
Let users manage this entity and all sub-entities.
object
User email
Contact phone number
User identifier
Contact first name
Contact last name
Contact secondary Email
Contact phone number
Profile picture is available
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.
Whether it was user or system generated.
The md5 hash of the name, description and language.
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
Account owner
Per-section access grants for object-level ACL
object
The area this grant applies to (ALL covers every section)
How much the manager may do within that area
If another company entity is managing this property, on behalf of the property, it can be specified here and the managing entity would be applicable a management fee on every booking.
object
Entity identifier
Name of entity
Agency commission
Optional rules for expiration date etc when agency is no longer managing this entity.
object
Optional expiration date when agency is no longer managing this entity.
Optional total number of bookings [left] the agency is entitled to commission. This number will decrement every time a booking is made with this agency involved.
Whether managing entity rules has expired.
Whether managing entity is eligible a commission.
Type of entity this is.
Type of sales channel
Unique hotel trade name. The hotel name must be unique. If there are multiple hotels with the same name, we recommend appending destination to the name. Verify uniqueness here.
Legal name of your hotel as it is registered.
Unique url-friendly slug to identify property
Event shorter name
Currency code
Wink.travel sets this status as the hotel moves through the payment workflow and manually for approval.
City location
object
GeoName identifier
GeoNameLightweight type
Name of city
Url name
Ascii name of city
Coordinate points of the city
object
Timezone
Country
object
ISO code
Country name
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
Country sub division
object
Sub-country name
Sub-country ascii name
Sub-country GeoNames identifier
Country sub sub division
object
Address information
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
Optional Google placeId for properties with a Google Business account.
A shorter unique code to refer to the hotel. Country Code + 5 digit number
Name of the hotel in its local language if you use it for domestic guests.
Property becomes publicly available once Wink admin activates this.
List of images / videos of property.
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.
Whether it was user or system generated.
The md5 hash of the name, description and language.
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
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.
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.
Hotel chain name if property is part of that chain.
Hotel brand name if property is part of that brand.
If the property is currently using a channel manager but it isn’t yet part of our list, chose ‘OTHER_CHANNEL_MANAGER’ as channelManager and fill in the name of the channel manager here
If the property has a valid license number to run a hotel in their country, add it here.
Hotel star rating.
General manager related data.
object
Name of GM currently managing the property.
Cloudinary image identifier of GM currently managing the property.
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
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.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Localized short and long welcome text of property.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
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.
GeoJSON point containing latitude and longitude of property. Note: x = longitude, y = latitude.
object
Property policies such as pets and children, early and late checkout and more
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.
List of all social network account property has.
Social network
object
Type of social network.
URL or social network identifier to social network profile
Reservation desk contact information
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Accounting contact information
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Accounting contact address
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Properties that answered the Green Index questionnaire [full or partial], will have aggregate scores available.
object
object
The highest possible score from all questions
The total score from all questions answered
Total score divided by high score
Aggregate scores by Green Index category
object
Green Index category
The highest possible score from all questions within this category
The total score from all questions answered within this category
Total score divided by high score within this category
Number of rooms / keys for property
If the reservation desk does not operate 24 hours, enter a start time.
If the reservation desk does not operate 24 hours, enter an end time.
Property brand.com website.
Google Maps URL of the place
This can be an enum for external channel managers or an identifier for a Wink company rate provider
object
The value that should be persisted.
English readable text of the value.
Place to put stuff into
object
Property is both approved and activated.
Property activated itself and went live.
Whether property has any social networks associated with her profile.
Whether property has any lifestyles associated with her profile.
Platform approved property.
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "userIdentifier": "", "managingEntityIdentifier": "", "ownerIdentifier": "", "managers": [ "" ], "managedBy": "", "ownerType": "COMPANY", "type": "TRIP_PAY", "name": "", "legalName": "", "urlName": "", "uniqueId": "", "currencyCode": "", "status": "PENDING_APPROVAL", "city": "", "address": null, "placeId": "", "hotelCode": "", "localName": "", "externalStatus": "ACTIVE", "multimedias": [ "" ], "recognitionList": [ null ], "locationCategory": "", "segmentCategory": "", "hotelCategory": "", "architecturalStyle": "", "whenBuilt": "", "hotelChain": "", "hotelBrand": "", "otherChannelManager": "", "licenseNumber": "", "stars": "", "generalManager": null, "descriptions": "", "hotelAmenityCodes": "", "propertyAccessibilityCodes": "", "propertySecurityCodes": "", "locationPoint": "", "policy": "", "socials": "", "reservationsContact": "", "revenueContact": "", "marketingContact": "", "lifestyleTypes": [ "LIFESTYLE_HEALTH_FITNESS" ], "greenIndexScores": "", "numberOfRooms": "", "reservationDeskStartTime": "", "reservationDeskEndTime": "", "website": "", "googleMapsUrl": "", "rateProvider": "", "metadata": "", "active": false, "propertyActive": false, "socialNetworks": false, "lifestyles": false, "platformActive": false}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
{}