Delete inventory product

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-product' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "extensions": {},
    "inventoryProductId": "123e4567-e89b-12d3-a456-426614174000",
    "isBatchTracked": true,
    "name": "string",
    "unitQuantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    }
  }'

Responses

Inventory Product created successfully

Bodyapplication/json

codestringrequired

Practice-specific product code or SKU.

createdAtstring(date-time)required

Timestamp when the inventory product record was created.

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

extensionsobjectrequired

Vendor- or practice-specific extensions.

inventoryProductIdstringrequired

Canonical identifier for the inventory product.

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

isBatchTrackedbooleanrequired

Indicates whether the product is batch/lot tracked.

namestringrequired

Human-readable name of the inventory product.

unitQuantityobjectrequired

unitQuantity.valuenumberrequired

Numeric value

unitQuantity.unitstringrequired

Unit of measure

unitQuantity.systemstring

Unit system URI

updatedAtstring(date-time)required

Timestamp when the inventory product record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "inventoryProductId": "123e4567-e89b-12d3-a456-426614174000",
  "isBatchTracked": true,
  "name": "string",
  "unitQuantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List inventory products

Request

Returns a paginated list of Inventory Products 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""code""name"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

codestring

Practice-specific product code or SKU.

isBatchTrackedboolean

Indicates whether the product is batch/lot tracked.

namestring

Human-readable name of the inventory product.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-product?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&code=string&isBatchTracked=true&name=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Inventory Products

Get inventory product

Request

Returns a single Inventory Product by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

inventoryProductIdstringrequired

Inventory Product unique identifier (UUID)

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

Responses

Inventory Product found

Bodyapplication/json

codestringrequired

Practice-specific product code or SKU.

createdAtstring(date-time)required

Timestamp when the inventory product record was created.

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

extensionsobjectrequired

Vendor- or practice-specific extensions.

inventoryProductIdstringrequired

Canonical identifier for the inventory product.

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

isBatchTrackedbooleanrequired

Indicates whether the product is batch/lot tracked.

namestringrequired

Human-readable name of the inventory product.

unitQuantityobjectrequired

unitQuantity.valuenumberrequired

Numeric value

unitQuantity.unitstringrequired

Unit of measure

unitQuantity.systemstring

Unit system URI

updatedAtstring(date-time)required

Timestamp when the inventory product record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "inventoryProductId": "123e4567-e89b-12d3-a456-426614174000",
  "isBatchTracked": true,
  "name": "string",
  "unitQuantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update inventory product

Request

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

Security

bearer

Path

siteIdnumberrequired

Site identifier

inventoryProductIdstringrequired

Inventory Product unique identifier (UUID)

Bodyapplication/jsonrequired

codestring

Practice-specific product code or SKU.

extensionsobject

Vendor- or practice-specific extensions.

isBatchTrackedboolean

Indicates whether the product is batch/lot tracked.

namestring

Human-readable name of the inventory product.

unitQuantityobject

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-product/{inventoryProductId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "extensions": {},
    "isBatchTracked": true,
    "name": "string",
    "unitQuantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    }
  }'

Responses

Inventory Product updated successfully

Bodyapplication/json

codestringrequired

Practice-specific product code or SKU.

createdAtstring(date-time)required

Timestamp when the inventory product record was created.

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

extensionsobjectrequired

Vendor- or practice-specific extensions.

inventoryProductIdstringrequired

Canonical identifier for the inventory product.

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

isBatchTrackedbooleanrequired

Indicates whether the product is batch/lot tracked.

namestringrequired

Human-readable name of the inventory product.

unitQuantityobjectrequired

unitQuantity.valuenumberrequired

Numeric value

unitQuantity.unitstringrequired

Unit of measure

unitQuantity.systemstring

Unit system URI

updatedAtstring(date-time)required

Timestamp when the inventory product record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "inventoryProductId": "123e4567-e89b-12d3-a456-426614174000",
  "isBatchTracked": true,
  "name": "string",
  "unitQuantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace inventory product

Request

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

Security

bearer

Path

siteIdnumberrequired

Site identifier

inventoryProductIdstringrequired

Inventory Product unique identifier (UUID)

Bodyapplication/jsonrequired

codestringrequired

Practice-specific product code or SKU.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isBatchTrackedbooleanrequired

Indicates whether the product is batch/lot tracked.

namestringrequired

Human-readable name of the inventory product.

unitQuantityobjectrequired

unitQuantity.valuenumberrequired

Numeric value

unitQuantity.unitstringrequired

Unit of measure

unitQuantity.systemstring

Unit system URI

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-product/{inventoryProductId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "extensions": {},
    "isBatchTracked": true,
    "name": "string",
    "unitQuantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    }
  }'

Responses

Inventory Product replaced successfully

Bodyapplication/json

codestringrequired

Practice-specific product code or SKU.

createdAtstring(date-time)required

Timestamp when the inventory product record was created.

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

extensionsobjectrequired

Vendor- or practice-specific extensions.

inventoryProductIdstringrequired

Canonical identifier for the inventory product.

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

isBatchTrackedbooleanrequired

Indicates whether the product is batch/lot tracked.

namestringrequired

Human-readable name of the inventory product.

unitQuantityobjectrequired

unitQuantity.valuenumberrequired

Numeric value

unitQuantity.unitstringrequired

Unit of measure

unitQuantity.systemstring

Unit system URI

updatedAtstring(date-time)required

Timestamp when the inventory product record was last updated.

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

Response

application/json

{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "inventoryProductId": "123e4567-e89b-12d3-a456-426614174000",
  "isBatchTracked": true,
  "name": "string",
  "unitQuantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z"
}