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

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

Create product supplier

Request

Creates a new Product Supplier record. Product Supplier resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
contractPricestringrequired

Contracted unit price from this supplier, as a decimal string.

Example: "100.00"
expectedPricestringrequired

Expected unit price from this supplier, as a decimal string.

Example: "100.00"
extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this product-supplier relationship is currently active.

isDefaultSupplierbooleanrequired

Whether this supplier is the default supplier for the product.

lastSupplierUpdateAtstring or null

Timestamp of the last update received from the supplier for this product, if known.

Example: "2025-01-01T00:00:00.000Z"
listPricestring or null

Supplier list price, as a decimal string. May be null if unknown.

Example: "100.00"
productIdstringrequired

Reference to the product associated with this supplier relationship.

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

Canonical identifier for this product-supplier relationship.

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

Supplier-specific code or SKU for this product.

supplierContactIdstringrequired

Reference to the supplier contact entity.

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

Reference to the tax rate applied to this product when supplied by this supplier.

Example: "123e4567-e89b-12d3-a456-426614174000"
unitOfMeasurestring or null

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

unitsPerOuternumberrequired

Number of sellable units contained in one outer/pack from this supplier.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-supplier' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contractPrice": "100.00",
    "expectedPrice": "100.00",
    "extensions": {},
    "isActive": true,
    "isDefaultSupplier": true,
    "lastSupplierUpdateAt": "2025-01-01T00:00:00.000Z",
    "listPrice": "100.00",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierCode": "string",
    "supplierContactId": "123e4567-e89b-12d3-a456-426614174000",
    "taxRateId": "123e4567-e89b-12d3-a456-426614174000",
    "unitOfMeasure": "string",
    "unitsPerOuter": 0
  }'

Responses

Product Supplier created successfully

Bodyapplication/json
contractPricestringrequired

Contracted unit price from this supplier, as a decimal string.

Example: "100.00"
createdAtstring(date-time)required

Timestamp when this product-supplier record was created.

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

Expected unit price from this supplier, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this product-supplier relationship is currently active.

isDefaultSupplierbooleanrequired

Whether this supplier is the default supplier for the product.

lastSupplierUpdateAtstring or null(date-time)required

Timestamp of the last update received from the supplier for this product, if known.

Example: "2025-01-01T00:00:00.000Z"
listPricestring or nullrequired

Supplier list price, as a decimal string. May be null if unknown.

Example: "100.00"
productIdstringrequired

Reference to the product associated with this supplier relationship.

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

Canonical identifier for this product-supplier relationship.

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

Supplier-specific code or SKU for this product.

supplierContactIdstringrequired

Reference to the supplier contact entity.

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

Reference to the tax rate applied to this product when supplied by this supplier.

Example: "123e4567-e89b-12d3-a456-426614174000"
unitOfMeasurestring or nullrequired

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

unitsPerOuternumberrequired

Number of sellable units contained in one outer/pack from this supplier.

updatedAtstring(date-time)required

Timestamp when this product-supplier record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "contractPrice": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expectedPrice": "100.00",
  "extensions": {},
  "isActive": true,
  "isDefaultSupplier": true,
  "lastSupplierUpdateAt": "2025-01-01T00:00:00.000Z",
  "listPrice": "100.00",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "supplierContactId": "123e4567-e89b-12d3-a456-426614174000",
  "taxRateId": "123e4567-e89b-12d3-a456-426614174000",
  "unitOfMeasure": "string",
  "unitsPerOuter": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List product suppliers

Request

Returns a paginated list of Product Suppliers 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""contractPrice""expectedPrice""lastSupplierUpdateAt""listPrice""supplierCode""unitOfMeasure""unitsPerOuter"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
isActiveboolean

Whether this product-supplier relationship is currently active.

isDefaultSupplierboolean

Whether this supplier is the default supplier for the product.

productIdstring

Reference to the product associated with this supplier relationship.

Example: productId=123e4567-e89b-12d3-a456-426614174000
supplierCodestring

Supplier-specific code or SKU for this product.

supplierContactIdstring

Reference to the supplier contact entity.

Example: supplierContactId=123e4567-e89b-12d3-a456-426614174000
taxRateIdstring

Reference to the tax rate applied to this product when supplied by this supplier.

Example: taxRateId=123e4567-e89b-12d3-a456-426614174000
unitOfMeasurestring

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-supplier?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&isActive=true&isDefaultSupplier=true&productId=123e4567-e89b-12d3-a456-426614174000&supplierCode=string&supplierContactId=123e4567-e89b-12d3-a456-426614174000&taxRateId=123e4567-e89b-12d3-a456-426614174000&unitOfMeasure=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Product Suppliers

