v1

latestSwagger 2.02026-07-14453366.1 KB
SalesController

Get a specific sales instruction given its unique Object ID (OID)

get/v2/tier2/{shortName}/sales/salesinstructions/{salesInstructionID}

Path parameters

shortNamestring required

The unique client short-name

salesInstructionIDstring required

The unique ID of the SalesInstruction

Response

OK

Address1string

Address 1 of the property to be sold

Address2string

Address 2 of the property to be sold

Address3string

Address 3 of the property to be sold

Address4string

Address 4 of the property to be sold

AddressNumberstring

Address number of the property to be sold

Areastring

The area linked to the instruction

Bathroomsinteger

Number of bathrooms linked to the instruction

BathroomsEnsuiteinteger

How many of the bathrooms are ensuite?

Bedroomsinteger

Number of bedrooms linked to the instruction

ContractType'Pending' | 'SoleAgency' | 'SoleSellingRights' | 'JointSoleAgency' | 'MultiAgency' | 'SubAgent'

The contract type

Country'Afghanistan' | 'Albania' | 'Algeria' | 'Andorra' | 'Angola' | 'AntiguaAndBarbuda' | 'Argentina' | 'Armenia' | 'Australia' | 'Austria' | 'Azerbaijan' | 'Bahamas' | 'Bahrain' | 'Bangladesh' | 'Barbados' | 'Belarus' | 'Belgium' | 'Belize' | 'Benin' | 'Bhutan' | 'Bolivia' | 'BosniaAndHerzegovina' | 'Botswana' | 'Brazil' | 'Brunei' | 'Bulgaria' | 'BurkinaFaso' | 'Burundi' | 'Cambodia' | 'Cameroon' | 'Canada' | 'CapeVerde' | 'CentralAfricanRepublic' | 'Chad' | 'Chile' | 'China' | 'Colombia' | 'Comoros' | 'CongoBrazzaville' | 'CongoDemocraticRepublicOfThe' | 'CostaRica' | 'CoteDIvoire' | 'Croatia' | 'Cuba' | 'Cyprus' | 'CzechRepublic' | 'Denmark' | 'Djibouti' | 'Dominica' | 'DominicanRepublic' | 'EastTimorTimorTimur' | 'Ecuador' | 'Egypt' | 'ElSalvador' | 'EquatorialGuinea' | 'Eritrea' | 'Estonia' | 'Ethiopia' | 'Fiji' | 'Finland' | 'France' | 'Gabon' | 'GambiaThe' | 'Georgia' | 'Germany' | 'Ghana' | 'Greece' | 'Grenada' | 'Guatemala' | 'Guinea' | 'GuineaBissau' | 'Guyana' | 'Haiti' | 'Honduras' | 'Hungary' | 'Iceland' | 'India' | 'Indonesia' | 'Iran' | 'Iraq' | 'Ireland' | 'Israel' | 'Italy' | 'Jamaica' | 'Japan' | 'Jordan' | 'Kazakhstan' | 'Kenya' | 'Kiribati' | 'KoreaNorth' | 'KoreaSouth' | 'Kuwait' | 'Kyrgyzstan' | 'Laos' | 'Latvia' | 'Lebanon' | 'Lesotho' | 'Liberia' | 'Libya' | 'Liechtenstein' | 'Lithuania' | 'Luxembourg' | 'MacedoniaFormerYugoslavRepublicOf' | 'Madagascar' | 'Malawi' | 'Malaysia' | 'Maldives' | 'Mali' | 'Malta' | 'MarshallIslands' | 'Mauritania' | 'Mauritius' | 'Mexico' | 'MicronesiaFederatedStatesOf' | 'Moldova' | 'Monaco' | 'Mongolia' | 'Morocco' | 'Mozambique' | 'Myanmar' | 'Namibia' | 'Nauru' | 'Nepal' | 'Netherlands' | 'NewZealand' | 'Nicaragua' | 'Niger' | 'Nigeria' | 'Norway' | 'Oman' | 'Pakistan' | 'Palau' | 'Panama' | 'PapuaNewGuinea' | 'Paraguay' | 'Peru' | 'Philippines' | 'Poland' | 'Portugal' | 'Qatar' | 'Romania' | 'Russia' | 'Rwanda' | 'SaintKittsAndNevis' | 'SaintLucia' | 'SaintVincentAndTheGrenadines' | 'Samoa' | 'SanMarino' | 'SaoTomeAndPrincipe' | 'SaudiArabia' | 'Senegal' | 'SerbiaAndMontenegro' | 'Seychelles' | 'SierraLeone' | 'Singapore' | 'Slovakia' | 'Slovenia' | 'SolomonIslands' | 'Somalia' | 'SouthAfrica' | 'Spain' | 'SriLanka' | 'Sudan' | 'Suriname' | 'Swaziland' | 'Sweden' | 'Switzerland' | 'Syria' | 'Taiwan' | 'Tajikistan' | 'Tanzania' | 'Thailand' | 'Togo' | 'Tonga' | 'TrinidadAndTobago' | 'Tunisia' | 'Turkey' | 'Turkmenistan' | 'Tuvalu' | 'Uganda' | 'Ukraine' | 'UnitedArabEmirates' | 'UnitedKingdom' | 'UnitedStates' | 'Uruguay' | 'Uzbekistan' | 'Vanuatu' | 'VaticanCity' | 'Venezuela' | 'Vietnam' | 'WesternSahara' | 'Yemen' | 'Zambia' | 'Zimbabwe' | 'UnknownCountry' | 'HongKong' | 'Jersey' | 'ChannelIslands' | 'Bermuda' | 'BritishOverseasTerritory'

