Skip to content
Wink

Show Promotion Bundle

GET
/api/managing-entity/{managingEntityIdentifier}/extranet/promotion-bundle/{rateModifierBundleIdentifier}
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/promotion-bundle/promotion-bundle-1 \
  --header 'Wink-Version: 2.0'

Retrieve a rate modifier ancillary by its identifier

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Show single promotion bundle owned by this property identifier.

Example 
hotel-1
rateModifierBundleIdentifier
required
string
""

Show single promotion bundle with this identifier.

Example 
promotion-bundle-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
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
""
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
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
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<object>
""
object
city
required

City geoIP

object
geoNameId
required

GeoNameLightweight identifiers taken from https://geonames.org.

string
"" >= 1 characters
localeCode
required

Locale code

string
"" >= 1 characters
continentCode
required

Continent code

string
"" >= 1 characters
continentName
required

Continent name

string
"" >= 1 characters
countryIsoCode
required

Country ISO code

string
"" >= 1 characters
countryName
required

Country name

string
"" >= 1 characters
cityName
required

City name

string
"" >= 1 characters
timezone
required

Timezone

string
"" >= 1 characters
subDivision1Code

Sub-division 1 code

string
""
subDivision1Name

Sub-division 1 name

string
""
subDivision2Code

Sub-division 2 code

string
""
subDivision2Name

Sub-division 2 name

string
""
continentRateQualifiers

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

Array<object>
""
object
continent
required

Continent code

string
"" >= 1 characters
countryRateQualifiers

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

Array<object>
""
object
country
required

Country to restrict on

object
geoNameId
string
continentCode
string
continentName
string
countryIsoCode
string
countryName
string
promotionRateQualifiers

Restrict promotion by requiring users to enter a promo code.

Array<object>
""
object
promotion
required

Promotion code

string
"" >= 1 characters
ipRangeRateQualifiers

Restrict promotion to specific IP ranges.

Array<object>
""
object
startIPRange
required

Start of IP range

string
"" >= 1 characters
endIPRange
required

End of IP range

string
"" >= 1 characters
roomRangeRateQualifier

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

object
minRooms
required

Minimum number of rooms

integer format: int32
"" >= 1
maxRooms

Maximum number of rooms

integer format: int32
""
prepayRateQualifier

Restrict promotion to either prepaid / non-prepaid rates.

object
prepay
required

Whether prepay is required or not

boolean
refundableRateQualifier

Restrict promotion to either refundable / non-refundable rates.

object
refundable
required

Whether restriction is on refundable rates

boolean
timezoneRateQualifiers

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

Array<object>
""
object
timezone
required

Bookers timezone

string
"" >= 1 characters
lastMinuteRateQualifier

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

object
seconds

Seconds before day of arrival occurs

integer format: int64
""
lengthOfStayRateQualifier

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

object
minLOS

Minimum length of stay qualifier

integer format: int32
""
maxLOS

Maximum length of stay qualifier

integer format: int32
""
advanceBookingRateQualifier

Restrict promotion to users who want to book in advance.

object
minAdvanceBookingOffset

Minimum advance booking offset qualifier

integer format: int32
""
maxAdvanceBookingOffset

Maximum advance booking offset qualifier

integer format: int32
""
stayDateRateQualifiers

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

Array<object>
""
object
effectiveDate
required

The effective (start) date of the stay date rate qualifier

string format: date
""
expireDate
required

The expiration (end) date of the stay date rate qualifier

string format: date
""
sellDateRateQualifiers

Restrict promotion to specific dates the booking is made.

Array<object>
""
object
effectiveDate
required

The effective (start) date of the sell date rate qualifier

string format: date
""
expireDate
required

The expiration (end) date of the sell date rate qualifier

string format: date
""
availableDaysOfWeekRateQualifier

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

object
daysOfWeek
required

The days of the week when this rate is available

object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
arrivalDaysOfWeekRateQualifier

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

object
daysOfWeek
required

The days of the week when this rate is available for guests to arrive on

object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
departureDaysOfWeekRateQualifier

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

object
daysOfWeek
required

The days of the week when this rate is available

object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
requiredDaysOfWeekRateQualifier

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

object
daysOfWeek
required

The days of the week the user has to stay on to get this rate

object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
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<object>
""
object
effectiveDate
required

Blackout start date.

string format: date
""
expireDate
required

Blackout end date.

string format: date
""
modifierOverride
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
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 — typically used with modifierOverride to describe the bundle as a whole.

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
Example 
{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "hotelIdentifier": "",
  "name": "",
  "enabled": true,
  "items": [
    ""
  ],
  "modifierOverride": {
    "type": "FIXED",
    "percent": "",
    "fixedAmount": ""
  },
  "type": "PREMIUM",
  "pricingType": "PER_STAY",
  "descriptions": "",
  "aggregatedItemDescriptions": [
    {
      "description": "",
      "language": "en",
      "creator": "SYSTEM",
      "md5ContentHash": ""
    }
  ]
}

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