Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
Unit of measure for the diluted concentration numerator.
Example: "example"
Volume unit for the diluted concentration denominator.
Example: "example"
Unit of measure for the concentration numerator (e.g., mg).
Example: "example"
Volume unit for the concentration denominator (e.g., mL).
Example: "example"
Default method used to calculate dosage (e.g., perKg, perAnimal).
Example: "example"
Default route of administration (e.g., oral, IV, IM).
Example: "example"
Whether the product is typically administered as a constant rate infusion.
Example: true
Unit for the lowest dispensable quantity (e.g., tablet, mL).
Example: "example"
Identifier of the product group/category this product belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical stable identifier for the product.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type/category of product.
Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
Example: "standard"
Identifier of the sheet/group this product belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Inventory tracking level for this product.
Enum"none""product""batch"
Example: "none"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/product
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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": "CODE-001",
"concentration": 1.23,
"concentrationDiluted": 1.23,
"concentrationDilutedUnit": "example",
"concentrationDilutedVolume": "example",
"concentrationUnit": "example",
"concentrationVolume": "example",
"defaultDosageCalculationMethod": "example",
"defaultInfusionRatePer": "example",
"defaultRouteOfAdministration": "example",
"description": "Example description",
"extensions": {},
"hasCostPrice": true,
"isActive": true,
"isConstantRateInfusion": true,
"isContainer": true,
"isDerivedPrice": true,
"isPurchased": true,
"isSold": true,
"lowestDispensableQuantity": 1.23,
"lowestDispensableUnit": "example",
"name": "Example Name",
"productGroupId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"productType": "standard",
"sheetGroupId": "123e4567-e89b-12d3-a456-426614174000",
"sheetGroupName": "Example Name",
"stockLevel": {},
"trackingLevel": "none",
"warning": "example"
}'Product created successfully
Concentration value of the product (e.g., 50 for 50 mg/mL).
Example: 1.23
Unit of measure for the diluted concentration numerator.
Example: "example"
Volume unit for the diluted concentration denominator.
Example: "example"
Unit of measure for the concentration numerator (e.g., mg).
Example: "example"
Volume unit for the concentration denominator (e.g., mL).
Example: "example"
Timestamp when the product was created.
Example: "2025-01-01T00:00:00.000Z"
Default method used to calculate dosage (e.g., perKg, perAnimal).
Example: "example"
Default infusion rate basis (e.g., perHour, perDay).
Example: "example"
Default route of administration (e.g., oral, IV, IM).
Example: "example"
Whether the product is typically administered as a constant rate infusion.
Example: true
Whether the product price is derived from other configuration.
Example: true
Unit for the lowest dispensable quantity (e.g., tablet, mL).
Example: "example"
Identifier of the product group/category this product belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical stable identifier for the product.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type/category of product.
Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
Example: "standard"
Identifier of the sheet/group this product belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Inventory tracking level for this product.
Enum"none""product""batch"
Example: "none"
Timestamp when the product was last modified.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "code": "CODE-001", "concentration": 1.23, "concentrationDiluted": 1.23, "concentrationDilutedUnit": "example", "concentrationDilutedVolume": "example", "concentrationUnit": "example", "concentrationVolume": "example", "createdAt": "2025-01-01T00:00:00.000Z", "defaultDosageCalculationMethod": "example", "defaultInfusionRatePer": "example", "defaultRouteOfAdministration": "example", "description": "Example description", "extensions": {}, "hasCostPrice": true, "isActive": true, "isConstantRateInfusion": true, "isContainer": true, "isDerivedPrice": true, "isPurchased": true, "isSold": true, "lowestDispensableQuantity": 1.23, "lowestDispensableUnit": "example", "name": "Example Name", "productGroupId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "productType": "standard", "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000", "sheetGroupName": "Example Name", "stockLevel": {}, "trackingLevel": "none", "updatedAt": "2025-01-01T00:00:00.000Z", "warning": "example" }
Query
Field to sort by
Enum"createdAt""updatedAt""code""concentration""concentrationDiluted""concentrationDilutedUnit""concentrationDilutedVolume""concentrationUnit""concentrationVolume""defaultDosageCalculationMethod"
Default method used to calculate dosage (e.g., perKg, perAnimal).
Whether the product is typically administered as a constant rate infusion.
Identifier of the product group/category this product belongs to.
Example: productGroupId=123e4567-e89b-12d3-a456-426614174000
Type/category of product.
Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
Identifier of the sheet/group this product belongs to.
Example: sheetGroupId=123e4567-e89b-12d3-a456-426614174000
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/product
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product/{productId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/product/{productId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'Product found
Concentration value of the product (e.g., 50 for 50 mg/mL).
Example: 1.23
Unit of measure for the diluted concentration numerator.
Example: "example"
Volume unit for the diluted concentration denominator.
Example: "example"
Unit of measure for the concentration numerator (e.g., mg).
Example: "example"
Volume unit for the concentration denominator (e.g., mL).
Example: "example"
Timestamp when the product was created.
Example: "2025-01-01T00:00:00.000Z"
Default method used to calculate dosage (e.g., perKg, perAnimal).
Example: "example"
Default infusion rate basis (e.g., perHour, perDay).
Example: "example"
Default route of administration (e.g., oral, IV, IM).
Example: "example"
Whether the product is typically administered as a constant rate infusion.
Example: true
Whether the product price is derived from other configuration.
Example: true
Unit for the lowest dispensable quantity (e.g., tablet, mL).
Example: "example"
Identifier of the product group/category this product belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical stable identifier for the product.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type/category of product.
Enum"standard""medication""vaccination""diagnostic""integratedDiagnostic""procedure"
Example: "standard"
Identifier of the sheet/group this product belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Inventory tracking level for this product.
Enum"none""product""batch"
Example: "none"
Timestamp when the product was last modified.
Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "code": "CODE-001", "concentration": 1.23, "concentrationDiluted": 1.23, "concentrationDilutedUnit": "example", "concentrationDilutedVolume": "example", "concentrationUnit": "example", "concentrationVolume": "example", "createdAt": "2025-01-01T00:00:00.000Z", "defaultDosageCalculationMethod": "example", "defaultInfusionRatePer": "example", "defaultRouteOfAdministration": "example", "description": "Example description", "extensions": {}, "hasCostPrice": true, "isActive": true, "isConstantRateInfusion": true, "isContainer": true, "isDerivedPrice": true, "isPurchased": true, "isSold": true, "lowestDispensableQuantity": 1.23, "lowestDispensableUnit": "example", "name": "Example Name", "productGroupId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "productType": "standard", "sheetGroupId": "123e4567-e89b-12d3-a456-426614174000", "sheetGroupName": "Example Name", "stockLevel": {}, "trackingLevel": "none", "updatedAt": "2025-01-01T00:00:00.000Z", "warning": "example" }