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
Identifier of the location (e.g., clinic, warehouse) where this requirement applies.
Example: "123e4567-e89b-12d3-a456-426614174000"
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 PUT \
'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": 0,
"extensions": {},
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"minimumQuantity": 0,
"productCode": "string",
"productDisplay": "string",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"requiredQuantity": 0
}'Inventory Requirement replaced successfully
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"
Identifier of the product this inventory requirement applies to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "availableQuantity": 0, "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "inventoryRequirementId": "123e4567-e89b-12d3-a456-426614174000", "locationId": "123e4567-e89b-12d3-a456-426614174000", "minimumQuantity": 0, "productCode": "string", "productDisplay": "string", "productId": "123e4567-e89b-12d3-a456-426614174000", "requiredQuantity": 0, "updatedAt": "2025-01-01T00:00:00.000Z" }
- 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 DELETE \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-requirement/{inventoryRequirementId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'