Sign in
Inventory

Get a specific inventory item by ID with stock information

get/Inventory/{id}

Path parameters

idstring required

The inventory item ID

Response

OK

idstring
namestring
invoiceNamestring nullable
skustring nullable
barcodestring nullable
descriptionstring nullable
defaultSigstring nullable

Default prescription instructions (SIG) for rx-required items. See PAW-671.

compoundFormulastring nullable

Compounding formula / preparation details for compounded items. See PAW-671.

categorystring
vaccineTypeIdstring nullable
statusstring
vendorIdstring nullable
vendorItemNumberstring nullable
drugFormstring nullable
unitOfMeasurestring nullable

Per-item dispensing-unit label override (e.g. "dose", "applicator"). Null = derive the label from DrugForm (ITE-390).

strengthstring nullable
ndcstring nullable
isCompoundedboolean
rxRequiredboolean
allowedSpeciesIdsstring[] nullable
deaBookIdstring nullable
deaSchedulestring nullable
requiresWitnessboolean

Server-computed: does dispensing this item require a witness on submit? Mirrors the predicate in DispenseValidator so UI gating stays in lockstep with backend validation.

distributionCategorystring nullable
cascadeEligibleboolean
isAntimicrobialboolean
antimicrobialTypestring nullable
requiresUnderCareboolean
requiresPhysicalExamboolean
foodProducingboolean
requiresWithdrawalPeriodboolean
pricePolicystring
isTaxableboolean
vatCategorystring nullable
trackLotsboolean
earliestExpirationstring date-time nullable
createdAtstring date-time
updatedAtstring date-time

Changes

Changed in 1 of the 6 revisions of this API.3

  • d8d7501dde483See the full diff
    • ○

      added the optional property to the response with the status (media type: text/plain)

      response-optional-property-added

    • ○

      added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status (media type: text/json)

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog