Inventory

Update an inventory item

Updates an existing inventory item. Only the fields provided will be updated. Note: linked_product_type and linked_product_id cannot be changed after creation.

patch/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

Request body

namestring

Name of the inventory item

nicknamestring

Short nickname

charge_idinteger

ID of the associated charge

preferred_stock_levelinteger

Target stock level

current_quantityinteger

Current quantity in stock

preferred_restock_levelinteger

Restock trigger level

manufacturerstring

Manufacturer name

expiration_datestring date

Expiration date (must be in the future)

lot_numberstring

Lot number

discontinuedboolean

Whether item is discontinued

date_discontinuedstring date

Discontinuation date

external_identifierstring

External system identifier

locationstring

Location name

package_propertiesobject

Package-specific properties (only provided fields are updated)

Response

OK - Returns the updated 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.