Skip to main content

ItemVariantResource

idintegerrequired
uuidstringrequired
item_idintegerrequired
serial_numberstring | nullnullablerequired
codestringrequired
condition objectrequired
anyOf
Condition (string)

Unified condition enum for inventory items and return states. Replaces the v2 split between ItemCondition (catalogue side) and ReturnCondition (rental return side). The ReturnCondition::OK case collapses into Condition::GOOD.

Possible values: [good, damaged, repair, lost]

is_availablebooleanrequired
warehouse_idinteger | nullnullablerequired
state_notesstring | nullnullablerequired
current_movement_idinteger | nullnullablerequired
item object
idintegerrequired
uuidstringrequired
codestring | nullnullablerequired
external_idstring | nullnullablerequired
namestringrequired
descriptionstring | nullnullablerequired
typeTypes (string)required

Possible values: [individual, bulk, container]

quantityintegerrequired
quantity_on_rentintegerrequired
minimum_quantityinteger | nullnullablerequired
low_stock_alert_enabledbooleanrequired
tracking_modestringrequired
reference_numberstring | nullnullablerequired
internal_numberstring | nullnullablerequired
state_notesstring | nullnullablerequired
item_type_idinteger | nullnullablerequired
warehouse_idinteger | nullnullablerequired
parent_item_idinteger | nullnullablerequired
max_capacityinteger | nullnullablerequired
categorystring
available_quantitystringrequired
is_consumablebooleanrequired
image_urlstring | nullnullablerequired
gallerystring
tags object[]
  • Array [
  • idintegerrequired
    namestringrequired
    colorstring | nullnullablerequired
    items_countinteger
    renters_countinteger
    rentals_countstring
    created_atstring | nullnullablerequired
    updated_atstring | nullnullablerequired
  • ]
  • item_type object
    idstringrequired
    namestringrequired
    iconstringrequired
    colorstringrequired
    descriptionstringrequired
    is_activestringrequired
    sort_orderstringrequired
    items_countinteger
    created_atstring | nullnullablerequired
    updated_atstring | nullnullablerequired
    created_atstring | nullnullablerequired
    updated_atstring | nullnullablerequired
    deleted_atstring | nullnullablerequired
    warehouse object
    idintegerrequired
    namestringrequired
    current_movement objectnull
    idintegerrequired
    uuidstringrequired
    statusStatus (string)required

    Rental lifecycle status. v3 collapsed the v2 9-case enum (which conflated lifecycle with logistics) into 5 lifecycle-only cases. Logistics sub-state moved to {@see LogisticsStep}. Transitions are enforced by app/Domain/Rentals/StateMachine/RentalStateMachine.php.

    Possible values: [draft, ongoing, overdue, finished, canceled]

    created_atstring | nullnullablerequired
    updated_atstring | nullnullablerequired
    deleted_atstring | nullnullablerequired
    ItemVariantResource
    {
    "id": 0,
    "uuid": "string",
    "item_id": 0,
    "serial_number": "string",
    "code": "string",
    "condition": "good",
    "is_available": true,
    "warehouse_id": 0,
    "state_notes": "string",
    "current_movement_id": 0,
    "item": {
    "id": 0,
    "uuid": "string",
    "code": "string",
    "external_id": "string",
    "name": "string",
    "description": "string",
    "type": "individual",
    "quantity": 0,
    "quantity_on_rent": 0,
    "minimum_quantity": 0,
    "low_stock_alert_enabled": true,
    "tracking_mode": "string",
    "reference_number": "string",
    "internal_number": "string",
    "state_notes": "string",
    "item_type_id": 0,
    "warehouse_id": 0,
    "parent_item_id": 0,
    "max_capacity": 0,
    "category": "string",
    "available_quantity": "string",
    "is_consumable": true,
    "image_url": "string",
    "gallery": "string",
    "tags": [
    {
    "id": 0,
    "name": "string",
    "color": "string",
    "items_count": 0,
    "renters_count": 0,
    "rentals_count": "string",
    "created_at": "string",
    "updated_at": "string"
    }
    ],
    "item_type": {
    "id": "string",
    "name": "string",
    "icon": "string",
    "color": "string",
    "description": "string",
    "is_active": "string",
    "sort_order": "string",
    "items_count": 0,
    "created_at": "string",
    "updated_at": "string"
    },
    "created_at": "string",
    "updated_at": "string",
    "deleted_at": "string"
    },
    "warehouse": {
    "id": 0,
    "name": "string"
    },
    "current_movement": "Unknown Type: object,null",
    "created_at": "string",
    "updated_at": "string",
    "deleted_at": "string"
    }