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
Optional client-supplied identifier for this supplied record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Indicates whether this supplied record is active (not fully reversed or deleted).
Inventory location or store where the product was supplied.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the product that was supplied.
Example: "123e4567-e89b-12d3-a456-426614174000"
Date and time when the product was supplied/received into inventory.
Example: "2025-01-01T00:00:00.000Z"
Reference to the supplier providing the product.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/supplied/{suppliedId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/supplied/{suppliedId}
- 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/supplied/{suppliedId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"batchNumber": "string",
"clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
"expiryDate": "2025-01-01",
"extensions": {},
"isActive": true,
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"notes": "string",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": {
"value": 0,
"unit": "string",
"system": "string"
},
"referenceNumber": "string",
"suppliedAt": "2025-01-01T00:00:00.000Z",
"supplierId": "123e4567-e89b-12d3-a456-426614174000",
"totalCost": {},
"unitCost": {}
}'Supplied replaced successfully
Optional client-supplied identifier for this supplied record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this record was created in the source system.
Example: "2025-01-01T00:00:00.000Z"
Expiry date of the supplied batch, if applicable.
Example: "2025-01-01T00:00:00Z"
Indicates whether this supplied record is active (not fully reversed or deleted).
Inventory location or store where the product was supplied.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the product that was supplied.
Example: "123e4567-e89b-12d3-a456-426614174000"
Date and time when the product was supplied/received into inventory.
Example: "2025-01-01T00:00:00.000Z"
Canonical identifier for this supplied inventory record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the supplier providing the product.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "batchNumber": "string", "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "expiryDate": "2025-01-01T00:00:00Z", "extensions": {}, "isActive": true, "locationId": "123e4567-e89b-12d3-a456-426614174000", "notes": "string", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": { "value": 0, "unit": "string", "system": "string" }, "referenceNumber": "string", "suppliedAt": "2025-01-01T00:00:00.000Z", "suppliedId": "123e4567-e89b-12d3-a456-426614174000", "supplierId": "123e4567-e89b-12d3-a456-426614174000", "totalCost": {}, "unitCost": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/supplied/{suppliedId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/supplied/{suppliedId}
- 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/supplied/{suppliedId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'