Inventory codes

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

clinics

{clinic_id}

inventory-codes

List all inventory codes for a clinic

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "category_id": 123,
      "clinic_preferences": {
        "is_enabled": true,
        "last_unit_price_update": "2023-11-07T05:31:56Z",
        "min_quantity": 123,
        "name": "<string>",
        "reorder_point": 123,
        "should_track_lot_number": true,
        "status": "OUT_OF_STOCK",
        "target_quantity": 123,
        "unit_price": 1
      },
      "code": "<string>",
      "effective_preferences": {
        "grade": "A",
        "is_enabled": true,
        "min_quantity": 123,
        "name": "<string>",
        "reorder_point": 123,
        "should_track_lot_number": true,
        "target_quantity": 123,
        "unit_of_measure": "APPLICATOR",
        "unit_price": 1
      },
      "global_preferences": {
        "name": "<string>",
        "unit_of_measure": "APPLICATOR"
      },
      "id": 123,
      "in_transit_quantity": "<string>",
      "is_controlled": true,
      "kind": "STANDARD",
      "on_hold_quantity": "<string>",
      "organization_preferences": {
        "clinic_location_group_ids": [
          123
        ],
        "grade": "A",
        "is_enabled": true,
        "name": "<string>",
        "unit_of_measure": "APPLICATOR"
      },
      "stock_quantity": "<string>"
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

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 inventory codes for

Query Parameters

ids

integer[] | null

When provided, filters to objects with these IDs.

ending_before

integer | null

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_after

integer | null

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.

limit

integer

default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100

code

string | null

When provided, filters inventory codes by the code

is_enabled

boolean | null

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

enum<string> | null

When provided, filters inventory codes by their stock status

Available options:

OUT_OF_STOCK,

LOW_STOCK,

IN_STOCK,

UNKNOWN

category_id

integer | null

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

Response

200 - application/json

data

ExternalClinicInventoryCodeSchema · object[]

required

A single page of data contained within this list.

Show child attributes

next_page

string

required

A URL linking to the next page of this list.

has_more

boolean

default:false

Whether there are more pages or data in this list.

type

string

default:list

Type of this object. Always list.

⌘I

List all inventory codes for a clinic

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/inventory-codes/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "category_id": 123,
      "clinic_preferences": {
        "is_enabled": true,
        "last_unit_price_update": "2023-11-07T05:31:56Z",
        "min_quantity": 123,
        "name": "<string>",
        "reorder_point": 123,
        "should_track_lot_number": true,
        "status": "OUT_OF_STOCK",
        "target_quantity": 123,
        "unit_price": 1
      },
      "code": "<string>",
      "effective_preferences": {
        "grade": "A",
        "is_enabled": true,
        "min_quantity": 123,
        "name": "<string>",
        "reorder_point": 123,
        "should_track_lot_number": true,
        "target_quantity": 123,
        "unit_of_measure": "APPLICATOR",
        "unit_price": 1
      },
      "global_preferences": {
        "name": "<string>",
        "unit_of_measure": "APPLICATOR"
      },
      "id": 123,
      "in_transit_quantity": "<string>",
      "is_controlled": true,
      "kind": "STANDARD",
      "on_hold_quantity": "<string>",
      "organization_preferences": {
        "clinic_location_group_ids": [
          123
        ],
        "grade": "A",
        "is_enabled": true,
        "name": "<string>",
        "unit_of_measure": "APPLICATOR"
      },
      "stock_quantity": "<string>"
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

List all inventory codes for a clinic

Authorizations

Path Parameters

Query Parameters

Response