Inventory

Get an inventory item

Get an inventory item by id

get/inventory/{inventoryId}

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/inventory/{inventoryId}
  • Auth: appAuth (a scheme the document does not define)

Path parameters

inventoryIdstring required

The unique identifier for the inventory item

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Returns the inventory item

idstring nullable
branchIdstring nullable
categorystring nullable
recordTypestring nullable
priceQualifierstring nullable
currencystring nullable
yearBuiltinteger nullable
newBuildboolean nullable
floorAreaInSquareFeetnumber double nullable
landAreaInAcresnumber double nullable
pricenumber double nullable
bedroomsinteger nullable
receptionsinteger nullable
bathroomsinteger nullable
propertySubTypeIdinteger
propertyTypestring nullable
statusstring nullable
inventoryStatus'Unspecified' | 'Appraisal' | 'Available' | 'UnderOffer' | 'Completed' | 'Let' | 'LetAgreed' | 'LetMarketing' | 'Archived' | 'Suspended' | 'Withdrawn' | 'Instructed' | 'NotInstructed' | 'ExternallyLet' | 'UnderOfferMarketing' | 'UnderOfferAvailable' | 'Exchanged' | 'ExternallySold' | 'Reserved'
archivedboolean
isAtActiveStatusboolean
tenureIdinteger
tenurestring nullable
rentalFrequencystring nullable
tenancyType'Unspecified' | 'AssuredShortholdTenancy' | 'AssuredTenancy' | 'PublicSector' | 'HousingAssociation' | 'AssuredPeriodicTenancy'
taxBandstring nullable
taxBandExemptReasonstring nullable
serviceChargestring nullable
groundRentstring nullable
localAuthoritystring nullable
leaseRemainingYearsinteger nullable
leaseTerminteger nullable
leaseEndDatestring date-time nullable
groundRentReviewPeriodnumber double nullable
groundRentPercentageIncreasenumber double nullable
sharedOwnershipboolean nullable
sharedOwnershipPercentageSharenumber double nullable
sharedOwnershipRentnumber double nullable
sharedOwnershipRentFrequencyIdinteger nullable
leaseNotesstring nullable
privateViewingNotesstring nullable
displayAddressstring nullable
hasAsbestosboolean nullable
rentalDateAvailablestring date-time nullable
groundRentFixedForTermboolean nullable
groundRentNotesstring nullable
serviceChargeNotesstring nullable
negotiatorNamestring nullable
instructionDatestring date-time nullable
managementType'Unspecified' | 'NotManaged' | 'PartManaged' | 'Managed' | 'FullyManaged' | 'RentCollectionService' | 'LetOnly'
maintenanceType'Unspecified' | 'MaintainedByLandlord' | 'MaintainedByUs'
coastalErosionboolean nullable
knownPlanningConsiderationsstring nullable
mobileCoveragestring nullable
uprnstring nullable
createdDatestring date-time nullable
modifiedDatestring date-time nullable

Example response

{
  "epc": {
    "energyEfficiencyRatingCurrent": 31,
    "energyEfficiencyRatingPotential": 37
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.