Address country of the property to be sold

Descriptionstring

The instruction description

DevelopmentOppboolean

Is the instruction a development opportunity?

Directionsstring

Directions linked to the instruction

EPCCurrentEERinteger

Current EER value

EPCCurrentEIinteger

Current EI value

EPCPotentialEERinteger

Potential EER value

EPCPotentialEIinteger

Potential EI value

ETagstring

A unique identifier defining the object and change revision.

HasElectricitySupplyboolean

Does the instruction have an electrical supply linked to it?

HasGasSupplyboolean

Does the instruction have an gas supply linked to it?

HasWaterMeterboolean

Does the instruction have a water meter linked to it?

InvestmentOppboolean

Is the instruction a investment opportunity?

Kitchensinteger

Number of kitchens linked to the property instruction

OIDstring

The unique Object ID (OID).

OutsideSpaceBalconyboolean

Does the instruction have an outside balcony linked to it?

OutsideSpaceCommunalGardenboolean

Does the instruction have a communal garden linked to it?

OutsideSpaceConservatoryboolean

Does the instruction have a conservatory linked to it?

OutsideSpaceGardenboolean

Does the instruction have a garden linked to it?

OutsideSpaceLargeGardenboolean

Does the instruction have a large garden linked to it?

OutsideSpacePatioboolean

Does the instruction have a patio linked to it?

OutsideSpaceRoofTerraceboolean

Does the instruction have a roof terrace linked to it?

OutsideSpaceSouthFacingGardenboolean

Does the instruction have a south facing garden?

ParkingAllocatedboolean

Is there any parking allocation linked to the instruction?

ParkingCarportboolean

Does the instruction have a carport linked to it?

ParkingDoubleGarageboolean

Does the instruction have a double garage linked to it?

ParkingGarageboolean

Does the instruction have a garage linked to it?

ParkingOffRoadboolean

Is there off road parking linked to the instruction?

ParkingOnRoadboolean

Is there on road parking linked to the instruction?

ParkingPermitboolean

Is a parking permit required?

ParkingSecureGatedboolean

Is there any secured gate parking linked to the instruction?

ParkingTripleGarageboolean

Does the instruction have a triple garage linked to it?

Postcodestring

Postcode of the property to be sold

Pricenumber double

The price of the property to be sold

PropertyOwnableType'House' | 'FlatApartment' | 'Bungalow' | 'Land' | 'HouseFlatShare' | 'GarageParking' | 'CommercialProperty' | 'Block' | 'TerracedHouse' | 'EndTerraceHouse' | 'SemiDetachedHouse' | 'DetachedHouse' | 'SemiDetachedBungalow' | 'TownHouse' | 'Cottage' | 'ServicedApartment' | 'Studio' | 'Apartment' | 'Barn' | 'FarmHouse' | 'Penthouse' | 'BuildingPlot' | 'DetachedBungalow' | 'LinkDetached' | 'MidTerracedBungalow' | 'LandResidential'

The property type

ReceptionRoomsinteger

Number of reception rooms linked to the instruction

State'MarketAppraisal' | 'LostAppraisal' | 'Instructed' | 'Advertised' | 'UnderOffer' | 'ContractsExchanged' | 'Completed' | 'FallenThrough' | 'Withdrawn'

The current instruction state

Tenure'Freehold' | 'Leasehold' | 'Commonhold' | 'ShareOfFreehold' | 'FlyingFreehold' | 'ShareTransfer' | 'Unknown'

Instruction tenure

VideoURLstring

The URL of the video linked to the Sales Instruction