Helpful information for making the most of the Merchandising API.
Pagination: The Merchandising API follows the same pagination experience as the rest of Rapid API. Find more details here.
Language: Provide the desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. Currently only used for generating links to other APIs.
Property Content API link: Partners will receive a tokenized link to the existing Rapid Property Content API in order to get property details like name, address, amenities, etc.
It is important to remember that rate plan availability and pricing change constantly on Rapid's Shopping API. Therefore, you will always see the best available rates in the Shopping API response (based on occupancy and stay date request parameters). This sometimes means you will get a better discount or lower price via the Shopping API than what you see in the Promotions API response.
We will not return member-only or mobile deals if you are not eligible to access these rate types. Please reach out to your Account Manager for further details.
Maximum and minimum discount values:
The max_discount field indicates the maximum percentage discount available within the campaign. For example, if the most discount offered by a property in that campaign is 60% off, the max_discount value in the API response would be 60%.
The min_discount field indicates the minimum percentage discount available within the campaign. For example, if the lowest discount offered by a property in that campaign is 4%, the min_discount field would be 4%.
Bookable and stay date windows:
The campaign content and promotions endpoints will deliver responses that fall fully within the requested bookable and travel windows (and end dates).
You can use bookable and bookable_end parameters as filters, using greater than and less than logic. This means if you request deals with a bookable of April 1 and a bookable_end of April 30 you will only receive deals that exactly match this criteria. If a deal has a bookable and bookable_end between April 15 and May 15, respectively, you will not receive this deal. The same logic applies for stay dates.
If you want to show travelers "XX days remaining only" for a campaign you can calculate this number using the bookable and bookable_end date from campaign content.
