Set Channel Manager

PATCH

/api/managing-entity/{managingEntityIdentifier}/extranet/channel-manager

const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/channel-manager';
const options = {
  method: 'PATCH',
  headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'},
  body: '{"rateProvider":""}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/channel-manager \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "rateProvider": "" }'

Set which channel manager this property uses. Channel managers are not allowed access to rates until the property selects them as their channel manager.

Parameters

Path Parameters

managingEntityIdentifier

required

string

Set channel manager for this property identifier

Example

hotel-1

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

rateProvider

required

Property’s channel manager. Rate ownership is decided based on the channel manager selected. This can be both an enum and an identifier.

object

value

required

The value that should be persisted.

string

"" >= 1 characters

Example

id-1

label

required

English readable text of the value.

string

"" >= 1 characters

Example

Readable text label

Responses

200

application/json

object

Document UUID

string

createdDate

Datetime this record was first created

string format: date-time

lastUpdate

Datetime this record was last updated

string format: date-time

version

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.

integer format: int64

userIdentifier

required

User owner ID.

string format: uuid

"" >= 1 characters

managingEntityIdentifier

required

Parent ID. Because it’s all 1-1, it should be the same ID.

string format: uuid

"" >= 1 characters

ownerIdentifier

required

The App owner that created this record.

string

"" >= 1 characters

managers

required

Array<object>

>= 1 items

Let users manage this entity and all sub-entities.

object

email

required

User email

string format: email

"" >= 1 characters

status

Contact phone number

string

Allowed values: PENDING ACCEPTED DEACTIVATED

userIdentifier

User identifier

string format: uuid

firstName

Contact first name

string

lastName

Contact last name

string

secondaryEmail

Contact secondary Email

string

phoneNumber

Contact phone number

string

profilePicture

Profile picture is available

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

angle

Media angle

string

width

required

Media width in pixels.

integer format: int32

"" >= 1

height

required

Media height in pixels.

integer format: int32

"" >= 1

published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

name

required

Name of contributor

string

"" >= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

owner

Account owner

boolean

sectionGrants

Array<object>

Per-section access grants for object-level ACL

object

section

required

The area this grant applies to (ALL covers every section)

string

Allowed values: ALL ACCOUNT INVENTORY BOOKING MARKETING CONTENT ANALYTICS INTEGRATIONS MCP PAYMENT ACCOUNTING USER_ADMIN ADMIN

level

required

How much the manager may do within that area

string

Allowed values: READ WRITE FULL

name

string

active

boolean

managedBy

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

identifier

required

Entity identifier

string

"" >= 1 characters

name

required

Name of entity

string

"" >= 1 characters

commissionInPercent

required

Agency commission

number

rules

Optional rules for expiration date etc when agency is no longer managing this entity.

object

expires

Optional expiration date when agency is no longer managing this entity.

string format: date

numBookings

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.

integer format: int32

nonExpired

Whether managing entity rules has expired.

boolean

valid

Whether managing entity is eligible a commission.

boolean

ownerType

required

Type of entity this is.

string

Allowed values: COMPANY INDIVIDUAL

type

required

Type of sales channel

string

Allowed values: TRIP_PAY FACILITATOR DIRECT APPLICATION HOTEL TRAVELIKO CORPORATE TRAVEL_AGENT INFLUENCER BLOGGER DESTINATION CHANNEL_MANAGER PROPERTY_MANAGEMENT_SYSTEM CENTRAL_RESERVATION_SYSTEM GOOGLE_HOTEL_API MANAGEMENT_COMPANY CHAIN BRAND EVENT_ORGANIZER OTHER

name

required

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.

string

"" >= 1 characters

legalName

required

Legal name of your hotel as it is registered.

string

"" >= 1 characters

urlName

required

Unique url-friendly slug to identify property

string

"" >= 1 characters

uniqueId

required

Event shorter name

string

"" >= 1 characters

currencyCode

required

Currency code

string

status

required

Wink.travel sets this status as the hotel moves through the payment workflow and manually for approval.

string

default: APPROVED

Allowed values: PENDING_APPROVAL ACTIVE INACTIVE UNDER_REVIEW SUSPENDED REJECTED REMOVED

city

required

City location

object

geoNameId

GeoName identifier

string

type

GeoNameLightweight type

string

Allowed values: CITY ISLAND OTHER

name

Name of city

string

urlName

Url name

string

asciiName

Ascii name of city

string

location

Coordinate points of the city

object

number format: double

type

string

coordinates

Array<number>

featureCode

string

countryCode

string

timezone

Timezone

string

country

Country

object

iso

ISO code

string

name

Country name

string

capital

Country capital

string

continent

Continent code

string

currencyCode

Currency code

string

currencyName

Currency name

string

geoNameId

Country GeoNames identifier

string

subCountry

Country sub division

object

name

Sub-country name

string

asciiName

Sub-country ascii name

string

geoNameId

Sub-country GeoNames identifier

string

subSubCountry

Country sub sub division

object

name

string

asciiName

string

geoNameId

string

address

Address information

object

address1

Address line 1

string

address2

Address line 2

string

state

State

string

postalCode

Postal / zip code

string

county

County

string

city

City name

string

countryCode

Country

string

country

Country

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

placeId

Optional Google placeId for properties with a Google Business account.

string

hotelCode

required

A shorter unique code to refer to the hotel. Country Code + 5 digit number

string

"" >= 1 characters

localName

Name of the hotel in its local language if you use it for domestic guests.

string

externalStatus

required

Property becomes publicly available once Wink admin activates this.

string

default: ACTIVE >= 1 characters

Allowed values: ACTIVE INACTIVE

multimedias

List of images / videos of property.

Array<object>

Multimedia that contains less information than Multimedia object

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

angle

Media angle

string

width

required

Media width in pixels.

integer format: int32

"" >= 1

height

required

Media height in pixels.

integer format: int32

"" >= 1

published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

name

required

Name of contributor

string

"" >= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

recognitionList

Inventory-level recognition.

Array<object>

Recognition for the ancillary blocking.

object

identifier

required

Recognition identifier.

string format: uuid

"" >= 1 characters

category

required

Recognition category.

string

Allowed values: THIRD_PARTY_REVIEW PUBLICATION AWARD

type

required

Type of rating system the recognition operated on. This allows us to display the score properly.

string

Allowed values: STAR_RATING NUMERIC_RATING PERCENT_RATING

provider

required

The name of the entity that administers this recognition.

string

"" >= 1 characters

rating

required

The actual award or rating received by the hotel facility.

number format: float

maxRating

required

Use this to let hotels indicate what the total score for this award is.

number format: float

date

The date the award was received

string format: date

officialAppointmentInd

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.

boolean

ratingSymbol

Provides the symbol used in the rating. Used in conjunction with the Rating.

string

locationCategory

Supported OTA specification LOC code. See OTA geoname data

string

segmentCategory

Supported OTA specification SEG code. See OTA geoname data

string

hotelCategory

Supported OTA specification PCT code. See OTA geoname data

string

architecturalStyle

Supported OTA specification ARC code. See OTA geoname data

string

whenBuilt

Year the property was constructed.

string

hotelChain

Hotel chain name if property is part of that chain.

string

hotelBrand

Hotel brand name if property is part of that brand.

string

otherChannelManager

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

string

licenseNumber

If the property has a valid license number to run a hotel in their country, add it here.

string

stars

Hotel star rating.

integer format: int32

"" <= 6

generalManager

General manager related data.

object

name

required

Name of GM currently managing the property.

string

image

Cloudinary image identifier of GM currently managing the property.

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

angle

Media angle

string

width

required

Media width in pixels.

integer format: int32

"" >= 1

height

required

Media height in pixels.

integer format: int32

"" >= 1

published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

name

required

Name of contributor

string

"" >= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

descriptions

Localized welcome message from GM.

Array<object>

object

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

descriptions

Localized short and long welcome text of property.

Array<object>

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

hotelAmenityCodes

Supported OTA specification HAC code. See OTA geoname data.

Array<string>

propertyAccessibilityCodes

Supported OTA specification PHY code. See OTA geoname data.

Array<string>

propertySecurityCodes

Supported OTA specification SEC code. See OTA geoname data.

Array<string>

locationPoint

GeoJSON point containing latitude and longitude of property. Note: x = longitude, y = latitude.

object

number format: double

type

string

coordinates

Array<number>

policy

Property policies such as pets and children, early and late checkout and more

object

childrenAllowed

required

Indicates whether property allows children

boolean

childrenMinimumAge

When a property allows children, it can also indicate what the minimum age is for children to be allowed.

integer format: int32

internetAvailability

required

Indicates the availability of internet on the property.

string

Allowed values: YES NO YES_PAID

internetConnectionType

Indicates how guests can access the Internet on the property.

string

Allowed values: WIFI CABLE

internetConnectionLocation

Indicates where internet is available in and around the property.

string

Allowed values: ENTIRE_PROPERTY PUBLIC_AREAS ALL_ROOMS SOME_ROOMS BUSINESS_CENTER

parkingAvailability

required

Indicates whether parking is available at the property.

string

Allowed values: YES NO YES_PAID

parkingAccess

Indicates what type of parking is available at the property.

string

Allowed values: PRIVATE PUBLIC

petsAllowed

required

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.

boolean

petMaxWeightInKilos

If pets are allowed, property can further limit on weight.

integer format: int32

petCharge

If pets are allowed, property can tell travelers if there is a charge applicable for the pet.

object

amount

required

number

currency

required

string

>= 1 characters

checkOutTime

required

When the guest has to check out.

string

"" >= 1 characters

checkInTime

required

When the guest can check in.

string

"" >= 1 characters

socials

List of all social network account property has.

Array<object>

Social network

object

type

Type of social network.

string

Allowed values: FACEBOOK INSTAGRAM SKYPE TRIP_ADVISOR TWITTER GOOGLE_PLUS WHATSAPP LINE WECHAT VIBER SNAPCHAT WEIBO RENREN WEBSITE QQ TIKTOK

location

URL or social network identifier to social network profile

string

reservationsContact

Reservation desk contact information

object

firstName

Contact first name

string

lastName

Contact last name

string

email

Contact E-mail

string format: email

secondaryEmail

Contact secondary Email

string

phoneNumber

Contact phone number

string

fullName

First and last name

string

summary

Summary

string

revenueContact

Accounting contact information

object

firstName

Contact first name

string

lastName

Contact last name

string

email

Contact E-mail

string format: email

secondaryEmail

Contact secondary Email

string

phoneNumber

Contact phone number

string

fullName

First and last name

string

summary

Summary

string

marketingContact

Accounting contact address

object

firstName

Contact first name

string

lastName

Contact last name

string

email

Contact E-mail

string format: email

secondaryEmail

Contact secondary Email

string

phoneNumber

Contact phone number

string

fullName

First and last name

string

summary

Summary

string

lifestyleTypes

Array<string>

greenIndexScores

Properties that answered the Green Index questionnaire [full or partial], will have aggregate scores available.

object

hotelIdentifier

required

string

list

required

Array<object>

object

questionKey

string

value

integer format: int32

highScore

required

The highest possible score from all questions

integer format: int32

totalScore

required

The total score from all questions answered

integer format: int32

aggregateScore

required

Total score divided by high score

number format: float

"" <= 1

scoresByCategory

required

Aggregate scores by Green Index category

Array<object>

object

category

required

Green Index category

string

Allowed values: GENERAL ENERGY WATER PURCHASING WASTE SITE

highScore

required

The highest possible score from all questions within this category

integer format: int32

totalScore

required

The total score from all questions answered within this category

integer format: int32

aggregateScore

required

Total score divided by high score within this category

number format: float

"" <= 1

numberOfRooms

required

Number of rooms / keys for property

integer format: int32

reservationDeskStartTime

If the reservation desk does not operate 24 hours, enter a start time.

string

reservationDeskEndTime

If the reservation desk does not operate 24 hours, enter an end time.

string

website

Property brand.com website.

string

googleMapsUrl

Google Maps URL of the place

string

rateProvider

This can be an enum for external channel managers or an identifier for a Wink company rate provider

object

value

required

The value that should be persisted.

string

"" >= 1 characters

label

required

English readable text of the value.

string

"" >= 1 characters

metadata

Place to put stuff into

object

key

additional properties

active

Property is both approved and activated.

boolean

propertyActive

Property activated itself and went live.

boolean

socialNetworks

Whether property has any social networks associated with her profile.

boolean

lifestyles

Whether property has any lifestyles associated with her profile.

boolean

platformActive

Platform approved property.

boolean

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
}

400

Bad Request

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Set Channel Manager

Parameters

Path Parameters

Example

Header Parameters

Request Body required

Example

Example

Responses

200

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated