EAN Deals File

The EAN Deals file provides a regularly-updated source of properties offering discounts, free nights, or other promotions. The deals file, currently offered in Excel format via EAN Insights, provides the same content as is available via the Deals API. Deals are updated every 6 hours.

Using the Deals File with the Property Content File

As instructed on Insights, you must join the Deals Excel file and Property Content pipe-delimited text file in order to obtain static content information on each property returned by the Deals file. You must convert one of the files to a matching format in order to join the data.

To convert the Property Content file for use with Microsoft Access, follow our import tutorial for converting pipe-delimited files.

If you wish to use Microsoft Excel to convert the Property Content file for use with the Deals Excel file, follow these steps:

  1. From the Excel top menu, select File -> Import...
  2. Choose Text file from the resulting file type dialog and click Import
  3. Navigate to the download location for the Deals file, select it, and click Get Data
  4. The Text Import Wizard will appear. Leave the default options (Delimited, start import at row 1) and click Next.
  5. Under the Delimeters checkbox column, uncheck the Tab option and check the Other option.
    Type the pipe character (displayed as "|" - type Shift-\ on most machines) as the delimeter. Your data preview should appear the same as the illustration below. Click Next.
  6. Click Finish on the final screen, leaving the default options.
  7. The final dialog determines the import location for the data. If you began this process with the Deals Excel file already open, choose the New sheet option.
    Attempting to import the volume of data the Property Content file contains directly into the Deals sheet may cause Excel to hang.
  8. Wait for the import to complete. Please be patient - the Property Content file is very large and may take a few minutes for Excel to import.
  9. After the import completes, select all cells in the sheet (Command-A, Ctrl-A, or Edit -> Select All) and click Format as Table. Choose a table style of your choice if prompted.
    Before clicking OK, make sure the My table has headers box is checked.
  10. The Property Content file is now in the same Excel format as the Deals file and the sheets may be joined.

 



Deals File Content

Deals are returned as individual rows. Properties offering multiple deals will return multiple rows for the same hotel ID.

Each row contains the specific rate and room codes applicable to the deal, effective dates, any restrictions on dates or length of stay, and the hotel ID offering the deal.


Name Description
Hotel Id The ID of the specific property offering the described deal.

Example:
10092748
Promo Id Identifier for the deal. This value is the same promoId value returned by any other EAN API responses.

Example:
208634870
Description

Text description of the deal.

Example:
Book now and save

Effective Start Date The earliest day and time the deal may be booked. Provided in YYYY-MM-DD hh:mm:ss format. May be significantly backdated.

Example:
2015-12-03 00:00:00
Effective End Date The latest day and time the deal may be booked. Provided in YYYY-MM-DD hh:mm:ss format.

Example:
2017-02-01 23:59:00
Travel Start Date Indicates the start of the travel window for the deal. Strictly limits eligiblity for the deal if Partial Apply is false. Provided in YYYY-MM-DD hh:mm:ss format.

Example:
2015-12-07 00:00:00
Travel End Date Indicates the end of the travel window for the deal. Strictly limits eligiblity for the deal if Partial Apply is false. Provided in YYYY-MM-DD hh:mm:ss format.

Example:
2017-02-01 23:59:00
Type

The type of discount offered by the deal. Possible values: PERCENTAGE or ABSOLUTE

Free night(s) are indicated using a PERCENTAGE discount of 100%. The occurrence of the free night is typically defined by Night Of Stay Apply.

Example:
The values below define a free 3rd night with a minimum 3-night stay.
Since Night Of Stay Apply Recurring is true for this deal , every 3rd night of the stay will be free (3rd, 6th, 9th, etc).
Description Book now and save
Type PERCENTAGE
Value -1.0000
Advance Purchase Max 500
Advance Purchase Min 0
Number Nights Last Apply 0
Number Nights First Apply 0
Night Of Stay Apply 3
Night Of Stay Apply Recurring true
Partial Apply true
Stay Max Duration Days 28
Stay Min Duration Days 3
Value The rate-modifying value of the deal. If Type is PERCENTAGE, this value provides the discount in decimal format. For ABSOLUTE, this value provides the actual amount of the discount in the hotel's currency.

Examples:
Description Sale! Save -10% on this Stay.
Type PERCENTAGE
Value -0.1000

Description Save $20 on this stay.
Type ABSOLUTE
Value -20.0000

Rate Type

Populated to indicate the rate type eligible for the deal. If your CID is configured for multiple rate types, this value indicates if a deal is eligible for only one rate type. A blank value indicates the deal has no rate type restrictions.

If your CID is configured for a single rate type, this column will be always blank.

Points Of Sale

Populated if the deal is restricted to specific points of sale. Provided as a space-delimited list of two-letter country codes eligible for the deal.

If a Points Of Sale value is provided for a given deal, you must market the deal only for points of sale in the country codes listed. POS-restricted deals cannot be applied outside of their designated points of sale.


Example:
Points Of Sale NO SE RU CH DK CA
Site Type

If your CID is configured for mobile, this column will include a value of Mobile for deals only eligible for mobile users. If your CID is not configured for mobile promotions, this column will be blank.

Sort Order The default sort order position of the hotel if it were returned within a hotel list request.
Advance Purchase Min Booking must not be made less than this many days in advance for the deal to apply. Default restriction is 0 days if not specified for the deal.
Advance Purchase Max Booking must not be made more than this many days in advance for the deal to apply. Default restriction is 500 days if not specified for the deal.
Promo Applies

If populated, the deal only applies on the specified days of the week. The English names of applicable days are provided as a space-delimited list.

Example:

Promo Applies FRIDAY SATURDAY SUNDAY
Stay Start Restriction

