Reapit Foundations import user guide; getting your properties onto your website from Reapit

Article - 840007681

07:55, 04 June 2024

The following document explains how you can get the property data from your Reapit software onto your website. It explains exactly how an import of your property data from Reapit works and outlines what you need to do to ensure the information on your website is correct. It also contains important information to ensure your property alert emails link correctly to your website (in the FAQs section).

Contents

1.1 - Overview

1.2 - Setting up an import to your website

1.3 - What information does the website use to display my property listings?

1.4 - FAQs

1.1 Overview

The Reapit Foundations API Import is one of the fastest and most reliable methods of transferring property data to your website. Once setup, it will look for changes to your property listings every hour and immediately makes these changes to your website. In essence, you will never be waiting more than an hour for a change to appear on your website.

The service will runs 6 days a week, Monday - Saturday, 8am - 8pm. It does not run overnight when estate agent offices are closed or on Sundays when no changes are taking place.

1.2 Setting up an import to your website

If you’re having a new website built by Webdadi, your Project Manager will be in touch to setup your import. If you already have a Webdadi website and want to setup a new import from Reapit, please contact your Account Manager.

In order to prepare for your upcoming import, we recommend you do the following:

1.3 What information does the website use to display my property listings?

The following table outlines what information is used on the website, where it is output, and from where in Reapit it gets that information.

Please note - although the Reapit software itself is customisable and allows you to create new fields and have a bespoke configurations, the website import only downloads the default/core fields of Reapit.

Website option

Where does it display on the website

Field in Reapit

Website Option

House Number

Doesn't output on the website specifically. This field is imported purely to help us identify the property in our database for troubleshooting

Address.BuildingNumber + Address/BuildingName

NA

Address 1

Used to output the address on the search results & property details pages

Address.Line1

NA

Address 2

Used to output the address on the search results & property details pages

Address.Line2

NA

City

Used to output the address on the search results & property details pages

Address.Line3

NA

State

Used to output the address on the search results & property details pages

Address.Line4

NA

Postcode

Used to output the address on the search results & property details pages. Only the first part of the postcode will show

Address.PostCode

NA

Branchcode/DepartmentId

Determines what branch the property is allocated to. This should match an office setup on the website. This branches details will appear on the property details page (editable in VIA) is where any arrange a viewing email requests are sent for that property. Properties allocated to a branch not setup on the website will not display.

OfficeId
(uses first value supplied)

NA

Brochure Download

Displays the brochure on the property details page

selling.publicBrochureUrl
or
letting.publicBrochureURL

NA

Additional Features

 

 

 NA

Mark the property as For Sale by Auction (64)

Doesn't output specifically, but allows the property to be segregated in an auction search if required

Selling.Disposal
(anything marked as "Auction" will be flagged as an Auction property)

NA 

Mark the property as a New Build (1)

Doesn't output specifically, but allows the property to appear in new homes filter search if required

Age
(anything marked as "new" will be flagged as a New Build)

NA 

Commercial Usage Types
(Commercial properties have an alternative Additional Features list to residential properties)

Doesn't output specifically, but allows the commercial property to be segregated by their commercial usage types in a search if required

Commercial.UseClass

NA 

Council Tax Band

Outputs on the property details page in the left hand side section below the bullet pointed main features

CouncilTax

NA

Deposit 

Outputs on the property details page. Only relevant to Lettings properties

Letting.Deposit.Amount

NA 

Ground Rent

Outputs on the property details page. Relevant only for Leasehold or Commonhold properties. Will only display if there is a value in this field. If there is no value added, this field simply won’t display on the website.

GroundRent

NA 

Hidden?

Properties marked as hidden are not downloaded from Reapit and therefore do not appear on the website

No properties that have property.internetAdvertising = true marked in Reapit will appear on the website

NA 

hideprice

Field doesn't output on the website specifically, but when ticked it hides the price from appearing on the website

Selling.Qualifier
or
Letting.Qualifier
(The price will be hidden if "Price On application" or "Rent on application" is selected)

NA 

importtype

Determines whether the price of the property is per annum, per month or per week. Doesn't ouput on the site specifically per property as the website is set to display a default, but will use this price to convert to the correct amount according to the website default

