Skip to content
Wink

Show Sales Channel

GET
/api/managing-entity/{managingEntityIdentifier}/studio/sales-channel/supplier/{supplierManagingEntityIdentifier}
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/example/studio/sales-channel/supplier/example \
  --header 'Wink-Version: 2.0'

Retrieve sales channel specified by the company ID and the supplier ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
supplierManagingEntityIdentifier
required
string

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
id

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
""
supplierIdentifier
required

Channel is owned by this supplier identifier.

string format: uuid
"" >= 1 characters
supplierName
required

Name of property / supplier that owns this channel

string
"" >= 1 characters
supplierAvailable
required

Flag when supplier not available. E.g. Hotel disables property

boolean
default: true
subType
required

What type of segment of channel is this.

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
ownerIdentifier

A specific identifier for the company / corporation / travel agency that is retrieving the rates

string format: uuid
""
ownerName

Name of the owner / affiliate. Hotel booking customization when it’s the booking customization.

string
""
enabled

Flag the supplier can use to enable / disable this channel

boolean
default: true
channelDisabled

System override by supplier to disable channel. E.g. Platform disables supplier.

boolean
blacklisted
required

A way to blacklist a specific channel a property doesn’t want to send blocking to.

boolean
percentDiscount

Percent discount on this channel and all its children [unless configured at the child level].

number format: float
"" <= 1
commission

Amount of sales commission earned through this channel and all its children [unless configured at the child level].

number format: float
"" <= 1
rateModifiers

Promotions for this channel

Array<object>
""
object
identifier
required

Unique record identifier

string format: uuid
"" >= 1 characters
hotelIdentifier
required

Hotel identifier.

string format: uuid
"" >= 1 characters
name
required

Internal name of promotion.

string
"" >= 1 characters
type
required

Set whether you want the price to go up or down when the rules of this promotion have been satisfied.

string
""
Allowed values: PREMIUM DISCOUNT
modifier
required
enabled
required

Whether this promotion is enabled or not.

boolean
default: true
pricingType
required

This determines whether this discount should be applied per night, per stay or per person - per night

string
""
Allowed values: PER_STAY PER_DAY PER_NIGHT PER_USE PER_HOUR PER_PERSON PER_PERSON_PER_NIGHT PER_PERSON_PER_HOUR PER_ADULT PER_ADULT_PER_NIGHT PER_ADULT_PER_HOUR PER_CHILD PER_CHILD_PER_NIGHT PER_CHILD_PER_HOUR
descriptions
required

Localized descriptions describing promotion. At least one English entry is required.

Array<object>
"" >= 1 items
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
cityRateQualifiers

Restrict promotion to specific cities. See Geo-IP city geoname data

Array
""
continentRateQualifiers

Restrict promotion to specific continents. See Geo-IP continent geoname data

Array
""
countryRateQualifiers

Restrict promotion to specific countries. See Geo-IP country geoname data

Array
""
promotionRateQualifiers

Restrict promotion by requiring users to enter a promo code.

Array
""
ipRangeRateQualifiers

Restrict promotion to specific IP ranges.

Array
""
roomRangeRateQualifier

Restrict promotion by restricting to how many rooms the user wants.

""
prepayRateQualifier

Restrict promotion to either prepaid / non-prepaid rates.

""
refundableRateQualifier

Restrict promotion to either refundable / non-refundable rates.

""
timezoneRateQualifiers

Restrict promotion to specific time zones. See Geo-IP timezone geoname data

Array
""
lastMinuteRateQualifier

Restrict promotion to users who want to book a room close to the date.

""
lengthOfStayRateQualifier

Restrict promotion to users who want to stay a certain number of days.

""
advanceBookingRateQualifier

Restrict promotion to users who want to book in advance.

""
stayDateRateQualifiers

Restrict promotion to specific stay dates the user wants to arrive.

Array
""
sellDateRateQualifiers

Restrict promotion to specific dates the booking is made.

Array
""
availableDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the promotion is available.

""
arrivalDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is arriving.

""
departureDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is departing.

""
requiredDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest has to stay.

""
masterRateIdentifiers

Restrict on specific master rates.

Array<string>
""
addOnIdentifiers

Restrict on specific add-ons.

Array<string>
""
ratePlanIdentifiers

Restrict on specific rate plans.

Array<string>
""
blackoutDates

Exclude this promotion from specific date ranges.

Array
""
rateModifierBundles

Promotion bundles for this channel

Array<object>
""
object
identifier
required

Unique record identifier

string format: uuid
"" >= 1 characters
hotelIdentifier
required

