Alto.Inventory.Api.Models.Responses.Search.InventorySearchResults

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/alto-vebra/json-schema/alto-vebra-alto-inventory-api-models-responses-search-inventory-search-results-schema.json",
  "title": "Alto.Inventory.Api.Models.Responses.Search.InventorySearchResults",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/alto-vebra-inventory-api-openapi.yml#/components/schemas/Alto.Inventory.Api.Models.Responses.Search.InventorySearchResults",
  "type": "object",
  "properties": {
    "meta": {
      "allOf": [
        {
          "$ref": "#/$defs/Alto.Inventory.Api.Models.Responses.Search.Meta"
        }
      ]
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/Alto.Inventory.Api.Models.Responses.Search.InventoryItem"
      }
    }
  },
  "additionalProperties": false,
  "$defs": {
    "Alto.Inventory.Api.Enums.MaintenanceType": {
      "enum": [
        "Unspecified",
        "MaintainedByLandlord",
        "MaintainedByUs"
      ],
      "type": "string"
    },
    "Alto.Inventory.Api.Enums.PropertyCategoryType": {
      "enum": [
        "Unspecified",
        "Residential",
        "Commercial"
      ],
      "type": "string"
    },
    "Alto.Inventory.Api.Enums.PropertyRecordType": {
      "enum": [
        "Unspecified",
        "Sale",
        "Rent"
      ],
      "type": "string"
    },
    "Alto.Inventory.Api.Enums.RentalManagementType": {
      "enum": [
        "Unspecified",
        "NotManaged",
        "PartManaged",
        "Managed",
        "FullyManaged",
        "RentCollectionService",
        "LetOnly"
      ],
      "type": "string"
    },
    "Alto.Inventory.Api.Models.Responses.Address": {
      "type": "object",
      "properties": {
        "subDwelling": {
          "type": [
            "string",
            "null"
          ]
        },
        "nameNo": {
          "type": [
            "string",
            "null"
          ]
        },
        "street": {
          "type": [
            "string",
            "null"
          ]
        },
        "locality": {
          "type": [
            "string",
            "null"
          ]
        },
        "town": {
          "type": [
            "string",
            "null"
          ]
        },
        "county": {
          "type": [
            "string",
            "null"
          ]
        },
        "postcode": {
          "type": [
            "string",
            "null"
          ]
        },
        "countryCode": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "Alto.Inventory.Api.Models.Responses.Search.InventoryItem": {
      "type": "object",
      "properties": {
        "inventoryId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID of the inventory record."
        },
        "branchId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID of the branch."
        },
        "createdAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date and time the inventory record was created.",
          "format": "date-time"
        },
        "modifiedAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date and time the inventory record was last modified.",
          "format": "date-time"
        },
        "categoryType": {
          "allOf": [
            {
              "$ref": "#/$defs/Alto.Inventory.Api.Enums.PropertyCategoryType"
            }
          ],
          "description": "The category type of the inventory record."
        },
        "recordType": {
          "allOf": [
            {
              "$ref": "#/$defs/Alto.Inventory.Api.Enums.PropertyRecordType"
            }
          ],
          "description": "The record type of the property in inventory."
        },
        "archived": {
          "type": "boolean",
          "description": "boolean value indicating whether inventory record has been archived"
        },
        "status": {
          "allOf": [
            {
              "$ref": "#/$defs/Alto.Services.SDK.InventoryStatus"
            }
          ],
          "description": "The status type of the inventory record."
        },
        "address": {
          "allOf": [
            {
              "$ref": "#/$defs/Alto.Inventory.Api.Models.Responses.Address"
            }
          ],
          "description": "The address of the inventory record."
        },
        "managementType": {
          "allOf": [
            {
              "$ref": "#/$defs/Alto.Inventory.Api.Enums.RentalManagementType"
            }
          ]
        },
        "maintenanceType": {
          "allOf": [
            {
              "$ref": "#/$defs/Alto.Inventory.Api.Enums.MaintenanceType"
            }
          ],
          "description": "Where the responsibility lies for the maintenance of a rental property."
        },
        "instructionDate": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date and time the inventory record was instructed.",
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "Alto.Inventory.Api.Models.Responses.Search.Meta": {
      "type": "object",
      "properties": {
        "nextToken": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "Alto.Services.SDK.InventoryStatus": {
      "enum": [
        "Unspecified",
        "Appraisal",
        "Available",
        "UnderOffer",
        "Completed",
        "Let",
        "LetAgreed",
        "LetMarketing",
        "Archived",
        "Suspended",
        "Withdrawn",
        "Instructed",
        "NotInstructed",
        "ExternallyLet",
        "UnderOfferMarketing",
        "UnderOfferAvailable",
        "Exchanged",
        "ExternallySold",
        "Reserved"
      ],
      "type": "string"
    }
  }
}