Incentives

List incentive redemptions

Returns a list of incentive redemptions across all clinics in the organization. The redemptions are sorted by creation date, with the most recent appearing first.

An incentive is a clinic-funded discount on home delivery products, such as a percent or dollar amount off a first autoship order, recurring autoship orders, or any order. Incentives can apply automatically or require the client to enter a promo code. An incentive redemption records one use of an incentive on a single order item, and tracks how much the clinic spent on the discount along with the incentive’s terms, the order, client, patient, and product it was applied to. A redemption counts toward clinic spend only while its order item is active, so redemptions on canceled order items are not part of this list.

GET

ext

incentive-redemptions

List incentive redemptions

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/incentive-redemptions/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://connect.vetcove.com/ext/v2/incentive-redemptions/', 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/incentive-redemptions/",
  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/incentive-redemptions/"

	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/incentive-redemptions/")

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": [
    {
      "clinic_client_id": 123,
      "clinic_id": 123,
      "created": "2023-11-07T05:31:56Z",
      "id": 123,
      "incentive_id": 123,
      "incentive_name": "<string>",
      "incentive_type": "STANDARD",
      "item_id": 123,
      "modified": "2023-11-07T05:31:56Z",
      "order_display_number": "<string>",
      "order_id": 123,
      "order_item_id": 123,
      "spend": 123,
      "clinic_patient_id": 123,
      "first_subscription_cents_value": 123,
      "first_subscription_percent_value": 123,
      "max_discount": 123,
      "min_order_subtotal": 123,
      "non_subscription_cents_value": 123,
      "non_subscription_percent_value": 123,
      "promo_code": "<string>",
      "recurring_subscription_cents_value": 123,
      "recurring_subscription_percent_value": 123
    }
  ],
  "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.

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

incentive_id

integer | null

Filter by the ID of the redeemed incentive.

clinic_id

integer | null

Filter by the ID of the clinic.

order_placed_date__gte

string<date> | null

Redemptions on orders placed on or after this date (YYYY-MM-DD).

order_placed_date__lte

string<date> | null

Redemptions on orders placed on or before this date (YYYY-MM-DD).

Response

200 - application/json

data

Incentive Redemption · 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 incentive redemptions

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/incentive-redemptions/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://connect.vetcove.com/ext/v2/incentive-redemptions/', 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/incentive-redemptions/",
  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/incentive-redemptions/"

	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/incentive-redemptions/")

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": [
    {
      "clinic_client_id": 123,
      "clinic_id": 123,
      "created": "2023-11-07T05:31:56Z",
      "id": 123,
      "incentive_id": 123,
      "incentive_name": "<string>",
      "incentive_type": "STANDARD",
      "item_id": 123,
      "modified": "2023-11-07T05:31:56Z",
      "order_display_number": "<string>",
      "order_id": 123,
      "order_item_id": 123,
      "spend": 123,
      "clinic_patient_id": 123,
      "first_subscription_cents_value": 123,
      "first_subscription_percent_value": 123,
      "max_discount": 123,
      "min_order_subtotal": 123,
      "non_subscription_cents_value": 123,
      "non_subscription_percent_value": 123,
      "promo_code": "<string>",
      "recurring_subscription_cents_value": 123,
      "recurring_subscription_percent_value": 123
    }
  ],
  "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

Incentives

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

List incentive redemptions

Authorizations

Query Parameters

Response