Inventory

List rooms containing an inventory item with details

Retrieves the list of all rooms containing an inventory item with full details.

get/inventory/{inventory_id}/rooms/with-details

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/inventory/{inventory_id}/rooms/with-details
  • Auth: HTTP bearer

Path parameters

inventory_idstring uuid required

Inventory item ID

Response

Rooms containing the item with details retrieved successfully

idstring uuid required

Unique identifier of the junction

room_idstring uuid required

Room ID

inventory_idstring uuid required

Inventory item ID

quantity_in_roominteger required

Quantity of the item in this room

location_descriptionstring nullable

Description of the location within the room

position_xnumber nullable

X position in the room (in meters)

position_ynumber nullable

Y position in the room (in meters)

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

Condition state of an inventory item

condition_notes_in_roomstring nullable

Notes on the condition in this room

placed_datestring date required

Date placed in the room

removed_datestring date nullable

Date removed from the room

is_activeboolean required

Indicates whether the item is currently in this room

notesstring nullable

Notes specific to this room

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "room_id": "550e8400-e29b-41d4-a716-446655440001",
    "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
    "quantity_in_room": 1,
    "location_description": "Near the window",
    "position_x": 2.5,
    "position_y": 1.2,
    "condition_in_room": "GOOD",
    "condition_notes_in_room": "Works well in this room",
    "placed_date": "2024-01-15",
    "is_active": true,
    "notes": "Near the window",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "inventory": {
      "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.