Stock feed & API specification
Send us your homes for sale by XML or CSV feed, or push them directly
through our listings API. One row (or <listing> element) per home.
The rules that keep your stock safe
- We match every home on your own reference (
ref) — never on price or model. Your ref must be unique across your account and stable over time.
- A home that disappears from your feed is ended after a grace period, never immediately, and never if a fetch is empty or fails. A server error on your side will not wipe your stock.
- Invalid rows are quarantined with a plain-English reason (e.g. "row 14: price is empty"); the valid rows still import.
- Your first run is a dry run you approve before anything goes live.
- Feed-managed fields are read-only in the portal.
Fields
| Field | Required | Notes |
ref | Yes | Your unique reference. The match key. |
park | Yes | The park slug for one of your parks. |
price | Yes | Numeric, GBP. £ and commas are tolerated. |
manufacturer | No | Omar, Tingdene, Willerby… |
model | No | e.g. Heritage |
bedrooms, bathrooms | No | Whole numbers |
length_ft, width_ft | No | Whole numbers (feet) |
year_built | No | Year |
condition | No | new or pre_owned (default pre-owned) |
status | No | live, under_offer, sold, withdrawn (default live) |
description | No | Plain text |
photos | No | Pipe-separated URLs in feeds; a JSON array in the API. First is the card image. |
XML example
<listings>
<listing>
<ref>OMR-HERITAGE-014</ref>
<park>meadow-view</park>
<manufacturer>Omar</manufacturer>
<model>Heritage</model>
<price>189950</price>
<bedrooms>2</bedrooms>
<bathrooms>1</bathrooms>
<condition>new</condition>
<status>live</status>
<photos>https://cdn.example/1.jpg|https://cdn.example/2.jpg</photos>
</listing>
</listings>
CSV example
ref,park,manufacturer,model,price,bedrooms,bathrooms,condition,status,photos
OMR-HERITAGE-014,meadow-view,Omar,Heritage,189950,2,1,new,live,https://cdn.example/1.jpg|https://cdn.example/2.jpg
API
Authenticate with your API key in the X-Api-Key header (HTTPS only).
GET /Pages/MPHUK/api/Listings.aspx list your homes
GET /Pages/MPHUK/api/Listings.aspx?ref=ABC one home
POST /Pages/MPHUK/api/Listings.aspx upsert (create or update) by ref — idempotent
DELETE /Pages/MPHUK/api/Listings.aspx?ref=ABC end (withdraw) a home
The API uses the same validation vocabulary as the feed, so an error you'd see as
"row 14: price is empty" comes back as {"error":"price is empty"}.