Skip to content
Wink

Show Property

GET
/api/channel-manager/property/{propertyIdentifier}
 
curl --request GET \
  --url https://integrations.wink.travel/api/channel-manager/property/property-1 \
  --header 'Wink-Version: 2.0'

Retrieves property record with master rates included.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
propertyIdentifier
required
string
default: ##default

Retrieve record for this propertyIdentifier

Example 
property-1

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
property
required
object
identifier
required

Property ID

string format: uuid
default: ##default >= 1 characters
name
required

Property name

string
default: ##default >= 1 characters
city
required

City property is located in or near

string
default: ##default >= 1 characters
countryCode
required

Country code property is located in

string
default: ##default >= 1 characters
currencyCode
required

Currency code property uses

string
default: ##default >= 1 characters
timeZone
required

Timezone property is located in

string
default: ##default >= 1 characters
list
Array<object>
object
identifier
required
string
>= 1 characters
propertyIdentifier
required
string
>= 1 characters
name
required
string
>= 1 characters
roomTypeIdentifier
required
string
>= 1 characters
ratePlanIdentifier
required
string
>= 1 characters
guestRoomName
required
string
>= 1 characters
ratePlanName
required
string
>= 1 characters
minOccupancy
required
integer format: int32
maxOccupancy
required
integer format: int32
maxAdultOccupancy
required
integer format: int32
maxChildOccupancy
required
integer format: int32
includedAdultOccupancy
required
integer format: int32
includedChildOccupancy
required
integer format: int32
baseRate
required
object
amount
required
number
currency
required
string
>= 1 characters
singleOccupancyRateModifier
required
object
type
required

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

string
default: ##default
Allowed values: FIXED PERCENTAGE
percent

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

number format: float
default: ##default
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
extraPaxRateModifier
required
object
type
required

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

string
default: ##default
Allowed values: FIXED PERCENTAGE
percent

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

number format: float
default: ##default
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
extraChildRateModifier
required
object
type
required

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

string
default: ##default
Allowed values: FIXED PERCENTAGE
percent

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

number format: float
default: ##default
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
Example 
{
  "property": {
    "identifier": "##default",
    "name": "##default",
    "city": "##default",
    "countryCode": "##default",
    "currencyCode": "##default",
    "timeZone": "##default"
  },
  "list": [
    {
      "singleOccupancyRateModifier": {
        "type": "FIXED",
        "percent": "##default",
        "fixedAmount": "##default"
      },
      "extraPaxRateModifier": {
        "type": "FIXED",
        "percent": "##default",
        "fixedAmount": "##default"
      },
      "extraChildRateModifier": {
        "type": "FIXED",
        "percent": "##default",
        "fixedAmount": "##default"
      }
    }
  ]
}

400

Section titled “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

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}