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

Create inventory message

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
authorobject

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstring

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Vendor- or practice-specific extensions.

isPinnedboolean

Whether this message is pinned or highlighted in the UI.

messageIdstringrequired

Canonical unique identifier for this message.

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

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)

Intended recipients of the message.

relatedInventoryItemIdstring

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

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

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstring

Short, human-readable subject or title of the message.

tagsArray of strings

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-message' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "author": {},
    "body": "string",
    "channel": "internal",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isPinned": true,
    "messageId": "123e4567-e89b-12d3-a456-426614174000",
    "priority": "low",
    "readAt": "2025-01-01T00:00:00.000Z",
    "recipients": [
      {
        "display": "string",
        "role": "string",
        "userId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "sentAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "subject": "string",
    "tags": [
      "string"
    ],
    "type": "system"
  }'

Responses

Inventory Message created successfully

Bodyapplication/json
authorobjectrequired

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the message was created.

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

Vendor- or practice-specific extensions.

isPinnedbooleanrequired

Whether this message is pinned or highlighted in the UI.

messageIdstringrequired

Canonical unique identifier for this message.

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

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring(date-time)required

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)required

Intended recipients of the message.

recipients[].​displaystring

Human-readable display name for the recipient.

recipients[].​rolestring

Recipient role or group, if addressed to a role rather than a specific user.

recipients[].​userIdstring

Recipient user identifier, if applicable.

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

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
sentAtstring(date-time)required

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstringrequired

Short, human-readable subject or title of the message.

tagsArray of stringsrequired

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
updatedAtstring(date-time)required

Timestamp when the message was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "author": {},
  "body": "string",
  "channel": "internal",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isPinned": true,
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "recipients": [
    { … }
  ],
  "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "tags": [
    "string"
  ],
  "type": "system",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List inventory messages

Request

Returns a paginated list of Inventory Messages 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""body""readAt""sentAt""subject"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
bodystring

Full content of the message.

channelstring

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: clientProvidedId=123e4567-e89b-12d3-a456-426614174000
isPinnedboolean

Whether this message is pinned or highlighted in the UI.

prioritystring

Relative importance of the message.

Enum"low""normal""high""urgent"
relatedInventoryItemIdstring

Inventory item this message is primarily about, if applicable.

Example: relatedInventoryItemId=123e4567-e89b-12d3-a456-426614174000
relatedPurchaseOrderIdstring

Purchase order this message is related to, if applicable.

Example: relatedPurchaseOrderId=123e4567-e89b-12d3-a456-426614174000
relatedSupplierIdstring

Supplier this message is related to, if applicable.

Example: relatedSupplierId=123e4567-e89b-12d3-a456-426614174000
statusstring

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstring

Short, human-readable subject or title of the message.

typestring

High-level classification of the message.

Enum"system""user""integration""alert""note"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-message?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&body=string&channel=internal&clientProvidedId=123e4567-e89b-12d3-a456-426614174000&isPinned=true&priority=low&relatedInventoryItemId=123e4567-e89b-12d3-a456-426614174000&relatedPurchaseOrderId=123e4567-e89b-12d3-a456-426614174000&relatedSupplierId=123e4567-e89b-12d3-a456-426614174000&status=draft&subject=string&type=system' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Inventory Messages

Get inventory message

Request

Returns a single Inventory Message by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Inventory Message unique identifier (UUID)

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

Responses

Inventory Message found

Bodyapplication/json
authorobjectrequired

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the message was created.

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

Vendor- or practice-specific extensions.

isPinnedbooleanrequired

Whether this message is pinned or highlighted in the UI.

messageIdstringrequired

Canonical unique identifier for this message.

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

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring(date-time)required

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)required

Intended recipients of the message.

recipients[].​displaystring

Human-readable display name for the recipient.

recipients[].​rolestring

Recipient role or group, if addressed to a role rather than a specific user.

recipients[].​userIdstring

Recipient user identifier, if applicable.

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

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
sentAtstring(date-time)required

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstringrequired

Short, human-readable subject or title of the message.

tagsArray of stringsrequired

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
updatedAtstring(date-time)required

