Show property

GET

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

const url = 'https://integrations.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/channel-manager';
const options = {
  method: 'GET',
  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 GET \
  --url https://integrations.wink.travel/api/managing-entity/e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18/channel-manager \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Returns the given property’s details together with its full list of room-level master rates.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

Property identifier (UUID)

Example

e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

application/json

object

property

required

Property details

object

identifier

required

Property ID

string format: uuid

"" >= 1 characters

name

required

Property name

string

"" >= 1 characters

city

required

City property is located in or near

string

"" >= 1 characters

countryCode

required

Country code property is located in

string

"" >= 1 characters

currencyCode

required

Currency code property uses

string

"" >= 1 characters

timeZone

required

Timezone property is located in

string

"" >= 1 characters

list

List of master rates (room type + rate plan combinations) for this property

Array<object>

object

identifier

required

Master rate identifier

string format: uuid

"" >= 1 characters

propertyIdentifier

required

Property identifier

string format: uuid

"" >= 1 characters

name

required

Master rate name (room type + rate plan)

string

"" >= 1 characters

roomTypeIdentifier

required

Room type identifier

string format: uuid

"" >= 1 characters

ratePlanIdentifier

required

Rate plan identifier

string format: uuid

"" >= 1 characters

guestRoomName

required

Room type name for display

string

"" >= 1 characters

ratePlanName

required

Rate plan name for display

string

"" >= 1 characters

minOccupancy

required

Minimum occupancy for this room type

integer format: int32

maxOccupancy

required

Maximum occupancy for this room type

integer format: int32

maxAdultOccupancy

required

Maximum number of adults allowed in this room type

integer format: int32

maxChildOccupancy

required

Maximum number of children allowed in this room type

integer format: int32

includedAdultOccupancy

required

Number of adults the base rate price is calculated for

integer format: int32

includedChildOccupancy

required

Number of children the base rate price is calculated for

integer format: int32

baseRate

required

Base nightly rate in high-demand period

object

amount

required

number

currency

required

string

>= 1 characters

singleOccupancyRateModifier

required

Rate modifier for single occupancy (JSON representation of VariableCharge)

object

type

required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string

Allowed values: FIXED PERCENTAGE

percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

extraPaxRateModifier

required

Rate modifier for extra occupants (JSON representation of VariableCharge)

object

type

required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string

Allowed values: FIXED PERCENTAGE

percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

extraChildRateModifier

required

Rate modifier for extra children (JSON representation of VariableCharge)

object

type

required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string

Allowed values: FIXED PERCENTAGE

percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

Example

{
  "property": "",
  "list": ""
}

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

{}

Show property

Authorizations

Parameters

Path Parameters

Example

Header Parameters

Responses

200

Example

400

Example generated

401

403

500

Example generated

Example ^generated

Example ^generated