Inventory

Update a Inventory Item

Update the Inventory Item with the given ID. Pass hardware_id to link the item to a Monitoring device. Pass unlink_device: true to clear the current link — sending hardware_id=0 alone leaves the existing link unchanged.

put/admin/inventory/items/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/inventory/items/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Inventory Item.

Request body

notesstring

Note

barcodestring

Unique item barcode

serial_numberstring

Serial number

supplier_invoices_item_idnumber

Supplier invoice ID

status'stock' | 'internal_usage' | 'sold' | 'rent' | 'returned' | 'assigned'

Item status

mark'new' | 'used' | 'broken'

Item mark

customer_idnumber

Customer or Lead ID

admin_idnumber

Admin ID

service_idnumber

Service ID

invoice_idnumber

Invoice ID

cost_pricenumber

Cost price

transaction_idnumber

Transaction ID

product_idnumber

Product ID

stock_idnumber

Stock ID

filename_originalstring

Original file name

filenamestring

File name

file_linkstring

Link to file

network_site_idnumber

Network site ID

delete_photoboolean

Delete current item photo.

hardware_idnumber

Link this Inventory Item to the Monitoring device with this ID. Set to 0 together with unlink_device=true to clear the link. Replaces any previous link.

unlink_deviceboolean

Explicitly unlink the currently-linked Monitoring device. Required to clear the link — sending hardware_id=0 alone is treated as "no change".

Example request

{
  "notes": "note",
  "barcode": "barcode",
  "serial_number": "number",
  "supplier_invoices_item_id": 1,
  "status": "stock",
  "mark": "new",
  "customer_id": 1,
  "admin_id": 1,
  "service_id": 1,
  "invoice_id": 1,
  "cost_price": 1,
  "transaction_id": 1,
  "product_id": 1,
  "stock_id": 1,
  "filename_original": "test.png",
  "filename": "6bcee1fd1062637b",
  "file_link": "/admin/download--view?module=inventory_items&id=21&ver=6bcee1fd1062637",
  "network_site_id": 1,
  "linked_hardware": {
    "id": 1,
    "title": "AP-Tower-1",
    "type": 1,
    "ip": "192.168.1.100"
  },
  "delete_photo": true,
  "hardware_id": 1,
  "unlink_device": true
}

Changes

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