Get inventory items for a specific location.

post

https://integrationhub.wellsky.io/commands/v4/inventory/items/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

api-version

string

The requested API version

Body Params

Contains location ID (required), optional site ID, pagination parameters, and zero quantity flag.

Request model for retrieving inventory items for a specific location.

locationId

int64

required

≥ 1

The unique identifier of the location to retrieve inventory items.

siteId

int64 | null

The unique identifier of the site (company).

includeZeroQuantities

boolean

Flag to include items with zero quantities. Default is false (excludes zero quantities).
Setting to true makes it an intentional action to return items with 0 quantity.

isFactor

boolean | null

When true, filters to return only inventory items that are Factor items (Drug.PrescriptionFormat_Id = 5).
When false, returns only non-Factor items.
When null (default), no filter is applied.

sort

array of objects | null

sort

pageSize

int32

pageNumber

int32

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200The paged list of inventory items for the location.

400Bad request

500There was an unhandled internal exception.