This is determined by the Reapit Foundations App at source so this doesn’t output in VIA. Foundations = 46968111-14d1-421f-828a-6698dd268547

NA 

Instructed Date

Field doesn't output on the website specifically, but ensures the newest/oldest filter on the website searches functions correctly. It uses this date to define a property's age. If this is blank, it cannot filter properties by those values correctly

Created
or
Selling.Instructed
or
Letting.Instructed

NA 

Internal Code

Field doesn't output on the website specifically, but ensure the property can always be viewed by using the clients website URL followed by /property/propertyid eg: www.estateagent.com/property/12345

Property.id + S or L

(S for sales, L for Lettings. Reapit supports properties being marked as both Sales and Lettings. On the website,a  property record can only be one or the other, so adds a S or L to ensure a property marked as both can be processed. It effectively creates a sales and/or lettings version of the property)

NA 

Lease Expiry

Outputs on the property details page. Relevant only for Leasehold or Commonhold properties. Will only display if there is a value in this field. If there is no value added, this field simply won’t display on the website.

Selling.Tenure.Expiry

NA

 

Long Description

Field outputs as the main description on the property details page

LongDescription
(if blank, uses Description)

NA 

Low Price*

Field outputs as the price on the search results and property details page

Selling.Price
or
Letting.Rent

NA 

Main Features

Outputs as the Main Features bullet points on the property details page