Get product supplier

Request

Returns a single Product Supplier by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productSupplierIdstringrequired

Product Supplier unique identifier (UUID)

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

Responses

Product Supplier found

Bodyapplication/json
contractPricestringrequired

Contracted unit price from this supplier, as a decimal string.

Example: "100.00"
createdAtstring(date-time)required

Timestamp when this product-supplier record was created.

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

Expected unit price from this supplier, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this product-supplier relationship is currently active.

isDefaultSupplierbooleanrequired

Whether this supplier is the default supplier for the product.

lastSupplierUpdateAtstring or null(date-time)required

Timestamp of the last update received from the supplier for this product, if known.

Example: "2025-01-01T00:00:00.000Z"
listPricestring or nullrequired

Supplier list price, as a decimal string. May be null if unknown.

Example: "100.00"
productIdstringrequired

Reference to the product associated with this supplier relationship.

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

Canonical identifier for this product-supplier relationship.

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

Supplier-specific code or SKU for this product.

supplierContactIdstringrequired

Reference to the supplier contact entity.

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

Reference to the tax rate applied to this product when supplied by this supplier.

Example: "123e4567-e89b-12d3-a456-426614174000"
unitOfMeasurestring or nullrequired

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

unitsPerOuternumberrequired

Number of sellable units contained in one outer/pack from this supplier.

updatedAtstring(date-time)required

Timestamp when this product-supplier record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "contractPrice": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expectedPrice": "100.00",
  "extensions": {},
  "isActive": true,
  "isDefaultSupplier": true,
  "lastSupplierUpdateAt": "2025-01-01T00:00:00.000Z",
  "listPrice": "100.00",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "supplierContactId": "123e4567-e89b-12d3-a456-426614174000",
  "taxRateId": "123e4567-e89b-12d3-a456-426614174000",
  "unitOfMeasure": "string",
  "unitsPerOuter": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update product supplier

Request

Partially updates an existing Product Supplier. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productSupplierIdstringrequired

Product Supplier unique identifier (UUID)

Bodyapplication/jsonrequired
contractPricestring

Contracted unit price from this supplier, as a decimal string.

Example: "100.00"
expectedPricestring

Expected unit price from this supplier, as a decimal string.

Example: "100.00"
extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this product-supplier relationship is currently active.

isDefaultSupplierboolean

Whether this supplier is the default supplier for the product.

lastSupplierUpdateAtstring or null

Timestamp of the last update received from the supplier for this product, if known.

Example: "2025-01-01T00:00:00.000Z"
listPricestring or null

Supplier list price, as a decimal string. May be null if unknown.

Example: "100.00"
productIdstring

Reference to the product associated with this supplier relationship.

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

Supplier-specific code or SKU for this product.

supplierContactIdstring

Reference to the supplier contact entity.

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

Reference to the tax rate applied to this product when supplied by this supplier.

Example: "123e4567-e89b-12d3-a456-426614174000"
unitOfMeasurestring or null

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

unitsPerOuternumber

Number of sellable units contained in one outer/pack from this supplier.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-supplier/{productSupplierId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contractPrice": "100.00",
    "expectedPrice": "100.00",
    "extensions": {},
    "isActive": true,
    "isDefaultSupplier": true,
    "lastSupplierUpdateAt": "2025-01-01T00:00:00.000Z",
    "listPrice": "100.00",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierCode": "string",
    "supplierContactId": "123e4567-e89b-12d3-a456-426614174000",
    "taxRateId": "123e4567-e89b-12d3-a456-426614174000",
    "unitOfMeasure": "string",
    "unitsPerOuter": 0
  }'

Responses

Product Supplier updated successfully

Bodyapplication/json
contractPricestringrequired

Contracted unit price from this supplier, as a decimal string.

Example: "100.00"
createdAtstring(date-time)required

Timestamp when this product-supplier record was created.

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

Expected unit price from this supplier, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this product-supplier relationship is currently active.

isDefaultSupplierbooleanrequired

Whether this supplier is the default supplier for the product.

lastSupplierUpdateAtstring or null(date-time)required

Timestamp of the last update received from the supplier for this product, if known.

Example: "2025-01-01T00:00:00.000Z"
listPricestring or nullrequired

Supplier list price, as a decimal string. May be null if unknown.

Example: "100.00"
productIdstringrequired

Reference to the product associated with this supplier relationship.

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

Canonical identifier for this product-supplier relationship.

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

Supplier-specific code or SKU for this product.

supplierContactIdstringrequired

Reference to the supplier contact entity.

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

