Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Address

Operations

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Create product

Request

Creates a new Product record. Product resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
codestring

Practice-specific product code or SKU.

concentrationnumber

Concentration value of the product (e.g., 50 for 50 mg/mL).

concentrationDilutednumber

Concentration value after dilution, if applicable.

concentrationDilutedUnitstring

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestring

Volume unit for the diluted concentration denominator.

concentrationUnitstring

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestring

Volume unit for the concentration denominator (e.g., mL).

defaultDosageCalculationMethodstring

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstring

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstring

Default route of administration (e.g., oral, IV, IM).

descriptionstring

Detailed description of the product.

extensionsobject

Vendor- or practice-specific extensions.

hasCostPriceboolean

Whether the product has a direct cost price configured.

isActivebooleanrequired

Whether the product is active and available for use.

isConstantRateInfusionboolean

Whether the product is typically administered as a constant rate infusion.

isContainerboolean

Whether the product is a container for other products.

isDerivedPriceboolean

Whether the product price is derived from other configuration.

isPurchasedboolean

Whether the product can be purchased from suppliers.

isSoldboolean

Whether the product can be sold to clients.

lowestDispensableQuantitynumber

Smallest quantity that can be dispensed.

lowestDispensableUnitstring

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestringrequired

Human-readable product name.

productGroupIdstring

Identifier of the product group/category this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstringrequired

Canonical stable identifier for the product.

Example: "123e4567-e89b-12d3-a456-426614174000"
productTypestring

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstring

Identifier of the sheet/group this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
sheetGroupNamestring

Human-readable name of the sheet/group.

stockLevelobject

Aggregated stock level information for this product.

trackingLevelstring

Inventory tracking level for this product.

Enum"none""product""batch"
warningstring

Warning or caution text associated with the product.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "concentration": 0,
    "concentrationDiluted": 0,
    "concentrationDilutedUnit": "string",
    "concentrationDilutedVolume": "string",
    "concentrationUnit": "string",
    "concentrationVolume": "string",
    "defaultDosageCalculationMethod": "string",
    "defaultInfusionRatePer": "string",
    "defaultRouteOfAdministration": "string",
    "description": "string",
    "extensions": {},
    "hasCostPrice": true,
    "isActive": true,
    "isConstantRateInfusion": true,
    "isContainer": true,
    "isDerivedPrice": true,
    "isPurchased": true,
    "isSold": true,
    "lowestDispensableQuantity": 0,
    "lowestDispensableUnit": "string",
    "name": "string",
    "productGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "productType": "standard",
    "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "sheetGroupName": "string",
    "stockLevel": {},
    "trackingLevel": "none",
    "warning": "string"
  }'

Responses

Product created successfully

Bodyapplication/json
codestringrequired

Practice-specific product code or SKU.

concentrationnumberrequired

Concentration value of the product (e.g., 50 for 50 mg/mL).

concentrationDilutednumberrequired

Concentration value after dilution, if applicable.

concentrationDilutedUnitstringrequired

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestringrequired

Volume unit for the diluted concentration denominator.

concentrationUnitstringrequired

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestringrequired

Volume unit for the concentration denominator (e.g., mL).

createdAtstring(date-time)required

Timestamp when the product was created.

Example: "2025-01-01T00:00:00.000Z"
defaultDosageCalculationMethodstringrequired

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstringrequired

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstringrequired

Default route of administration (e.g., oral, IV, IM).

descriptionstringrequired

Detailed description of the product.

extensionsobjectrequired

Vendor- or practice-specific extensions.

hasCostPricebooleanrequired

Whether the product has a direct cost price configured.

isActivebooleanrequired

Whether the product is active and available for use.

isConstantRateInfusionbooleanrequired

Whether the product is typically administered as a constant rate infusion.

isContainerbooleanrequired

Whether the product is a container for other products.

isDerivedPricebooleanrequired

Whether the product price is derived from other configuration.

isPurchasedbooleanrequired

Whether the product can be purchased from suppliers.

