Deals and Offers

We’re excited to announce the implementation of new ‘Deals and Offers’ content that will be available across all ATDW categories from December 2019 onwards. Please see below more details regarding the deals.


For more information, please do not hesitate to contact us


Features:

  • The Search API results can be filtered by listings having deals (or) filter based on the deal types
  • The Get Product API will return the full details of the deal(s) associated with each listing (Deals are applicable to the product and not the service)
  • The deals are optional, so not all listings will return deals in the API response.
  • A listing can contain a maximum of 3 deals.
  • A deal has an in-market period of up to 3 months.
  • The deal(s) will be removed from the API response once the in market end date is reached (See "Deal End Date" in the table below for more details).
  • The deal tags provide options to filter listings based on the deal tags.


Example Implementation:

See the below State Tourism Organisation Websites for example of possible ways to implement and display the Deals & Offers content on your website.


Content Standards:

Field Field Definition Field Format Field Limit Mandatory (Yes/No)
Deal Flag Indicates if the deals & offers exists for the listing Boolean (true or false) n/a n/a
Deal ID Unique reference of the deal ID n/a Yes, if deal exists
Deal Type Type of the deal being offered Attribute ID 10 characters Yes, if deal exists
Deal Name The name of the deal or offer Alphanumeric 55 characters max Yes, if deal exists
Deal Description A broader description of the deal or offer Alphanumeric 350 characters max Yes, if deal exists
Deal Terms Terms and conditions of the deal Alphanumeric 200 characters max Yes, if deal exists
Deal Price The advertised price for the Deal Numeric 8 characters max Yes, if deal exists. One of either Price or Price Comment is mandatory
Deal Price Comment A Price comment where an individual price is not relevant Alphanumeric 150 characters max Yes, if deal exists. Either Price or Price Comment is mandatory
Deal Start Date The advertising In Market period Start date of the deal Date n/a Yes, if deal exists
Deal End Date The advertising In Market period End date of the deal Date Maximum of 3 Months after the start date Yes, if deal exists
Deal Redeem Start Date The Redemption period Start date of the Deal Date n/a No
Deal Redeem End Date The Redemption period End date of the Deal Date n/a No
Deal URL Website URL for the deal Valid URL n/a No
Deal Inclusions A list of inclusions that are offered with the deal. Alphanumeric 200 characters max No
Deal Tags Pre-defined set of tags for the deal Valid pre-defined attribute(s) n/a No
List of available 'Deal Types' (Attribute):
  • Discount
  • Special Rate
  • Bonus Offer
  • Package
Note:
  • ‘Deal flag’ is a separate field to indicate whether the ‘Deals & offers’ exists for the given listing.
  • The above fields will be returned in the product detail API response only and not applicable to the search API and service API response.

List of available 'Deal Tags' (Attribute):
  • Featured
  • Campaign
  • Do Not Display
Note:
  • Deals Tags are attributes that are applied by the individual State Tourism Organisation (STO) to define those deals/operators that have entered a specific marketing package or campaign with the STO.
  • Similarly, the "Do Not Display" deal tag is also for the purpose of STO filtering. These Tags may not be of relevance to the non-STO distribution network.


Examples:
Instructions to use Example API calls:

  • Please replace “[KEY]” in the example API calls with your actual distributor API key to view the results.
  • Please replace “[PRODUCT_ID]” in the example API call with the required product id. The product id can be obtained from the Search API response.
  • The domain (atdw-online.com.au) refers to Production and the changes will be available after the deployment on 3rd December 2019. If you like to test them prior, please contact us and we will create test credentials for you in our staging environment and share it with you.
Example Search API call to filter the results based on whether the deals exists or not:
API Request https://atlas.atdw-online.com.au/api/atlas/products?key=[KEY]&st=QLD&additionalQuery=hasDeals:true
Definition &additionalQuery=hasDeals:true - Filter results by products having deals & offers
&additionalQuery=hasDeals:false - Filter results by products that does not have the deals & offers
Additional Info The Search API response will not return the details of the deal. To view the details of the deal for the given product, please use the product detail API call by specifying the product ID obtained from the search API response.
Example Search API call to filter the results based on the deal types:
API Request https://atlas.atdw-online.com.au/api/atlas/products?key=[KEY]&st=QLD&att=DEALTYPESBONUSOFFER
Definition Find all products within Queensland having a specific deal type - 'Bonus Offer'
Additional Info
  • You can filter the results by multiple attribtues using a comma separated list (to apply AND condition in the search) or a pipe separated list (to apply an OR condition in th search)
    • Example request payload:
      • &att=DEALTYPESBONUSOFFER,DEALTYPESDISCOUNT,DEALTYPESSPECIALRATE
        • Find all listings containing the deal types - Bonus Offer and Discount and Special Rate
        • Note: A product must have all the given deal types to be considered as a match and returned in the search results
      • &att=DEALTYPESBONUSOFFER|DEALTYPESDISCOUNT|DEALTYPESSPECIALRATE
        • Find all listings containing either one of the deal types - Bonus Offer or Discount or Special Rate
        • Note: A product must have either one of the given deal types to be considered as a match and returned in the search results
  • To view the list of available attributes for deal type, please click here
Example Search API call to filter the results based on the deal tags:
API Request https://atlas.atdw-online.com.au/api/atlas/products?key=[KEY]&st=QLD&att=DEALTAGSCAMPAIGN
Definition Find all products within Queensland having a specific deal tag - 'Campaign'
Additional Info
  • You can filter the results by multiple attribtues using a comma separated list (to apply AND condition in the search) or a pipe separated list (to apply an OR condition in th search)
    • Example request payload:
      • &att=DEALTAGSCAMPAIGN,DEALTAGSFEATURED
        • Find all listings containing the deal tags - Campaign and Featured
        • Note: A product must have all the given deal tags to be considered as a match and returned in the search results
      • &att=DEALTAGSCAMPAIGN|DEALTAGSFEATURED|DEALTAGSDONOTDISPLAY
        • Find all listings containing either one of the deal tags - Campaign or Featured or Do Not Display
        • Note: A product must have either one of the given deal tags to be considered as a match and returned in the search results
  • To view the list of available attributes for deal tags, please click here
Example Get Product API call:
API Request https://atlas.atdw-online.com.au/api/atlas/product?key=[KEY]&productid=[PRODUCT_ID]
Definition Retrieve detailed information for the specified product
Sample Get Product API response payload showing the deals:

XML Output:

Deals XML Response

JSON Output:

Deals JSON Response

Static API call:

Attributes for Deal Types:

API Request https://atlas.atdw-online.com.au/api/atlas/attributes?key=[KEY]&types=DEALTYPES
Definition Retrieve all attributes that belong to the attribute type - "DEAL TYPES"
Sample attributes response payload showing the deals types:

XML Output:

Deal Types XML Response

JSON Output:

Deal Types JSON Response



Attributes for Deal Tags:
API Request https://atlas.atdw-online.com.au/api/atlas/attributes?key=[KEY]&types=DEALTAGS
Definition Retrieve all attributes that belong to the attribute type - "DEAL TAGS"
Sample attributes response payload showing the deals tags:

XML Output:

Deal Tags XML Response

JSON Output:

Deal Tags JSON Response