Skip to main content

DiscountDto

idinteger<int64>

Discount id in Holidu system

providerDiscountIdstring

Provider's own external discount ID for reconciliation

statusstringrequired

Discount Status

Possible values: [ACTIVE, INACTIVE, DELETED]

Example: ACTIVE
namestring

Name of the discount

Example: Pre Season Discount
discountTypestringrequired

Type of discount

Possible values: [EARLY_BIRD, LAST_MINUTE, LONG_STAY, DEVICE_SPECIFIC, NEW_LISTING, LOYALTY, OFFER, PROVIDER_IMPLICIT]

Example: EARLY_BIRD
discountPercentnumber

Percentage of discount. Required for every type except PROVIDER_IMPLICIT

Possible values: >= 0 and <= 100

Example: 12
conditions object
daysBeforeCheckIninteger<int32>

Number of days before checkin the booking has to be made

Example: 60
minStayinteger<int32>

Minimum Stay (days) if required to get the discount

Example: 5
bookingSeason object[]

Booking date must be in seasons for the discount to apply

  • Array [
  • onlyApplicableFromstring<date>

    Only applicable from date

    Example: 2020-08-01
    onlyApplicableUntilstring<date>

    Only applicable until date

    Example: 2021-04-30
  • ]
  • travelSeason object[]

    Stay must be within seasons for the discount to apply

  • Array [
  • onlyApplicableFromstring<date>

    Only applicable from date

    Example: 2020-08-01
    onlyApplicableUntilstring<date>

    Only applicable until date

    Example: 2021-04-30
  • ]
  • deviceTypestring

    If the discount is applicable only for specific device.

    Possible values: [MOBILE, DESKTOP]

    userTypestring

    If discount is applicable based on user type.

    Possible values: [USER_AUTHENTICATED]

    implicitDiscounts object[]

    PROVIDER_IMPLICIT only: per-rate grids of absolute discount amounts

  • Array [
  • rateIdstring

    Rate this grid belongs to

    Example: NON_REFUNDABLE
    discountGrid object

    Discount rows keyed by check-in date; one entry per guest count, like the LOS grid

    <key> object[]

    Discount rows keyed by check-in date; one entry per guest count, like the LOS grid

  • Array [
  • guestsinteger<int32>

    Number of guests these amounts apply to

    Example: 2
    currencystring

    Currency of the amounts, matches the LOS price currency

    Example: EUR
    amountnumber[]

    Absolute discount per length of stay, parallel to the LOS price vector

    Example: [0,20,30]
  • ]
  • ]
  • DiscountDto
    {
    "id": 0,
    "providerDiscountId": "string",
    "status": "ACTIVE",
    "name": "Pre Season Discount",
    "discountType": "EARLY_BIRD",
    "discountPercent": 12,
    "conditions": {
    "daysBeforeCheckIn": 60,
    "minStay": 5,
    "bookingSeason": [
    {
    "onlyApplicableFrom": "2020-08-01",
    "onlyApplicableUntil": "2021-04-30"
    }
    ],
    "travelSeason": [
    {
    "onlyApplicableFrom": "2020-08-01",
    "onlyApplicableUntil": "2021-04-30"
    }
    ],
    "deviceType": "MOBILE",
    "userType": "USER_AUTHENTICATED"
    },
    "implicitDiscounts": [
    {
    "rateId": "NON_REFUNDABLE",
    "discountGrid": {}
    }
    ]
    }