Inventory

Search inventory items

Performs an advanced search across inventory items

get/inventory/items/search

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/inventory/items/search
  • Auth: HTTP bearer

Query parameters

search_termstring

General search term

inventory_type_idstring uuid

Filter by inventory type

condition'EXCELLENT' | 'GOOD' | 'FAIR' | 'POOR' | 'DAMAGED' | 'NEEDS_REPAIR' | 'BROKEN' | 'MISSING'

Condition state of an inventory item

Example:GOOD

Filter by condition

estate_idstring uuid

Filter by property

category_idstring uuid

Filter by inventory category

object_naturestring

Filter by object nature

Response

Search results retrieved successfully

idstring uuid required

Unique identifier of the inventory item

inventory_type_idstring uuid required

Inventory type ID

namestring required

Specific name of the item

descriptionstring nullable

Detailed description of the item

brandstring nullable

Brand of the item

modelstring nullable

Model of the item

serial_numberstring nullable

Serial number

quantityinteger required

Quantity of items

unitstring required

Unit of measurement

condition_status'EXCELLENT' | 'GOOD' | 'FAIR' | 'POOR' | 'DAMAGED' | 'NEEDS_REPAIR' | 'BROKEN' | 'MISSING' required

Condition state of an inventory item

condition_notesstring nullable

Notes on the condition of the item

last_condition_checkstring date nullable

Date of the last condition check

next_condition_checkstring date nullable

Date of the next scheduled condition check

purchase_datestring date nullable

Purchase date

purchase_pricenumber nullable

Purchase price

current_valuenumber nullable

Estimated current value

insured_valuenumber nullable

Insured value

insurance_policy_numberstring nullable

Insurance policy number

last_maintenance_datestring date nullable

Date of the last maintenance

next_maintenance_datestring date nullable

Date of the next scheduled maintenance

maintenance_frequency_daysinteger nullable

Maintenance frequency in days

maintenance_notesstring nullable

Maintenance notes

tagsstring[]

Tags for search/filtering

custom_fieldsobject nullable

Custom fields per tenant

notesstring nullable

General notes

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Samsung Refrigerator",
    "description": "Samsung 300L refrigerator with freezer",
    "brand": "Samsung",
    "model": "RT32K5070S8",
    "serial_number": "SN123456789",
    "quantity": 1,
    "unit": "piece",
    "condition_status": "GOOD",
    "condition_notes": "Works perfectly",
    "last_condition_check": "2024-01-15",
    "next_condition_check": "2024-07-15",
    "purchase_date": "2023-06-01",
    "purchase_price": 899.99,
    "current_value": 750,
    "insured_value": 800,
    "insurance_policy_number": "POL123456789",
    "last_maintenance_date": "2024-01-10",
    "next_maintenance_date": "2024-07-10",
    "maintenance_frequency_days": 180,
    "maintenance_notes": "Filter cleaning completed",
    "tags": [
      "kitchen",
      "appliance",
      "cooling"
    ],
    "custom_fields": {
      "warranty_end": "2025-06-01",
      "supplier": "Darty"
    },
    "notes": "Installed in June 2023",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

Changes

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