Skip to main content
GET
Fetch an inventory code for a clinic

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

clinic_id
integer
required

The ID of the clinic to fetch an inventory code for

inventory_code_id
integer
required

The ID of the inventory code to fetch

Response

200 - application/json

OK

category_id
integer
required

The ID of the inventory category for this inventory code

clinic_preferences
ClinicInventoryPreferenceSchema · object | null
required

The settings for this type of inventory set by the clinic. Will be null if the clinic does not have its own settings for this type of inventory

code
string
required

The global code assigned to this type of inventory at Vetcove

effective_preferences
ClinicEffectiveInventoryPreference · object
required

The effective settings for this type of inventory, favoring the clinic's settings first, followed by your organization's settings, then falling back to Vetcove's defaults when there is no override set

global_preferences
GlobalInventoryPreference · object
required

Vetcove's default settings for this type of inventory

id
integer
required

The unique identifier for the inventory code

in_transit_quantity
string
required

The number of inventory units currently in transit for this clinic

is_controlled
boolean
required

Whether this inventory code is controlled or not

kind
required

The kind of the inventory code

Available options:
STANDARD,
CUSTOM_ROLLUP,
CUSTOM
on_hold_quantity
string
required

The number of inventory units currently on hold for this clinic

organization_preferences
OrganizationInventoryPreference · object
required

The settings for this type of inventory set by your organization. This cannot be null when viewing inventory codes at the clinic level - no inventory code is accessible at the clinic level if there are no organization level preferences

stock_quantity
string
required

The number of stock items available for this inventory code