isSoldbooleanrequired

Whether the product can be sold to clients.

lowestDispensableQuantitynumberrequired

Smallest quantity that can be dispensed.

lowestDispensableUnitstringrequired

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestringrequired

Human-readable product name.

productGroupIdstringrequired

Identifier of the product group/category this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstringrequired

Canonical stable identifier for the product.

Example: "123e4567-e89b-12d3-a456-426614174000"
productTypestringrequired

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstringrequired

Identifier of the sheet/group this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
sheetGroupNamestringrequired

Human-readable name of the sheet/group.

stockLevelobjectrequired

Aggregated stock level information for this product.

trackingLevelstringrequired

Inventory tracking level for this product.

Enum"none""product""batch"
updatedAtstring(date-time)required

Timestamp when the product was last modified.

Example: "2025-01-01T00:00:00.000Z"
warningstringrequired

Warning or caution text associated with the product.

Response
application/json
{
  "code": "string",
  "concentration": 0,
  "concentrationDiluted": 0,
  "concentrationDilutedUnit": "string",
  "concentrationDilutedVolume": "string",
  "concentrationUnit": "string",
  "concentrationVolume": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "defaultDosageCalculationMethod": "string",
  "defaultInfusionRatePer": "string",
  "defaultRouteOfAdministration": "string",
  "description": "string",
  "extensions": {},
  "hasCostPrice": true,
  "isActive": true,
  "isConstantRateInfusion": true,
  "isContainer": true,
  "isDerivedPrice": true,
  "isPurchased": true,
  "isSold": true,
  "lowestDispensableQuantity": 0,
  "lowestDispensableUnit": "string",
  "name": "string",
  "productGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productType": "standard",
  "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "sheetGroupName": "string",
  "stockLevel": {},
  "trackingLevel": "none",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "warning": "string"
}

List products

Request

Returns a paginated list of Products for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber>= 0

Page number (0-indexed)

Default 0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
sortBystring

Field to sort by

Enum"createdAt""updatedAt""code""concentration""concentrationDiluted""concentrationDilutedUnit""concentrationDilutedVolume""concentrationUnit""concentrationVolume""defaultDosageCalculationMethod"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
codestring

Practice-specific product code or SKU.

concentrationDilutedUnitstring

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestring

Volume unit for the diluted concentration denominator.

concentrationUnitstring

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestring

Volume unit for the concentration denominator (e.g., mL).

defaultDosageCalculationMethodstring

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstring

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstring

Default route of administration (e.g., oral, IV, IM).

descriptionstring

Detailed description of the product.

hasCostPriceboolean

Whether the product has a direct cost price configured.

isActiveboolean

Whether the product is active and available for use.

isConstantRateInfusionboolean

Whether the product is typically administered as a constant rate infusion.

isContainerboolean

Whether the product is a container for other products.

isDerivedPriceboolean

Whether the product price is derived from other configuration.

isPurchasedboolean

Whether the product can be purchased from suppliers.

isSoldboolean

Whether the product can be sold to clients.

lowestDispensableUnitstring

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestring

Human-readable product name.

productGroupIdstring

Identifier of the product group/category this product belongs to.

Example: productGroupId=123e4567-e89b-12d3-a456-426614174000
productTypestring

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstring

Identifier of the sheet/group this product belongs to.

Example: sheetGroupId=123e4567-e89b-12d3-a456-426614174000
sheetGroupNamestring

Human-readable name of the sheet/group.

trackingLevelstring

Inventory tracking level for this product.

Enum"none""product""batch"
warningstring

Warning or caution text associated with the product.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&code=string&concentrationDilutedUnit=string&concentrationDilutedVolume=string&concentrationUnit=string&concentrationVolume=string&defaultDosageCalculationMethod=string&defaultInfusionRatePer=string&defaultRouteOfAdministration=string&description=string&hasCostPrice=true&isActive=true&isConstantRateInfusion=true&isContainer=true&isDerivedPrice=true&isPurchased=true&isSold=true&lowestDispensableUnit=string&name=string&productGroupId=123e4567-e89b-12d3-a456-426614174000&productType=standard&sheetGroupId=123e4567-e89b-12d3-a456-426614174000&sheetGroupName=string&trackingLevel=none&warning=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Products

