Introduction

We've simplified the process for our affiliate partners to access thorough information about our listings (properties). We provide a Feed which acts as the primary source to get listing information, along with Partner API access for obtaining additional data. Below you can understand more about the options. The option you choose depends on your business objectives.

Please use both the Feed and Partner API to obtain a more accurate representation of the listing. Begin by relying on the Feed as the primary source for information which shows the eligible listings (properties) that are part of the Affiliate Program and which you're authorised to list. This Feed also includes essential static listing information. Next, utilise the Partner API to obtain the most current pricing and availability details for these listings (properties).
Please use the Feed, if your focus is primarily on using static listing data such as images, location, descriptions, minimum stay requirements, and URLs, and you don't require real-time pricing and availability updates. Nevertheless, within the Feed, you can still access essential information like the base price rate (e.g., starting from £140/night) and availability data, which indicates the percentage of days the listing (property) is available in the upcoming 180 days. Both of these data points can offer a general idea of how well a listing aligns with the offer of your website.

Feed

The purpose of the Feed is to provide our affiliate partners with updated content of our listings (properties). This is an efficient way to stay informed about new content or updates without having to visit the website directly. Feed contains all the static listing (properties) information such as imagery, location, description, minimum stay, urls etc. The data is updated daily. However, the Feed doesn’t contain real time availability and pricing data. Both of which you can get using the Partner API. Read more here.

Below you can understand what some of the terms in the sheet mean:

Price. Column BA: This column shows you the base price rate (e.g. from £140) for each listing (properties). Base rate refers to the standard or minimum nightly rate for a specific type of accommodation.
AvailableDays180Percentage. Column A: This percentage shows how many days out of the next 180 days are available for booking. However, it doesn't tell you when these available dates fall within that 180-day period. Nonetheless, it helps you identify listings (properties) that can be booked in that time frame, which can be useful for improving your conversion rate of your website.
Dated_pop_index. Column L: This field is a combination of popularity of the listings (properties), how attractive the listings (properties) is and how much availability it has. We suggest using this field to rank the listings (properties). It will help to increase conversions while eliminating bad choices and future booking cancellations.
Listingid. Column AR: unique identifier of the listings (properties).
Property_type. Column BB: This field allows you to classify the listing (property) as an apartment, villa, aparthotel, or other available options.
Min stay. Column AV: Minimum of days a guest can check in

Other resources:

Please find in this document, tab [Homes] a list of all the listings (properties) that are available and some stats about them. You can refer to this tab if you are just looking for general information.
Please find in this document tab [Sample Feed Data], a sample representation of the Feed.

FAQs:

Where can I find the Feed? There are two ways to find the Feed. In Partnerize, you can find it under the Content section and then click Feeds. Download it. You can also directly download this link: http://plumguide.com/syndication-service/hotelcatalog/csv/partnerize/gbp.csv
Is the Feed updated? Yes, the Feed is updated daily
Have the Feed excluded listings (properties) that hosts don’t want to be part of the affiliate program or generally hidden listings (properties)? Yes, it takes that into consideration.
What currencies do we support? We support USD, GBP, AUD and EUR.
Why do some listings (properties) in the Feed don’t have base prices? Some of the listings (properties) don’t have a price because they are brand new on the platform.

Partner API

The Plum Guide Partner API allows you to get pricing and availability data in real-time for each Plum Guide listing (properties). In this guide, we'll explain how the Partner API functions and provide key rules to help you access the data your business needs.

Criteria:

The API is available to all affiliates and partners for no additional cost

Endpoints:

Firstly, please review this documentation to see in detail which data you can extract through the Partner API and if those endpoints provide you with all the data you need. The main advantage of Partner API over the Feed is that the Partner API allows the 3rd party to get listing (properties) availability and pricing data to be retrieved in real-time, allowing the property to be displayed every combination of dates selected.

There is also extensive documentation here

The API to hit is: https://api.plumguide.com/partner/swagger/index.html

General Example:

When requesting data, you will receive a response similar to the following.

[
  {
    "guests": 1,
    "date": "2023-01-01T00:00:00",
    "nights": 1,
    "totalPrice": 1060,
    "currency": "GBP",
    "details": {
      "basePrice": 1000,
      "fees": 10,
      "taxes": 20,
      "totalVat": 30
    }
  },
  {
    "guests": 1,
    "date": "2023-01-01T00:00:00",
    "nights": 2,
    "totalPrice": 1160,
    "currency": "GBP",
    "details": {
      "basePrice": 1100,
      "fees": 10,
      "taxes": 20,
      "totalVat": 30
    }
  }
]

The affiliate partner has full control over what they want to consume by choosing to have access to either availability data, pricing data, or both.

Availability:

These are the dates the listing (property) is available - it is a matrix as listings (properties) have different minimum night requirements per season etc.

Get availability matrix: Retrieves the calendar data for the next year in a matrix shape. For any possible check-in day for the next year, the matrix contains information about if this day is available at all, and if it is, information about min and max nights.

Example:

{
  "availability": [
    {
      "to": "2023-01-01T00:00:00",
      "from": "2023-01-10T00:00:00",
      "minNights": 1,
      "maxNights": 10
    }
  ]
}

Interpret the example: Within the period indicated above, you have multiple combinations of checkin/checkout.

Pricing:

Get price matrix: Retrieves the price data for the next year in a matrix shape. For any possible check-in day for the next year, the matrix contains the price per Length of Stay (LOS) and guest count.

Example:

When requesting price data, you will receive a response similar to the following.

{
    "guests": 1,
    "date": "2023-01-01T00:00:00",
    "nights": 1,
    "totalPrice": 1060,
    "currency": "GBP",
    "details": {
      "basePrice": 1000,
      "fees": 10,
      "taxes": 20,
      "totalVat": 30
    }
  }

Interpret the example: If you book on the 1st of January 2023, for 1 night, it shows respective information such as price, currency and precise checkin/checkout combination.

FAQs

How long does the Partner API integration process take to be completed? The Partner API integration is a straightforward process and shouldn’t take time to be implemented.
What currencies do we support? We support USD, GBP, AUD and EURO
Are there any costs to sign up? No. There are no costs to sign up.
Can I access transactional endpoints? Affiliate partners will transfer the user to Plum Guide site to complete the booking. Therefore, access to transactional endpoints is restricted.

If you believe that getting access to the Partner API gives you the appropriate data, kindly send an email to affiliates@plumguide.com to request client credentials. In your email, please include the following information:

Full name
Position
Website URL
How will you use the Plum Guide API to serve users?

Pay Attention: Feed and Partner API

As we said above, it is mandatory to use the Feed as the primary source to get listing information. Then request authorization to get access to endpoints which gives you real time pricing and availability data.

Please use ‘listingids’, found in the Feed, column AR as a unique identifier:

to understand which are the listings (properties) you are allowed to list in your websites.
to match pricing and availability data Partner API with the respective listing (properties) from the Feed.

If you require help or technical advice please contact the onboarding team via email at: affiliates@plumguide.com