Updates the on-hand quantity of an inventory item at a specific location.

post

https://integrationhub.wellsky.io/commands/v4/inventory/items/quantity/update-on-hand

This endpoint accepts an absolute quantity value and internally calculates the adjustment needed.
Supports Drug and Supply item types.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

api-version

string

The requested API version

Body Params

The request containing the new on-hand quantity and related information.

Request model for updating the on-hand quantity of an inventory item at a specific location.
This endpoint accepts the new absolute on-hand quantity and internally calculates the adjustment needed.

inventoryItemId

int64 | null

≥ 1

The ID of the inventory item. Either InventoryItemId or ExternalRefKey must be provided.

externalRefKey

string | null

The external reference key of the inventory item. Either InventoryItemId or ExternalRefKey must be provided.

inventoryItemLocationId

int64

required

≥ 1

The ID of the inventory item location (from Inventory.InventoryItemLocation table).
This is the junction record linking an inventory item to a specific location.

newOnHandQuantity

double

required

≥ 0

The new absolute on-hand quantity. This value will replace the current on-hand quantity.
Must be greater than or equal to the committed quantity.

quantityChangeReason

string | null

The name of the quantity change reason for the adjustment.
Defaults to "Physical Inventory" if not provided.

lotInformation

object

Lot information for on-hand quantity update.

costPerUnit

double | null

≥ 0

The cost per unit for this adjustment. Only applicable for positive adjustments (inventory increases).
If not provided for positive adjustments, the system will use the last known cost.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200OK

400Bad Request

404Not Found

500Internal Server Error