Inventory

Create a new inventory item

Creates a new inventory item. The item must be linked to either a medication (rxs), supplement (plan_other), or can be a general product.

post/inventory

Request

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

Request body

namestring required

Name of the inventory item

nicknamestring

Short nickname for the item

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

Type of linked product:

  • rxs: Links to a medication in the drugs database
  • plan_other: Links to a supplement
  • general: General inventory item (no linked product)
linked_product_idinteger

ID of the linked product. Required for "rxs" and "plan_other" types.

charge_idinteger required

ID of the associated charge in the charge master

preferred_stock_levelinteger required

Target stock level to maintain

current_quantityinteger required

Current quantity in stock

preferred_restock_levelinteger

Level at which to trigger restocking

manufacturerstring

Manufacturer name

expiration_datestring date

Expiration date (must be in the future)

lot_numberstring

Lot number for tracking

discontinuedboolean

Whether the item is discontinued

date_discontinuedstring date

Date the item was discontinued

external_identifierstring

External system identifier for integration

locationstring

Location name (for multi-location practices)

Response

OK - Returns the created inventory item

idinteger

Unique inventory item ID

namestring
linked_product_type'rxs' | 'plan_other' | 'general'
linked_product_idinteger nullable
charge_idinteger
preferred_stock_levelinteger
current_quantityinteger
createdstring date-time

Changes

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