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/
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-requirement
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/inventory-requirement
- 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/inventory-requirement?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&locationId=123e4567-e89b-12d3-a456-426614174000&productCode=string&productDisplay=string&productId=123e4567-e89b-12d3-a456-426614174000' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-requirement/{inventoryRequirementId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/inventory-requirement/{inventoryRequirementId}
- 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/inventory-requirement/{inventoryRequirementId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Inventory Requirement found
Current available quantity of the product at the specified location.
Example: 1.23
Timestamp when this inventory requirement record was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for this inventory requirement record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the location (e.g., clinic, warehouse) where this requirement applies.
Example: "123e4567-e89b-12d3-a456-426614174000"
Minimum quantity threshold at which the product should be reordered.
Example: 1.23
Human-readable name of the product for display purposes.
Example: "Example Name"
Identifier of the product this inventory requirement applies to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Target quantity to have on hand at the specified location.
Example: 1.23
Response
application/json
{ "availableQuantity": 1.23, "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "inventoryRequirementId": "123e4567-e89b-12d3-a456-426614174000", "locationId": "123e4567-e89b-12d3-a456-426614174000", "minimumQuantity": 1.23, "productCode": "CODE-001", "productDisplay": "Example Name", "productId": "123e4567-e89b-12d3-a456-426614174000", "requiredQuantity": 1.23, "updatedAt": "2025-01-01T00:00:00.000Z" }
Bodyapplication/jsonrequired
Current available quantity of the product at the specified location.
Example: 1.23
Identifier of the location (e.g., clinic, warehouse) where this requirement applies.
Example: "123e4567-e89b-12d3-a456-426614174000"
Minimum quantity threshold at which the product should be reordered.
Example: 1.23
Human-readable name of the product for display purposes.
Example: "Example Name"
Identifier of the product this inventory requirement applies to.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-requirement/{inventoryRequirementId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/inventory-requirement/{inventoryRequirementId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-requirement/{inventoryRequirementId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"availableQuantity": 1.23,
"extensions": {},
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"minimumQuantity": 1.23,
"productCode": "CODE-001",
"productDisplay": "Example Name",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"requiredQuantity": 1.23
}'Inventory Requirement updated successfully
Current available quantity of the product at the specified location.
Example: 1.23
Timestamp when this inventory requirement record was created.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for this inventory requirement record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the location (e.g., clinic, warehouse) where this requirement applies.
Example: "123e4567-e89b-12d3-a456-426614174000"
Minimum quantity threshold at which the product should be reordered.
Example: 1.23
Human-readable name of the product for display purposes.
Example: "Example Name"
Identifier of the product this inventory requirement applies to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Target quantity to have on hand at the specified location.
Example: 1.23
Response
application/json
{ "availableQuantity": 1.23, "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "inventoryRequirementId": "123e4567-e89b-12d3-a456-426614174000", "locationId": "123e4567-e89b-12d3-a456-426614174000", "minimumQuantity": 1.23, "productCode": "CODE-001", "productDisplay": "Example Name", "productId": "123e4567-e89b-12d3-a456-426614174000", "requiredQuantity": 1.23, "updatedAt": "2025-01-01T00:00:00.000Z" }