Timestamp when the message was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "author": {},
  "body": "string",
  "channel": "internal",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isPinned": true,
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "recipients": [
    { … }
  ],
  "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "tags": [
    "string"
  ],
  "type": "system",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update inventory message

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Inventory Message unique identifier (UUID)

Bodyapplication/jsonrequired
authorobject

Author of the message (user or system).

bodystring

Full content of the message.

channelstring

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Vendor- or practice-specific extensions.

isPinnedboolean

Whether this message is pinned or highlighted in the UI.

prioritystring

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)

Intended recipients of the message.

relatedInventoryItemIdstring

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

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

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstring

Short, human-readable subject or title of the message.

tagsArray of strings

Free-form tags or labels for filtering and search.

typestring

High-level classification of the message.

Enum"system""user""integration""alert""note"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-message/{messageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "author": {},
    "body": "string",
    "channel": "internal",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isPinned": true,
    "priority": "low",
    "readAt": "2025-01-01T00:00:00.000Z",
    "recipients": [
      {
        "display": "string",
        "role": "string",
        "userId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "sentAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "subject": "string",
    "tags": [
      "string"
    ],
    "type": "system"
  }'

Responses

Inventory Message updated successfully

Bodyapplication/json
authorobjectrequired

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the message was created.

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

Vendor- or practice-specific extensions.

isPinnedbooleanrequired

Whether this message is pinned or highlighted in the UI.

messageIdstringrequired

Canonical unique identifier for this message.

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

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring(date-time)required

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)required

Intended recipients of the message.

recipients[].​displaystring

Human-readable display name for the recipient.

recipients[].​rolestring

Recipient role or group, if addressed to a role rather than a specific user.

recipients[].​userIdstring

Recipient user identifier, if applicable.

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

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
sentAtstring(date-time)required

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstringrequired

Short, human-readable subject or title of the message.

tagsArray of stringsrequired

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
updatedAtstring(date-time)required

Timestamp when the message was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "author": {},
  "body": "string",
  "channel": "internal",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isPinned": true,
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "recipients": [
    { … }
  ],
  "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "tags": [
    "string"
  ],
  "type": "system",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace inventory message

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Inventory Message unique identifier (UUID)

Bodyapplication/jsonrequired
authorobjectrequired

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system correlation.

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

Vendor- or practice-specific extensions.

isPinnedbooleanrequired

Whether this message is pinned or highlighted in the UI.

prioritystringrequired

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstringrequired

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)required

Intended recipients of the message.

recipients[].​displaystring

Human-readable display name for the recipient.

recipients[].​rolestring

Recipient role or group, if addressed to a role rather than a specific user.

recipients[].​userIdstring

Recipient user identifier, if applicable.

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

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

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

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstringrequired

Short, human-readable subject or title of the message.

tagsArray of stringsrequired

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-message/{messageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "author": {},
    "body": "string",
    "channel": "internal",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isPinned": true,
    "priority": "low",
    "readAt": "2025-01-01T00:00:00.000Z",
    "recipients": [
      {
        "display": "string",
        "role": "string",
        "userId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "sentAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "subject": "string",
    "tags": [
      "string"
    ],
    "type": "system"
  }'

Responses

Inventory Message replaced successfully

Bodyapplication/json
authorobjectrequired

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system correlation.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the message was created.

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

Vendor- or practice-specific extensions.

isPinnedbooleanrequired

Whether this message is pinned or highlighted in the UI.

messageIdstringrequired

Canonical unique identifier for this message.

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

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring(date-time)required

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)required

Intended recipients of the message.

recipients[].​displaystring

Human-readable display name for the recipient.

recipients[].​rolestring

Recipient role or group, if addressed to a role rather than a specific user.

recipients[].​userIdstring

Recipient user identifier, if applicable.

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

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
sentAtstring(date-time)required

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstringrequired

Short, human-readable subject or title of the message.

tagsArray of stringsrequired

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
updatedAtstring(date-time)required

Timestamp when the message was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "author": {},
  "body": "string",
  "channel": "internal",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isPinned": true,
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "recipients": [
    { … }
  ],
  "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "tags": [
    "string"
  ],
  "type": "system",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete inventory message

Request

Permanently deletes a Inventory Message record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Inventory Message unique identifier (UUID)

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

Responses

Inventory Message deleted successfully

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

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