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/

Address

Operations

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Create inventory requirement

Request

Creates a new Inventory Requirement record. Inventory Requirement resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
availableQuantitynumber

Current available quantity of the product at the specified location.

extensionsobject

Vendor- or practice-specific extensions to the inventory requirement.

inventoryRequirementIdstringrequired

Canonical identifier for this inventory requirement record.

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

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

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

Minimum quantity threshold at which the product should be reordered.

productCodestring

Practice-specific product code or SKU.

productDisplaystring

Human-readable name of the product for display purposes.

productIdstringrequired

Identifier of the product this inventory requirement applies to.

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

Target quantity to have on hand at the specified location.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-requirement' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "availableQuantity": 0,
    "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
  }'

Responses

Inventory Requirement created successfully

Bodyapplication/json
availableQuantitynumberrequired

Current available quantity of the product at the specified location.

createdAtstring(date-time)required

Timestamp when this inventory requirement record was created.

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

Vendor- or practice-specific extensions to the inventory requirement.

inventoryRequirementIdstringrequired

Canonical identifier for this inventory requirement record.

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

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

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

Minimum quantity threshold at which the product should be reordered.

productCodestringrequired

Practice-specific product code or SKU.

productDisplaystringrequired

Human-readable name of the product for display purposes.

productIdstringrequired

Identifier of the product this inventory requirement applies to.

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

Target quantity to have on hand at the specified location.

updatedAtstring(date-time)required

Timestamp when this inventory requirement record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

List inventory requirements

Request

Returns a paginated list of Inventory Requirements for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber>= 0

Page number (0-indexed)

Default 0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
sortBystring

Field to sort by

Enum"createdAt""updatedAt""availableQuantity""minimumQuantity""productCode""productDisplay""requiredQuantity"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
locationIdstring

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

Example: locationId=123e4567-e89b-12d3-a456-426614174000
productCodestring

Practice-specific product code or SKU.

productDisplaystring

Human-readable name of the product for display purposes.

productIdstring

Identifier of the product this inventory requirement applies to.

Example: productId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-requirement?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&locationId=123e4567-e89b-12d3-a456-426614174000&productCode=string&productDisplay=string&productId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Inventory Requirements

Get inventory requirement

Request

Returns a single Inventory Requirement by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

inventoryRequirementIdstringrequired

Inventory Requirement unique identifier (UUID)

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

Responses

Inventory Requirement found

Bodyapplication/json
availableQuantitynumberrequired

Current available quantity of the product at the specified location.

createdAtstring(date-time)required

Timestamp when this inventory requirement record was created.

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

Vendor- or practice-specific extensions to the inventory requirement.

inventoryRequirementIdstringrequired

Canonical identifier for this inventory requirement record.

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

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

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

Minimum quantity threshold at which the product should be reordered.

productCodestringrequired

Practice-specific product code or SKU.

productDisplaystringrequired

Human-readable name of the product for display purposes.

productIdstringrequired

Identifier of the product this inventory requirement applies to.

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

Target quantity to have on hand at the specified location.

updatedAtstring(date-time)required

Timestamp when this inventory requirement record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

Update inventory requirement

Request

Partially updates an existing Inventory Requirement. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

inventoryRequirementIdstringrequired

Inventory Requirement unique identifier (UUID)

Bodyapplication/jsonrequired
availableQuantitynumber

Current available quantity of the product at the specified location.

extensionsobject

Vendor- or practice-specific extensions to the inventory requirement.

locationIdstring

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

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

Minimum quantity threshold at which the product should be reordered.

productCodestring

Practice-specific product code or SKU.

productDisplaystring

Human-readable name of the product for display purposes.

productIdstring

Identifier of the product this inventory requirement applies to.

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

Target quantity to have on hand at the specified location.

curl -i -X PATCH \
  '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
  }'

Responses

Inventory Requirement updated successfully

Bodyapplication/json
availableQuantitynumberrequired

Current available quantity of the product at the specified location.

createdAtstring(date-time)required

Timestamp when this inventory requirement record was created.

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

Vendor- or practice-specific extensions to the inventory requirement.

inventoryRequirementIdstringrequired

Canonical identifier for this inventory requirement record.

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

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

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

Minimum quantity threshold at which the product should be reordered.

productCodestringrequired

Practice-specific product code or SKU.

productDisplaystringrequired

Human-readable name of the product for display purposes.

productIdstringrequired

Identifier of the product this inventory requirement applies to.

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

Target quantity to have on hand at the specified location.

updatedAtstring(date-time)required

Timestamp when this inventory requirement record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

Replace inventory requirement

Request

Fully replaces an existing Inventory Requirement. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

inventoryRequirementIdstringrequired

Inventory Requirement unique identifier (UUID)

Bodyapplication/jsonrequired
availableQuantitynumberrequired

Current available quantity of the product at the specified location.

extensionsobjectrequired

Vendor- or practice-specific extensions to the inventory requirement.

locationIdstringrequired

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

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

Minimum quantity threshold at which the product should be reordered.

productCodestringrequired

Practice-specific product code or SKU.

productDisplaystringrequired

Human-readable name of the product for display purposes.

productIdstringrequired

Identifier of the product this inventory requirement applies to.

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

Target quantity to have on hand at the specified location.

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
  }'

Responses

Inventory Requirement replaced successfully

Bodyapplication/json
availableQuantitynumberrequired

Current available quantity of the product at the specified location.

createdAtstring(date-time)required

Timestamp when this inventory requirement record was created.

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

Vendor- or practice-specific extensions to the inventory requirement.

inventoryRequirementIdstringrequired

Canonical identifier for this inventory requirement record.

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

Identifier of the location (e.g., clinic, warehouse) where this requirement applies.

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

Minimum quantity threshold at which the product should be reordered.

productCodestringrequired

Practice-specific product code or SKU.

productDisplaystringrequired

Human-readable name of the product for display purposes.

productIdstringrequired

Identifier of the product this inventory requirement applies to.

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

Target quantity to have on hand at the specified location.

updatedAtstring(date-time)required

Timestamp when this inventory requirement record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

Delete inventory requirement

Request

Permanently deletes a Inventory Requirement record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

inventoryRequirementIdstringrequired

Inventory Requirement unique identifier (UUID)

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>'

Responses

Inventory Requirement deleted successfully

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations