Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Replace inventory supplied product

Request

Fully replaces an existing Inventory Supplied Product. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

inventorySuppliedProductIdstringrequired

Inventory Supplied Product unique identifier (UUID)

Bodyapplication/jsonrequired
batchobjectrequired

Batch information for the supplied product.

extensionsobjectrequired

Vendor- or practice-specific extensions.

productIdstringrequired

Canonical identifier of the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
suppliedQuantitynumberrequired

Quantity of the product supplied. Must be strictly positive.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-supplied-product/{inventorySuppliedProductId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batch": {},
    "extensions": {},
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "suppliedQuantity": 0
  }'

Responses

Inventory Supplied Product replaced successfully

Bodyapplication/json
batchobjectrequired

Batch information for the supplied product.

createdAtstring(date-time)required

Timestamp when this supplied product record was created.

Example: "2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extensions.

inventorySuppliedProductIdstringrequired

Canonical identifier for this supplied product record.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstringrequired

Canonical identifier of the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
suppliedQuantitynumberrequired

Quantity of the product supplied. Must be strictly positive.

updatedAtstring(date-time)required

Timestamp when this supplied product record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "batch": {}, "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "inventorySuppliedProductId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "suppliedQuantity": 0, "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Permanently deletes a Inventory Supplied Product record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

inventorySuppliedProductIdstringrequired

Inventory Supplied Product unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-supplied-product/{inventorySuppliedProductId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Inventory Supplied Product deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations