Inventory

Filter inventory items

Get a paginated list of filtered inventory items, which can contain properties for lettings, sales, or both depending on the query parameters used.

get/inventory/filter

Request

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

Query parameters

categoryType'Unspecified' | 'Residential' | 'Commercial'

The category type to filter inventory items.

[Note] If you use a value of "Unspecified" this field will be ignored.

recordType'Unspecified' | 'Sale' | 'Rent'

The record type to filter inventory items.

[Note] If you use a value of "Unspecified" or omit this field then both lettings and sales properties will be returned, unless you specify values for management type and / or maintenance type in which case only lettings properties will be returned.

managementType'Unspecified' | 'NotManaged' | 'PartManaged' | 'Managed' | 'FullyManaged' | 'RentCollectionService' | 'LetOnly'

The rental management type to filter inventory items.

[Note] If you use a record type value of "Sale" this field will be ignored.

maintenance-type'Unspecified' | 'MaintainedByLandlord' | 'MaintainedByUs'

The rental maintenance type to filter inventory items.

[Note] If you use a record type value of "Sale" this field will be ignored.

archivedboolean

The archived status to filter inventory items.

inventory-status'Unspecified' | 'Appraisal' | 'Available' | 'UnderOffer' | 'Completed' | 'Let' | 'LetAgreed' | 'LetMarketing' | 'Archived' | 'Suspended' | 'Withdrawn' | 'Instructed' | 'NotInstructed' | 'ExternallyLet' | 'UnderOfferMarketing' | 'UnderOfferAvailable' | 'Exchanged' | 'ExternallySold' | 'Reserved'

The status to filter inventory items.

[Note] If you use a value of "Unspecified" this field will be ignored.

instruction-date-fromstring date-time

The start date for filtering inventory items by instruction date.

instruction-date-tostring date-time

The end date for filtering inventory items by instruction date.

owner-idinteger

The ID of the property owner to filter inventory items.

sort-order'Asc' | 'Desc'

The order of results by inventory id.

next-tokenstring

The token for the next page of results.

max-resultsinteger

The maximum number of results to return. The maximum number of results to return. The default value is 50, and the maximum value is 250.

branchIdsstring[]

The list of branch unique identifiers for filtering inventory items.

created-fromstring date-time

The start date for filtering inventory items by created date.

created-tostring date-time

The end date for filtering inventory items by created date.

modified-fromstring date-time

The start date for filtering inventory items by modified date.

modified-tostring date-time

The end date for filtering inventory items by modified date.

Headers

AgencyRefstring required

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

Response

Returns the paginated list of filtered inventory items

Changes

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