Inventory

Get a single inventory item

Retrieves detailed information about a single inventory item by its ID. Includes linked product details (drug or supplement) and charge information.

get/inventory/{id}

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/inventory/{id}
  • Auth: HTTP basic

Path parameters

idinteger required

The inventory item ID

Query parameters

include_deletedboolean

Set to true to retrieve soft-deleted items.

Response

OK - Returns the inventory item object

idinteger

Unique inventory item ID

namestring

Name of the inventory item

nicknamestring nullable

Short nickname for the item

linked_product_type'rxs' | 'plan_other' | 'general'

Type of linked product

linked_product_idinteger nullable

ID of the linked product

charge_idinteger

Associated charge master ID

preferred_stock_levelinteger

Target stock level

current_quantityinteger

Current quantity in stock

manufacturerstring nullable

Manufacturer name

expiration_datestring date nullable

Expiration date

lot_numberstring nullable

Lot number

discontinuedboolean

Whether item is discontinued

package_propertiesobject

Package-specific properties

createdstring date-time

When the item was created (UTC)

Changes

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