Summary
(Each bullet point on the website is defined by using a Line Break (new line/pressing enter) within Reapit

NA 

Number Bathrooms

Outputs as a numeric symbol on the search results and property details page

Bathrooms

NA 

Number Bedrooms

Outputs as a numeric symbol on the search results and property details page

Bedrooms

NA 

Number Receptions

Outputs as a numeric symbol on the search results and property details page

Receptions

NA 

Organisation ID

Doesn't output on the website. An ID associating it with the specific organisation

 

NA 

Property Type

Outputs on the search results and property details page (house, flat, apartment etc)

Type
(Uses first value supplied, doesn't support multiple values.)

Reapit Option - Website Label

maisonette - Maisonette

townhouse - Town House

studio - Studio

flatApartment - Flat

land - Land

developmentPlot - Plot

farm - Farm

cottage - Cottage

house - House

bungalow - Bungalow

Service Charge

Outputs on the property details page. Relevant only for Leasehold or Commonhold properties. Will only display if there is a value in this field. If there is no value added, this field simply won’t display on the website.

ServiceCharge

NA 

Short Description

Outputs on the list view of the search results page

Strapline
(if blank, uses Description)

NA 

Status

Outputs as the status of the property (for sale, under offer etc)

Please note: As per the property portals, the website does not display exchanged or completed properties. This include properties which have an “exchanged date” marked against them. Please ensure any property you want live on the website does not have an exchanged date marked against it.

In addition, we cannot support any bespoke or customer statuses that have been added to Reapit as a bespoke option for you. We can only support the default statuses in Reapit to ensure the service works for all Reapit customers.

Selling.Status
or
Letting.Status

For Sale

Under Offer

(properties marked as Sold STC - available in Reapit will display as Under Offer on the website as the Reapit API does not differentiate between Under Offer & Sold STC. Speak to your Webdadi Account Manager if you wish to have your website display as Sold STC rather than Under Offer)

To Let

Let Agreed

As per the property portals, we do not import Exchanged or Completed properties by default.

If you require additional statuses to display on the website, please speak to your Webdadi Account Manager.

Tenure

Outputs on the property details page in the tenure section underneath the main description. 

Selling.Tenure.Type

NA 

Terms

Outputs near the price of the property (offers in excess, guide price etc).

Selling.Qualifier  

Guide

Fixed Price

Offers in the region of

Offers in excess

Offers over

Null

Vacant From

Doesn't output on the website 

Letting.Avalilable.From

 NA

Video Tour

Outputs as a video symbol on the search results and property details page. When clicked it displays the video(s)

VideoUrl
and/or
Video2Url

NA 

Webdadi Sub Type

Field doesn't output on the website specifically, but essentially markes the property as a sales or lettings property so it appears in the relevant search

If Property.selling is not null, it is marked as Sales
If Property.selling is null, it is marked as Lettings

NA 

1.4 FAQs

How do I make changes to the property listings on my website?

Simply update your property information within Reapit and those changes will automatically appear on your website within an hour (providing you have addeded/edited the information into the correct field of Reapit)

I’ve made a change to a property listing but not displaying on my website even though it has updated on the property portals?

How often does the Reapit Foundations Import run & how quickly will any changes I make in Reapit be on my website?

The service runs every hour to look for changes to your property data. When it picks up any edits, additions or deletions of properties since it last ran, these changes are then directly added to the website.

It means updates to your website will occur hourly and you shouldn’t ever wait more than an hour for a change to be reflected on your website as there is no additional processing time once the service runs.

The service runs Monday - Saturday between 8am - 8pm. It does not run on Sundays or overnight, as estate agent offices are closed so no changes will be taking place.

Why doesn’t it run more often than hourly?

Unlike other providers, Reapit don’t allow us to download your data for free.

Either they put a limit on how much data we can download or indeed simply charge you every time we download your data. It means the more frequently we ran the import, the more quickly you’d max out your data limit, or the more you’d be charged.

We have deemed the hourly import of data to be the best compromise between speed and value for the client. To download it more frequently would drastically increase the cost to you.

Can I customise my import to use different fields?

In short, no. The website uses a specific set of data from Reapit that can’t be customised. However, most of the information on the website is factual data such as the address, price, tenure etc which shouldn’t need to be customised.

You need to add the data you want to display online to the relevant fields in Reapit as listed in section 1.3.

Having a standard Import setup for all Reapit customers allows us to support and maintain your import. It also means your import is constantly updated in line with any legal requirements such as the requirement to display council tax and tenure information published in May 2022.

Why don’t you import Sold properties?

Reapit make all of your property stock available for us to download. However, Reapit are now the only provider who charge to download your property data. Downloading the sold stock (labelled as exchanged or completed in Reapit) would dramatically increase the amount of information we were downloading, and as such, it would dramatically increase your costs.

Whilst those with the Website Integration Service from Reapit get up to 600,000 API calls a year as part of their package, the chances of going over this quota would dramatically increase if we were to download sold properties.

It’s why the Reapit Foundations Import now mirrors the major property portals in only displaying active for sale/to let or under offer/sold stc properties.

If you wanted to display a sold portfolio on your website, please talk to your Webdadi Account Manager accountmanagement@webdadi.com

I’m concerned about going over my quota of API calls and/or being charged for you to download my data. What can I do to minimise my costs?

Firstly, Webdadi have done everything possible and have worked extensively with Reapit to make our tool as efficient as possible. However, there are still best practises which you and your staff can abide by to help maximise your efficiency.

Fundamentally, whenever changes are made to your properties within Reapit, we will need to update your website. The more you can group these changes so they are being carried out in one go, rather than being spread out sporadically throughout the day, the more efficient your import will be and the less likely it will be that you will exceed your quota or incur excessive costs.

I’ve heard the charges by Reapit to access our data are based on endpoints and data usage. What does this mean and what will I be charged?

Endpoints identify what type of data we need to access and the API usage is essentially how much data we download from you. As mentioned above, we have made our tool as efficient as possible to minimise the costs of accessing your data.

Do I need to do anything to ensure my property alert emails work correctly once my import is setup?

Yes. Reapit should ensure your property alert emails are set up to link to your property listings on the website correctly. They will need to generate a URL to the property online in their email templates, so you need to ensure they have the following setup correctly to ensure they work.

To link to any property on the website, simply enter your website address followed by

/property/property.id

Plus S or L if the property is a sales or lettings listing

eg: www.estateagentwebsite.com/property/CHL124509S

You can also pass on the following format to your Reapit Account Manager in relation to property alert emails: https://www.estateagentwebsite.com/property/%7bProperty.Code%7d%7bLoggedNegotiator.Config.CurrentAppMode == "L" ? "L" : "S"}

Keywords:

Reapit Foundations import, Reapit import, Reapit API import, website upload from Reapit, import, Foundations


Article ID: 840007681
Link: https://webdadi.atlassian.net/wiki/spaces/PKB/pages/840007681