Populated if the deal applies only when the reservation starts on certain days of the week. The English names of applicable days are provided as a space-delimited list.

Example:

Stay Start Restriction MONDAY TUESDAY

 

Stay End Restriction

Returns if the deal applies only when the reservation ends on certain days of the week. The English names of applicable days are provided as a space-delimited list.

Example:

Stay End Restriction THURSDAY

 

Stay Include Each Of

Populated if the deal applies only when the reservation covers all of the specified days of the week any time during the stay. The English names of applicable days are provided as a space-delimited list.

Example:

This deal applies only if the stay includes a Sunday.

Description Stay 3 nights and save
Type PERCENTAGE
Value -0.1500
Stay Include Each Of SUNDAY
Stay Include One Of

Populated if the deal applies only when the reservation covers at least one of the specified days of the week any time during the stay. The English names of applicable days are returned as a space-delimited list.

Example:

This deal applies to a stay including any day of the week except Saturday.

Description Sale!
Type PERCENTAGE
Value -0.1000
Stay Include One Of MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SUNDAY
Number Nights Last Apply Deal applies only to the final n nights of the stay. E.g. a value of 2 means the deal only applies to the last two nights of the stay.
Number Nights First Apply Deal applies only to the first n nights of the stay. E.g. a value of 3 means the deal only applies to the first three nights of the stay.
Night Of Stay Apply Deal applies only to a specific night number in the stay. E.g. a value of 4 means the deal only applies to the fourth night of the stay.
Night Of Stay Apply Recurring If true, indicates the value for Night Of Stay Apply is a repeating restriction. E.g. if Night Of Stay Apply is 3 and this value returns true, the deal applies every third night of the stay.
Partial Apply

If true or blank, any nights which fall within the date range defined by Travel Start Date and Travel End Date will be eligible for the deal rate.

If false, the stay must fall entirely within the date range defined by Travel Start Date and Travel End Date for the deal to apply.

Example:

A deal entry has travel start and end dates of January 15th-20th:

Type PERCENTAGE
Value -0.0500
Travel Start Date 2016-01-15 00:00:00
Travel End Date 2016-01-20 00:00:00

A customer wants to book a stay between January 10th and the 20th.

If Partial Apply is true or blank for this deal, the customer would receive the 5% discount for their nights between the 15th and the 20th.

If Partial Apply is false for this deal, the customer would not receive the discount for any nights because their stay begins before the promo's defined Travel Start Date of the 15th.

Partial Excluded Dates

If false, the deal will not apply at all if one or more nights in the stay fall within the excluded range.

If true, dates outside of any excluded ranges overlapping the stay will still be eligible for the deal rate.

Example:

This deal blacks out any dates of stay between January 1st and February 28th.

        "Type": "PERCENTAGE",
"Value": "-0.0500",
"excludedDates": [
{
"startDate": "2016-01-01 00:00:00",
"endDate": "2016-02-28 00:00:00"
}

A customer wants to book a stay between February 26th and March 3rd.

If partialExcludedDates returned true for this deal, they would receive the 5% discount for their nights between February 28th and March 3rd.

If partialExcludedDates returned false for this deal, they would not receive the discount for any nights because their stay falls partially within the excluded date range.

Stay Min Duration Days Deal applies only if the length of stay is this number of days or greater.
Stay Max Duration Days Deal applies only if the length of stay is this number of days or fewer.
excludedDates

Specifies any date range(s) where the deal will not apply. Contains objects with pairs of startDate and endDate.

Omitted from the response if null.

excludedDates.startDate Specifies the beginning of the date range excluded from the deal. Provided in YYYY-MM-DD hh:mm:ss format.
excludedDates.endDate Specifies the end of the date range excluded from the deal. Provided in YYYY-MM-DD hh:mm:ss format.


Example Use Cases

Here are some examples of how you can create campaigns based on the deals file data.

Create savings-based campaigns

Use the Type and Value columns to merchandise hotels based on a savings range or limit.

Example:

Create a campaign for 50% or greater savings by searching the list for rows containing your desired Hotel Ids where Type = PERCENTAGE and Value ≤ -0.500

Create seasonal campaigns for specific destinations

Search for Hotel IDs in a specific destination where. For example, many hotels restrict promotions for travel after November 1st. Search for these campaigns by looking for Travel Start Date values that begin within a few weeks of major travel seasons in your marketing areas.

Promote last-minute deals or offers expiring soon

Since the deals file updates on a 6 hour cycle, you can offer a rolling list of deals ending in the next few days, or flash deals available only for short periods of time. Highlight last-minute deals based on customer destination searches or based on the customer's geographic information (IP-based location, phone GPS, etc).

There are several methods to search for the best limited-time deals within your hotel ID groups:

  • Search for Effective Start Date and Effective End Date values with less than 24, 48, or 72 hours between them.
  • Use the Description column to find commonly used short-term sale phrases such as "Tonight only" or "Limited time offer"
  • Find different levels of discounts by isolating ABSOLUTE or PERCENTAGE deal types and then searching the Value column for the largest negative values.

Plan future campaigns based on future deals

The deals file contains many promotions with start dates several weeks or months in the future. Locate these deals by searching the Effective Start Date column for date values greater than today's date, dates after Labor Day, dates just before future bank or national holidays, etc. You can also plan future "ending soon" campaigns based around the Effective End Date.

Depending on your market, you can plan your campaigns deep into the future - many hotels register promotions over a year ahead of time.

Monitor destinations for new deals

Get the jump on promoting the latest deals from well-converting properties by checking your preferred Hotel ID groups against the deals file every time it is updated. Noting new row counts for each Hotel ID is a quick way to identify newly-added deals.