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
Client associated with this purchase order, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Ownership or business unit identifier associated with this purchase order.
Example: "123e4567-e89b-12d3-a456-426614174000"
List of purchase order item identifiers associated with this purchase order.
Reference to the shipping address resource.
Example: "123e4567-e89b-12d3-a456-426614174000"
Status of the purchase order.
Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
Supplier from whom the order is placed.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder/{purchaseorderId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/purchaseorder/{purchaseorderId}
- 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/purchaseorder/{purchaseorderId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"clientId": "123e4567-e89b-12d3-a456-426614174000",
"comments": "string",
"extensions": {},
"freightAmount": "100.00",
"freightTaxAmount": "100.00",
"isActive": true,
"orderDate": "2025-01-01",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"purchaseOrderItemIds": [
"string"
],
"shippingAddressId": "123e4567-e89b-12d3-a456-426614174000",
"status": "draft",
"supplierAccountNumber": "string",
"supplierId": "123e4567-e89b-12d3-a456-426614174000",
"supplierOrderNumber": "string",
"taxAmount": "100.00",
"totalAmount": "100.00"
}'Purchaseorder replaced successfully
Client associated with this purchase order, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the purchase order was created.
Example: "2025-01-01T00:00:00.000Z"
Calendar date of the purchase order.
Example: "2025-01-01T00:00:00Z"
Ownership or business unit identifier associated with this purchase order.
Example: "123e4567-e89b-12d3-a456-426614174000"
List of purchase order item identifiers associated with this purchase order.
Canonical identifier for the purchase order.
Example: "123e4567-e89b-12d3-a456-426614174000"
Reference to the shipping address resource.
Example: "123e4567-e89b-12d3-a456-426614174000"
Status of the purchase order.
Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
Supplier from whom the order is placed.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "clientId": "123e4567-e89b-12d3-a456-426614174000", "comments": "string", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "freightAmount": "100.00", "freightTaxAmount": "100.00", "isActive": true, "orderDate": "2025-01-01T00:00:00Z", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "purchaseOrderItemIds": [ "string" ], "purchaseorderId": "123e4567-e89b-12d3-a456-426614174000", "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000", "status": "draft", "supplierAccountNumber": "string", "supplierId": "123e4567-e89b-12d3-a456-426614174000", "supplierOrderNumber": "string", "taxAmount": "100.00", "totalAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder/{purchaseorderId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/purchaseorder/{purchaseorderId}
- 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/purchaseorder/{purchaseorderId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'