Listing Service — Test Panel

Property Categories

GET /api/v1/listing/property/categories

Public endpoint — no auth required. Static dropdown data for the create-property form.

Listing Options

GET /api/v1/listing/options

Currencies, property categories/types, booking types, network types, apartment types — for populating the Overview form below.

Get Overview

GET /api/v1/listing/overview/{property_id}

Uses the Property ID field in the header.

Create / Update Overview

POST/PUT /api/v1/listing/overview[/{property_id}]

Edit the JSON body then choose Create (ignores Property ID, makes a new property) or Update (uses Property ID from the header). See generalDetails.PropertyTitle / propertyCategory — both required.

Request body (JSON)

{
  "generalDetails": {
    "PropertyTitle": "Riverside Tower",
    "supplierPropertyTitle": "Riverside Tower (Supplier)",
    "propertyCategory": "serviced_apartments",
    "isBuilding": true,
    "channelManager": "",
    "isRestAssured": false,
    "receiveLiveBookingsOrEnquiries": "enquiries",
    "currency": "GBP",
    "minimumStay": 1,
    "buildingFloors": 10,
    "units": 1
  },
  "networkType": "0",
  "supplierEmail": "supplier@example.com",
  "apartmentsInBuilding": [
    {
      "apartmentTitle": "Unit 101",
      "supplierApartmentTitle": "Unit 101",
      "apartmentType": "studio",
      "people": 2,
      "area": 350,
      "areaUnit": "sqft",
      "apartments": 1,
      "rates": {
        "1_3_nights": 100,
        "4_7_nights": 90,
        "8_27_nights": 80,
        "28_89_nights": 70,
        "90_plus_nights": 60
      }
    }
  ],
  "promotions": {
    "onSale": false,
    "discount": 0,
    "isPromotionalCommission": false,
    "promoDiscount": 0
  },
  "seasonalRates": []
}

Get Location

GET /api/v1/listing/location/{property_id}

Update Location

POST/PUT /api/v1/listing/location/{property_id}

city, address, postcode, latitude, longitude are required. primary_suburb is required when city is london.

City ID

Country ID

Address

Postcode

Primary Suburb ID

Latitude

Longitude

Suburbs (comma-separated IDs)

Child Suburbs (comma-separated IDs)

Tube Station

Public Transport

Inside M25

Map location confirmed

Location Options

GET /api/v1/listing/location-options

Suburb Lookups

GET /cities/{city_id}/suburbs · /country · /suburbs/child-suburbs

City ID

Suburb IDs (comma-separated)

Policy Options

GET /api/v1/listing/cancellation-policy/options

Get Policy

GET /api/v1/listing/cancellation-policy/{property_id}

Update Policy

POST/PUT /api/v1/listing/cancellation-policy/{property_id}

Cancel Policy

Custom Policy Text (required if "customize")

Step 7 — EPC Selection

GET /api/v1/listing/ecograde-step7/{property_id}

Only available for buildings with a postcode set. Returns available_epcs (lmk_key per certificate) fetched from the government EPC API.

Step 7 — Assign EPCs

POST/PUT /api/v1/listing/ecograde-step7/{property_id}

apartments_epc_mapping: dict of apartment ID (string) → list of EPC lmk_key strings.

Request body (JSON)

Step 8 — Green Supplier

GET /api/v1/listing/ecograde-step8/{property_id}

Requires Step 7 completed first (apartments must already have EPCs assigned).

Step 8 — Mark Green Supplier

POST/PUT /api/v1/listing/ecograde-step8/{property_id}

green_supplier_mapping: dict of EPC lmk_key (string) → boolean.

Request body (JSON)

Description Options

GET /api/v1/listing/description/options

Get Description

GET /api/v1/listing/description/{property_id}

Update Description

POST/PUT /api/v1/listing/description/{property_id}

Values for checkin_process/checkout_process/transp_unit come from the Options card above. Any transp_* field set to "Other" requires its matching transp_*_other field (min 3 chars).

Request body (JSON)

Amenities Options

GET /api/v1/listing/amenities/options

Returns valid amenity ID strings (for the amenities list below) plus dropdown-amenity definitions.

Get Amenities

GET /api/v1/listing/amenities/{property_id}

Update Amenities

POST/PUT /api/v1/listing/amenities/{property_id}

amenities is a flat list of amenity ID strings (not a dict). fees.currency is required.

Request body (JSON)

Get Photos

GET /api/v1/listing/photos/{property_id}

Update Photos Metadata

POST/PUT /api/v1/listing/photos/{property_id}

Requires at least 7 uploaded images and a main image selected before it will save.

Main Image ID

Video File Key (from Upload Video)

Image Order (comma-separated image IDs)

Accept media terms and conditions

Upload Image(s)

POST /api/v1/listing/photos/{property_id}/upload

Accepts one or more files in a single request (repeated file parts). Select multiple files below — this exercises the multi-file upload directly, bypassing Swagger UI's single-file-only "Try it out" limitation.

Image file(s)

Upload Video

POST /api/v1/listing/photos/{property_id}/upload-video

Single video file. Returned video_file_key feeds into the "Update Photos Metadata" card above.

Video file

Delete Image

DELETE /api/v1/listing/photos/{property_id}/image/{image_id}

Image ID