Reference to the tax rate applied to this product when supplied by this supplier.

Example: "123e4567-e89b-12d3-a456-426614174000"
unitOfMeasurestring or nullrequired

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

unitsPerOuternumberrequired

Number of sellable units contained in one outer/pack from this supplier.

updatedAtstring(date-time)required

Timestamp when this product-supplier record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "contractPrice": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expectedPrice": "100.00",
  "extensions": {},
  "isActive": true,
  "isDefaultSupplier": true,
  "lastSupplierUpdateAt": "2025-01-01T00:00:00.000Z",
  "listPrice": "100.00",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "supplierContactId": "123e4567-e89b-12d3-a456-426614174000",
  "taxRateId": "123e4567-e89b-12d3-a456-426614174000",
  "unitOfMeasure": "string",
  "unitsPerOuter": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace product supplier

Request

Fully replaces an existing Product Supplier. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productSupplierIdstringrequired

Product Supplier unique identifier (UUID)

Bodyapplication/jsonrequired
contractPricestringrequired

Contracted unit price from this supplier, as a decimal string.

Example: "100.00"
expectedPricestringrequired

Expected unit price from this supplier, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this product-supplier relationship is currently active.

isDefaultSupplierbooleanrequired

Whether this supplier is the default supplier for the product.

lastSupplierUpdateAtstring or null

Timestamp of the last update received from the supplier for this product, if known.

Example: "2025-01-01T00:00:00.000Z"
listPricestring or null

Supplier list price, as a decimal string. May be null if unknown.

Example: "100.00"
productIdstringrequired

Reference to the product associated with this supplier relationship.

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

Supplier-specific code or SKU for this product.

supplierContactIdstringrequired

Reference to the supplier contact entity.

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

Reference to the tax rate applied to this product when supplied by this supplier.

Example: "123e4567-e89b-12d3-a456-426614174000"
unitOfMeasurestring or null

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

unitsPerOuternumberrequired

Number of sellable units contained in one outer/pack from this supplier.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-supplier/{productSupplierId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contractPrice": "100.00",
    "expectedPrice": "100.00",
    "extensions": {},
    "isActive": true,
    "isDefaultSupplier": true,
    "lastSupplierUpdateAt": "2025-01-01T00:00:00.000Z",
    "listPrice": "100.00",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierCode": "string",
    "supplierContactId": "123e4567-e89b-12d3-a456-426614174000",
    "taxRateId": "123e4567-e89b-12d3-a456-426614174000",
    "unitOfMeasure": "string",
    "unitsPerOuter": 0
  }'

Responses

Product Supplier replaced successfully

Bodyapplication/json
contractPricestringrequired

Contracted unit price from this supplier, as a decimal string.

Example: "100.00"
createdAtstring(date-time)required

Timestamp when this product-supplier record was created.

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

Expected unit price from this supplier, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this product-supplier relationship is currently active.

isDefaultSupplierbooleanrequired

Whether this supplier is the default supplier for the product.

lastSupplierUpdateAtstring or null(date-time)required

Timestamp of the last update received from the supplier for this product, if known.

Example: "2025-01-01T00:00:00.000Z"
listPricestring or nullrequired

Supplier list price, as a decimal string. May be null if unknown.

Example: "100.00"
productIdstringrequired

Reference to the product associated with this supplier relationship.

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

Canonical identifier for this product-supplier relationship.

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

Supplier-specific code or SKU for this product.

supplierContactIdstringrequired

Reference to the supplier contact entity.

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

Reference to the tax rate applied to this product when supplied by this supplier.

Example: "123e4567-e89b-12d3-a456-426614174000"
unitOfMeasurestring or nullrequired

Unit of measure used by this supplier for pricing and ordering (e.g., 'box', 'vial').

unitsPerOuternumberrequired

Number of sellable units contained in one outer/pack from this supplier.

updatedAtstring(date-time)required

Timestamp when this product-supplier record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "contractPrice": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expectedPrice": "100.00",
  "extensions": {},
  "isActive": true,
  "isDefaultSupplier": true,
  "lastSupplierUpdateAt": "2025-01-01T00:00:00.000Z",
  "listPrice": "100.00",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "supplierContactId": "123e4567-e89b-12d3-a456-426614174000",
  "taxRateId": "123e4567-e89b-12d3-a456-426614174000",
  "unitOfMeasure": "string",
  "unitsPerOuter": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete product supplier

Request

Permanently deletes a Product Supplier record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

productSupplierIdstringrequired

Product Supplier unique identifier (UUID)

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

Responses

Product Supplier deleted successfully

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