Inventory

List all inventory codes for a clinic

This endpoint is available to Group API Keys only.

Returns a clinic-specific view of all relevant inventory codes, including clinic-level configuration such as pricing, stock levels, and enabled/disabled status. The inventory codes are sorted by creation date, with the most recent appearing first.

A clinic inventory code is the clinic-level view of an inventory code, including clinic-specific overrides to pricing, stock quantities, reorder points, and enabled/disabled status.

get/ext/v2/clinics/{clinic_id}/inventory-codes/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/
  • Auth
    HTTP bearer

Path parameters

clinic_idinteger required

The ID of the clinic to fetch inventory codes for

Query parameters

idsinteger[] nullable

When provided, filters to objects with these IDs.

ending_beforeinteger nullable

A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as starting_after.

starting_afterinteger nullable

A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as ending_before.

limitinteger

The maximum number of items to return per page.

codestring nullable

When provided, filters inventory codes by the code

is_enabledboolean nullable

When provided, filters inventory codes by their enabled status for the clinic. When true, returns only enabled inventory codes. When false, returns only disabled inventory codes.

status'OUT_OF_STOCK' | 'LOW_STOCK' | 'IN_STOCK' | 'UNKNOWN'

When provided, filters inventory codes by their stock status

category_idinteger nullable

When provided, limits results to inventory codes whose global inventory belongs to this category.

Response

OK

has_moreboolean

Whether there are more pages or data in this list.

next_pagestring required

A URL linking to the next page of this list.

typestring

Type of this object. Always list.

Changes

No recorded changes to this operation across all 1 revision of this API.