Get product

Request

Returns a single Product by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productIdstringrequired

Product unique identifier (UUID)

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product/{productId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Product found

Bodyapplication/json
codestringrequired

Practice-specific product code or SKU.

concentrationnumberrequired

Concentration value of the product (e.g., 50 for 50 mg/mL).

concentrationDilutednumberrequired

Concentration value after dilution, if applicable.

concentrationDilutedUnitstringrequired

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestringrequired

Volume unit for the diluted concentration denominator.

concentrationUnitstringrequired

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestringrequired

Volume unit for the concentration denominator (e.g., mL).

createdAtstring(date-time)required

Timestamp when the product was created.

Example: "2025-01-01T00:00:00.000Z"
defaultDosageCalculationMethodstringrequired

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstringrequired

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstringrequired

Default route of administration (e.g., oral, IV, IM).

descriptionstringrequired

Detailed description of the product.

extensionsobjectrequired

Vendor- or practice-specific extensions.

hasCostPricebooleanrequired

Whether the product has a direct cost price configured.

isActivebooleanrequired

Whether the product is active and available for use.

isConstantRateInfusionbooleanrequired

Whether the product is typically administered as a constant rate infusion.

isContainerbooleanrequired

Whether the product is a container for other products.

isDerivedPricebooleanrequired

Whether the product price is derived from other configuration.

isPurchasedbooleanrequired

Whether the product can be purchased from suppliers.

isSoldbooleanrequired

Whether the product can be sold to clients.

lowestDispensableQuantitynumberrequired

Smallest quantity that can be dispensed.

lowestDispensableUnitstringrequired

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestringrequired

Human-readable product name.

productGroupIdstringrequired

Identifier of the product group/category this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstringrequired

Canonical stable identifier for the product.

Example: "123e4567-e89b-12d3-a456-426614174000"
productTypestringrequired

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstringrequired

Identifier of the sheet/group this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
sheetGroupNamestringrequired

Human-readable name of the sheet/group.

stockLevelobjectrequired

Aggregated stock level information for this product.

trackingLevelstringrequired

Inventory tracking level for this product.

Enum"none""product""batch"
updatedAtstring(date-time)required

Timestamp when the product was last modified.

Example: "2025-01-01T00:00:00.000Z"
warningstringrequired

Warning or caution text associated with the product.

Response
application/json
{
  "code": "string",
  "concentration": 0,
  "concentrationDiluted": 0,
  "concentrationDilutedUnit": "string",
  "concentrationDilutedVolume": "string",
  "concentrationUnit": "string",
  "concentrationVolume": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "defaultDosageCalculationMethod": "string",
  "defaultInfusionRatePer": "string",
  "defaultRouteOfAdministration": "string",
  "description": "string",
  "extensions": {},
  "hasCostPrice": true,
  "isActive": true,
  "isConstantRateInfusion": true,
  "isContainer": true,
  "isDerivedPrice": true,
  "isPurchased": true,
  "isSold": true,
  "lowestDispensableQuantity": 0,
  "lowestDispensableUnit": "string",
  "name": "string",
  "productGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productType": "standard",
  "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "sheetGroupName": "string",
  "stockLevel": {},
  "trackingLevel": "none",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "warning": "string"
}

Update product

Request

Partially updates an existing Product. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productIdstringrequired

Product unique identifier (UUID)

Bodyapplication/jsonrequired
codestring

Practice-specific product code or SKU.

concentrationnumber

Concentration value of the product (e.g., 50 for 50 mg/mL).

concentrationDilutednumber

Concentration value after dilution, if applicable.

concentrationDilutedUnitstring

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestring

Volume unit for the diluted concentration denominator.

concentrationUnitstring

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestring

Volume unit for the concentration denominator (e.g., mL).

defaultDosageCalculationMethodstring

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstring

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstring

Default route of administration (e.g., oral, IV, IM).

descriptionstring

Detailed description of the product.

extensionsobject

Vendor- or practice-specific extensions.

hasCostPriceboolean

Whether the product has a direct cost price configured.

isActiveboolean

Whether the product is active and available for use.

isConstantRateInfusionboolean

Whether the product is typically administered as a constant rate infusion.

isContainerboolean

Whether the product is a container for other products.

isDerivedPriceboolean

Whether the product price is derived from other configuration.

isPurchasedboolean

Whether the product can be purchased from suppliers.

isSoldboolean

Whether the product can be sold to clients.

lowestDispensableQuantitynumber

Smallest quantity that can be dispensed.

lowestDispensableUnitstring

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestring

Human-readable product name.

productGroupIdstring

Identifier of the product group/category this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productTypestring

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstring

Identifier of the sheet/group this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
sheetGroupNamestring

Human-readable name of the sheet/group.

stockLevelobject

Aggregated stock level information for this product.

trackingLevelstring

Inventory tracking level for this product.

Enum"none""product""batch"
warningstring

Warning or caution text associated with the product.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product/{productId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "concentration": 0,
    "concentrationDiluted": 0,
    "concentrationDilutedUnit": "string",
    "concentrationDilutedVolume": "string",
    "concentrationUnit": "string",
    "concentrationVolume": "string",
    "defaultDosageCalculationMethod": "string",
    "defaultInfusionRatePer": "string",
    "defaultRouteOfAdministration": "string",
    "description": "string",
    "extensions": {},
    "hasCostPrice": true,
    "isActive": true,
    "isConstantRateInfusion": true,
    "isContainer": true,
    "isDerivedPrice": true,
    "isPurchased": true,
    "isSold": true,
    "lowestDispensableQuantity": 0,
    "lowestDispensableUnit": "string",
    "name": "string",
    "productGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "productType": "standard",
    "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "sheetGroupName": "string",
    "stockLevel": {},
    "trackingLevel": "none",
    "warning": "string"
  }'

Responses

Product updated successfully

Bodyapplication/json
codestringrequired

Practice-specific product code or SKU.

concentrationnumberrequired

Concentration value of the product (e.g., 50 for 50 mg/mL).

concentrationDilutednumberrequired

Concentration value after dilution, if applicable.

concentrationDilutedUnitstringrequired

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestringrequired

Volume unit for the diluted concentration denominator.

concentrationUnitstringrequired

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestringrequired

Volume unit for the concentration denominator (e.g., mL).

createdAtstring(date-time)required

Timestamp when the product was created.

Example: "2025-01-01T00:00:00.000Z"
defaultDosageCalculationMethodstringrequired

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstringrequired

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstringrequired

Default route of administration (e.g., oral, IV, IM).

descriptionstringrequired

Detailed description of the product.

extensionsobjectrequired

Vendor- or practice-specific extensions.

hasCostPricebooleanrequired

Whether the product has a direct cost price configured.

isActivebooleanrequired

Whether the product is active and available for use.

isConstantRateInfusionbooleanrequired

Whether the product is typically administered as a constant rate infusion.

isContainerbooleanrequired

Whether the product is a container for other products.

isDerivedPricebooleanrequired

Whether the product price is derived from other configuration.

isPurchasedbooleanrequired

Whether the product can be purchased from suppliers.

isSoldbooleanrequired

Whether the product can be sold to clients.

lowestDispensableQuantitynumberrequired

Smallest quantity that can be dispensed.

lowestDispensableUnitstringrequired

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestringrequired

Human-readable product name.

productGroupIdstringrequired

Identifier of the product group/category this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstringrequired

Canonical stable identifier for the product.

Example: "123e4567-e89b-12d3-a456-426614174000"
productTypestringrequired

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstringrequired

Identifier of the sheet/group this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
sheetGroupNamestringrequired

Human-readable name of the sheet/group.

stockLevelobjectrequired

Aggregated stock level information for this product.

trackingLevelstringrequired

Inventory tracking level for this product.

Enum"none""product""batch"
updatedAtstring(date-time)required

Timestamp when the product was last modified.

Example: "2025-01-01T00:00:00.000Z"
warningstringrequired

Warning or caution text associated with the product.

Response
application/json
{
  "code": "string",
  "concentration": 0,
  "concentrationDiluted": 0,
  "concentrationDilutedUnit": "string",
  "concentrationDilutedVolume": "string",
  "concentrationUnit": "string",
  "concentrationVolume": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "defaultDosageCalculationMethod": "string",
  "defaultInfusionRatePer": "string",
  "defaultRouteOfAdministration": "string",
  "description": "string",
  "extensions": {},
  "hasCostPrice": true,
  "isActive": true,
  "isConstantRateInfusion": true,
  "isContainer": true,
  "isDerivedPrice": true,
  "isPurchased": true,
  "isSold": true,
  "lowestDispensableQuantity": 0,
  "lowestDispensableUnit": "string",
  "name": "string",
  "productGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productType": "standard",
  "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "sheetGroupName": "string",
  "stockLevel": {},
  "trackingLevel": "none",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "warning": "string"
}

Replace product

Request

Fully replaces an existing Product. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productIdstringrequired

Product unique identifier (UUID)

Bodyapplication/jsonrequired
codestringrequired

Practice-specific product code or SKU.

concentrationnumberrequired

Concentration value of the product (e.g., 50 for 50 mg/mL).

concentrationDilutednumberrequired

Concentration value after dilution, if applicable.

concentrationDilutedUnitstringrequired

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestringrequired

Volume unit for the diluted concentration denominator.

concentrationUnitstringrequired

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestringrequired

Volume unit for the concentration denominator (e.g., mL).

defaultDosageCalculationMethodstringrequired

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstringrequired

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstringrequired

Default route of administration (e.g., oral, IV, IM).

descriptionstringrequired

Detailed description of the product.

extensionsobjectrequired

Vendor- or practice-specific extensions.

hasCostPricebooleanrequired

Whether the product has a direct cost price configured.

isActivebooleanrequired

Whether the product is active and available for use.

isConstantRateInfusionbooleanrequired

Whether the product is typically administered as a constant rate infusion.

isContainerbooleanrequired

Whether the product is a container for other products.

isDerivedPricebooleanrequired

Whether the product price is derived from other configuration.

isPurchasedbooleanrequired

Whether the product can be purchased from suppliers.

isSoldbooleanrequired

Whether the product can be sold to clients.

lowestDispensableQuantitynumberrequired

Smallest quantity that can be dispensed.

lowestDispensableUnitstringrequired

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestringrequired

Human-readable product name.

productGroupIdstringrequired

Identifier of the product group/category this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productTypestringrequired

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstringrequired

Identifier of the sheet/group this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
sheetGroupNamestringrequired

Human-readable name of the sheet/group.

stockLevelobjectrequired

Aggregated stock level information for this product.

trackingLevelstringrequired

Inventory tracking level for this product.

Enum"none""product""batch"
warningstringrequired

Warning or caution text associated with the product.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product/{productId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "concentration": 0,
    "concentrationDiluted": 0,
    "concentrationDilutedUnit": "string",
    "concentrationDilutedVolume": "string",
    "concentrationUnit": "string",
    "concentrationVolume": "string",
    "defaultDosageCalculationMethod": "string",
    "defaultInfusionRatePer": "string",
    "defaultRouteOfAdministration": "string",
    "description": "string",
    "extensions": {},
    "hasCostPrice": true,
    "isActive": true,
    "isConstantRateInfusion": true,
    "isContainer": true,
    "isDerivedPrice": true,
    "isPurchased": true,
    "isSold": true,
    "lowestDispensableQuantity": 0,
    "lowestDispensableUnit": "string",
    "name": "string",
    "productGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "productType": "standard",
    "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "sheetGroupName": "string",
    "stockLevel": {},
    "trackingLevel": "none",
    "warning": "string"
  }'

Responses

Product replaced successfully

Bodyapplication/json
codestringrequired

Practice-specific product code or SKU.

concentrationnumberrequired

Concentration value of the product (e.g., 50 for 50 mg/mL).

concentrationDilutednumberrequired

Concentration value after dilution, if applicable.

concentrationDilutedUnitstringrequired

Unit of measure for the diluted concentration numerator.

concentrationDilutedVolumestringrequired

Volume unit for the diluted concentration denominator.

concentrationUnitstringrequired

Unit of measure for the concentration numerator (e.g., mg).

concentrationVolumestringrequired

Volume unit for the concentration denominator (e.g., mL).

createdAtstring(date-time)required

Timestamp when the product was created.

Example: "2025-01-01T00:00:00.000Z"
defaultDosageCalculationMethodstringrequired

Default method used to calculate dosage (e.g., perKg, perAnimal).

defaultInfusionRatePerstringrequired

Default infusion rate basis (e.g., perHour, perDay).

defaultRouteOfAdministrationstringrequired

Default route of administration (e.g., oral, IV, IM).

descriptionstringrequired

Detailed description of the product.

extensionsobjectrequired

Vendor- or practice-specific extensions.

hasCostPricebooleanrequired

Whether the product has a direct cost price configured.

isActivebooleanrequired

Whether the product is active and available for use.

isConstantRateInfusionbooleanrequired

Whether the product is typically administered as a constant rate infusion.

isContainerbooleanrequired

Whether the product is a container for other products.

isDerivedPricebooleanrequired

Whether the product price is derived from other configuration.

isPurchasedbooleanrequired

Whether the product can be purchased from suppliers.

isSoldbooleanrequired

Whether the product can be sold to clients.

lowestDispensableQuantitynumberrequired

Smallest quantity that can be dispensed.

lowestDispensableUnitstringrequired

Unit for the lowest dispensable quantity (e.g., tablet, mL).

namestringrequired

Human-readable product name.

productGroupIdstringrequired

Identifier of the product group/category this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstringrequired

Canonical stable identifier for the product.

Example: "123e4567-e89b-12d3-a456-426614174000"
productTypestringrequired

Type/category of product.

Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
sheetGroupIdstringrequired

Identifier of the sheet/group this product belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
sheetGroupNamestringrequired

Human-readable name of the sheet/group.

stockLevelobjectrequired

Aggregated stock level information for this product.

trackingLevelstringrequired

Inventory tracking level for this product.

Enum"none""product""batch"
updatedAtstring(date-time)required

Timestamp when the product was last modified.

Example: "2025-01-01T00:00:00.000Z"
warningstringrequired

Warning or caution text associated with the product.

Response
application/json
{
  "code": "string",
  "concentration": 0,
  "concentrationDiluted": 0,
  "concentrationDilutedUnit": "string",
  "concentrationDilutedVolume": "string",
  "concentrationUnit": "string",
  "concentrationVolume": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "defaultDosageCalculationMethod": "string",
  "defaultInfusionRatePer": "string",
  "defaultRouteOfAdministration": "string",
  "description": "string",
  "extensions": {},
  "hasCostPrice": true,
  "isActive": true,
  "isConstantRateInfusion": true,
  "isContainer": true,
  "isDerivedPrice": true,
  "isPurchased": true,
  "isSold": true,
  "lowestDispensableQuantity": 0,
  "lowestDispensableUnit": "string",
  "name": "string",
  "productGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productType": "standard",
  "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "sheetGroupName": "string",
  "stockLevel": {},
  "trackingLevel": "none",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "warning": "string"
}

Delete product

Request

Permanently deletes a Product record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productIdstringrequired

Product unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product/{productId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Product deleted successfully

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations