Create a promotion bundle

POST

/api/managing-entity/{managingEntityIdentifier}/extranet/promotion-bundle

const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/promotion-bundle';
const options = {
  method: 'POST',
  headers: {
    'Wink-Version': '2.0',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"name":"","enabled":true,"itemIdentifiers":[""],"modifierOverride":"","type":"PREMIUM","pricingType":"PER_STAY","descriptions":""}'
};

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

curl --request POST \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/promotion-bundle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "name": "", "enabled": true, "itemIdentifiers": [ "" ], "modifierOverride": "", "type": "PREMIUM", "pricingType": "PER_STAY", "descriptions": "" }'

Create a new bundle of promotions. Returns HTTP 201 with the created bundle.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string format: uuid

The unique identifier of the managing entity (property) to create the bundle for.

Example

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

name

required

Display name for this bundle of promotions.

string

"" >= 1 characters

Example

Early Bird - Long Term

enabled

required

Enable or disable the bundle without deleting it.

boolean

default: true

Example

true

itemIdentifiers

required

Array<string>

>= 2 items <= 2147483647 items

modifierOverride

Optional: override the individual promotions’ discount/premium with a single value for the bundle.

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

Example

0.25

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

type

Required only if overriding the combined discount with a single value.

string

Allowed values: PREMIUM DISCOUNT

Example

DISCOUNT

pricingType

Required only if overriding the combined discount with a single value. Determines how it is applied: per night, per stay, or per guest.

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: custom localized descriptions for this bundle. If provided, these replace the aggregated descriptions from individual promotions.

Array<object>

object

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

Responses

201

Created

application/json

object

Document UUID

string format: uuid

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

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 details (obtained via geonames) to restrict the promotion by guest location.

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

Promo code that guests must enter to access this promotion.

string

"" >= 1 characters

ipRangeRateQualifiers

Restrict promotion to specific IP ranges.

Array<object>

object

startIPRange

required

Starting IP address of the range (inclusive).

string

"" >= 1 characters

endIPRange

required

Ending IP address of the range (inclusive).

string

"" >= 1 characters

roomRangeRateQualifier

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

object

minRooms

required

Minimum number of rooms in the booking for this promotion to apply.

integer format: int32

"" >= 1

maxRooms

Maximum number of rooms in the booking. Leave null or 0 for no upper limit.

integer format: int32

prepayRateQualifier

Restrict promotion to either prepaid / non-prepaid rates.

object

prepay

required

True to apply only to prepaid rates, false to apply only to pay-at-property rates.

boolean

refundableRateQualifier

Restrict promotion to either refundable / non-refundable rates.

object

refundable

required

True to apply only to refundable rates, false to apply only to non-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

required

Number of seconds before the arrival date when the promotion becomes active (last-minute bookings).

integer format: int64

lengthOfStayRateQualifier

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

object

minLOS

Minimum number of nights for promotion to apply. Set to 0 for no minimum.

integer format: int32

maxLOS

Maximum number of nights. Set to 0 for no maximum.

integer format: int32

advanceBookingRateQualifier

Restrict promotion to users who want to book in advance.

object

minAdvanceBookingOffset

Minimum days in advance of stay start date when the booking must be made. Set to 0 for no minimum.

integer format: int32

maxAdvanceBookingOffset

Maximum days in advance of stay start date when the booking may be made. Set to 0 for no maximum.

integer format: int32

stayDateRateQualifiers

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

Array<object>

object

effectiveDate

required

Promotion applies when guest’s stay starts on or after this date (inclusive).

string format: date

expireDate

required

Promotion applies when guest’s stay starts on or before this date (inclusive).

string format: date

sellDateRateQualifiers

Restrict promotion to specific dates the booking is made.

Array<object>

object

effectiveDate

required

Promotion is available when the booking is made on or after this date (inclusive).

string format: date

expireDate

required

Promotion is available when the booking is made on or before this date (inclusive).

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

Start date when the promotion is not available (inclusive).

string format: date

expireDate

required

End date when the promotion is not available (inclusive).

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

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

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

{}

Create a promotion bundle

Authorizations

Parameters

Path Parameters

Example

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Responses

201

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated