Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
http://localhost:8083/
Client associated with this purchase order, if applicable.
Ownership or business unit identifier associated with this purchase order.
List of purchase order item identifiers associated with this purchase order.
Canonical identifier for the purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/purchaseorder
- 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/purchaseorder' \
-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"
],
"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"
}'Purchaseorder created successfully
Client associated with this purchase order, if applicable.
Timestamp when the purchase order was created.
Calendar date of the purchase order.
Ownership or business unit identifier associated with this purchase order.
List of purchase order item identifiers associated with this purchase order.
Canonical identifier for the purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
{ "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" }
Field to sort by
Client associated with this purchase order, if applicable.
Ownership or business unit identifier associated with this purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/purchaseorder
- 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/purchaseorder?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&clientId=123e4567-e89b-12d3-a456-426614174000&comments=string&isActive=true&ownershipId=123e4567-e89b-12d3-a456-426614174000&shippingAddressId=123e4567-e89b-12d3-a456-426614174000&status=draft&supplierAccountNumber=string&supplierId=123e4567-e89b-12d3-a456-426614174000&supplierOrderNumber=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- 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 GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder/{purchaseorderId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Purchaseorder found
Client associated with this purchase order, if applicable.
Timestamp when the purchase order was created.
Calendar date of the purchase order.
Ownership or business unit identifier associated with this purchase order.
List of purchase order item identifiers associated with this purchase order.
Canonical identifier for the purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
{ "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" }
Client associated with this purchase order, if applicable.
Ownership or business unit identifier associated with this purchase order.
List of purchase order item identifiers associated with this purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
- 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 PATCH \
'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 updated successfully
Client associated with this purchase order, if applicable.
Timestamp when the purchase order was created.
Calendar date of the purchase order.
Ownership or business unit identifier associated with this purchase order.
List of purchase order item identifiers associated with this purchase order.
Canonical identifier for the purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
{ "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" }
Client associated with this purchase order, if applicable.
Ownership or business unit identifier associated with this purchase order.
List of purchase order item identifiers associated with this purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
- 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.
Timestamp when the purchase order was created.
Calendar date of the purchase order.
Ownership or business unit identifier associated with this purchase order.
List of purchase order item identifiers associated with this purchase order.
Canonical identifier for the purchase order.
Reference to the shipping address resource.
Status of the purchase order.
Supplier from whom the order is placed.
{ "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>'