Hotel identifier.

string format: uuid
"" >= 1 characters
name
required

Internal name of promotion ancillary.

string
"" >= 1 characters
enabled
required

Whether this promotion ancillary is enabled or not.

boolean
default: true
items
required
Array<object>
>= 1 items

Promotions that go together to make up this ancillary.

object
identifier
required

Unique record identifier

string format: uuid
"" >= 1 characters
hotelIdentifier
required

Hotel identifier.

string format: uuid
"" >= 1 characters
name
required

Internal name of promotion.

string
"" >= 1 characters
type
required

Set whether you want the price to go up or down when the rules of this promotion have been satisfied.

string
""
Allowed values: PREMIUM DISCOUNT
modifier
required
enabled
required

Whether this promotion is enabled or not.

boolean
default: true
pricingType
required

This determines whether this discount should be applied per night, per stay or per person - per night

string
""
Allowed values: PER_STAY PER_DAY PER_NIGHT PER_USE PER_HOUR PER_PERSON PER_PERSON_PER_NIGHT PER_PERSON_PER_HOUR PER_ADULT PER_ADULT_PER_NIGHT PER_ADULT_PER_HOUR PER_CHILD PER_CHILD_PER_NIGHT PER_CHILD_PER_HOUR
descriptions
required

Localized descriptions describing promotion. At least one English entry is required.

Array<object>
"" >= 1 items
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
cityRateQualifiers

Restrict promotion to specific cities. See Geo-IP city geoname data

Array
""
continentRateQualifiers

Restrict promotion to specific continents. See Geo-IP continent geoname data

Array
""
countryRateQualifiers

Restrict promotion to specific countries. See Geo-IP country geoname data

Array
""
promotionRateQualifiers

Restrict promotion by requiring users to enter a promo code.

Array
""
ipRangeRateQualifiers

Restrict promotion to specific IP ranges.

Array
""
roomRangeRateQualifier

Restrict promotion by restricting to how many rooms the user wants.

""
prepayRateQualifier

Restrict promotion to either prepaid / non-prepaid rates.

""
refundableRateQualifier

Restrict promotion to either refundable / non-refundable rates.

""
timezoneRateQualifiers

Restrict promotion to specific time zones. See Geo-IP timezone geoname data

Array
""
lastMinuteRateQualifier

Restrict promotion to users who want to book a room close to the date.

""
lengthOfStayRateQualifier

Restrict promotion to users who want to stay a certain number of days.

""
advanceBookingRateQualifier

Restrict promotion to users who want to book in advance.

""
stayDateRateQualifiers

Restrict promotion to specific stay dates the user wants to arrive.

Array
""
sellDateRateQualifiers

Restrict promotion to specific dates the booking is made.

Array
""
availableDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the promotion is available.

""
arrivalDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is arriving.

""
departureDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is departing.

""
requiredDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest has to stay.

""
masterRateIdentifiers

Restrict on specific master rates.

Array<string>
""
addOnIdentifiers

Restrict on specific add-ons.

Array<string>
""
ratePlanIdentifiers

Restrict on specific rate plans.

Array<string>
""
blackoutDates

Exclude this promotion from specific date ranges.

Array
""
modifierOverride
type

Required if manual override modifier is not null

string
""
Allowed values: PREMIUM DISCOUNT
pricingType

Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null

string
""
Allowed values: PER_STAY PER_DAY PER_NIGHT PER_USE PER_HOUR PER_PERSON PER_PERSON_PER_NIGHT PER_PERSON_PER_HOUR PER_ADULT PER_ADULT_PER_NIGHT PER_ADULT_PER_HOUR PER_CHILD PER_CHILD_PER_NIGHT PER_CHILD_PER_HOUR
descriptions

Optional bundle-level descriptions. When populated, these replace the aggregated item descriptions in offerDetails.

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
isValid
boolean
aggregatedItemDescriptions
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
hasFixedDiscountModifier
boolean
hasPercentDiscountModifier
boolean
effectiveDescriptions
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
selfAcquires

Whether the sales channel is a self-acquiring entity.

boolean
Example 
{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "supplierIdentifier": "",
  "supplierName": "",
  "supplierAvailable": true,
  "subType": "TRIP_PAY",
  "ownerIdentifier": "",
  "ownerName": "",
  "enabled": true,
  "channelDisabled": false,
  "blacklisted": false,
  "percentDiscount": "",
  "commission": "",
  "rateModifiers": "",
  "rateModifierBundles": "",
  "selfAcquires": false
}

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
{}