Skip to main content
GET
Get Available Lots

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

medication_id
string
required

Query Parameters

location_id
string | null
provider_id
string | null
dose_component_id
string | null
include_depleted
boolean
default:false

Response

Successful Response

id
string
required
stockId
string
required
locationId
string
required
remainingQuantity
number
required
quantity
number
required
lotNumber
string | null
expiryDate
string<date-time> | null
ndc
string | null
cost
integer | null
createdDate
string<date-time> | null
allocatedRemainingQuantity
number | null

The administering provider's own remaining allocation of this lot. Zero when this shipment is allocated only to other providers; None when the shipment is unmanaged.

unallocatedRemainingQuantity
number | null

Unassigned physical quantity available to any provider; None when the shipment is unmanaged.

providerAvailableQuantity
number | null

Total quantity available to the administering provider (their allocation plus unassigned quantity); None when the shipment is unmanaged.