Replace product minimum stock

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-minimum-stock' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "effectiveEndDate": "2025-01-01",
    "effectiveStartDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "locationOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
    "minimumStockQuantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "productMinimumStockId": "123e4567-e89b-12d3-a456-426614174000",
    "reorderQuantityExpression": "string",
    "shouldReorderToMaxLevel": true
  }'

Responses

Product Minimum Stock created successfully

Bodyapplication/json

createdAtstring(date-time)required

Timestamp when this record was created.

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

effectiveEndDatestring(date-time)required

Calendar date when this minimum stock configuration stops being effective, if seasonally constrained.

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

effectiveStartDatestring(date-time)required

Calendar date when this minimum stock configuration becomes effective, if seasonally constrained.

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

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this minimum stock configuration is currently active.

locationOwnershipIdstringrequired

Identifier for the location/ownership context this minimum stock applies to (e.g., clinic location or inventory owner).

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

minimumStockQuantityobjectrequired

minimumStockQuantity.valuenumberrequired

Numeric value

minimumStockQuantity.unitstringrequired

Unit of measure

minimumStockQuantity.systemstring

Unit system URI

productIdstringrequired

Reference to the product this minimum stock configuration applies to.

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

productMinimumStockIdstringrequired

Canonical identifier for this product minimum stock configuration.

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

reorderQuantityExpressionstringrequired

Expression or value used to calculate reorder quantity, interpreted in conjunction with shouldReorderToMaxLevel and current quantity on hand.

shouldReorderToMaxLevelbooleanrequired

If true, reorder so that quantity on hand reaches the target maximum level; if false, reorder at least the suggested quantity.

updatedAtstring(date-time)required

Timestamp when this record was last updated.

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

Response

application/json

{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "effectiveEndDate": "2025-01-01T00:00:00Z",
  "effectiveStartDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "locationOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
  "minimumStockQuantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productMinimumStockId": "123e4567-e89b-12d3-a456-426614174000",
  "reorderQuantityExpression": "string",
  "shouldReorderToMaxLevel": true,
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List product minimum stocks

Request

Returns a paginated list of Product Minimum Stocks 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""effectiveEndDate""effectiveStartDate""reorderQuantityExpression"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

isActiveboolean

Whether this minimum stock configuration is currently active.

locationOwnershipIdstring

Identifier for the location/ownership context this minimum stock applies to (e.g., clinic location or inventory owner).

Example: locationOwnershipId=123e4567-e89b-12d3-a456-426614174000

productIdstring

Reference to the product this minimum stock configuration applies to.

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

reorderQuantityExpressionstring

Expression or value used to calculate reorder quantity, interpreted in conjunction with shouldReorderToMaxLevel and current quantity on hand.

shouldReorderToMaxLevelboolean

If true, reorder so that quantity on hand reaches the target maximum level; if false, reorder at least the suggested quantity.

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

Responses

Paginated list of Product Minimum Stocks

Get product minimum stock

Request

Returns a single Product Minimum Stock by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

productMinimumStockIdstringrequired

Product Minimum Stock unique identifier (UUID)

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

Responses

Product Minimum Stock found

Bodyapplication/json

createdAtstring(date-time)required

Timestamp when this record was created.

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

effectiveEndDatestring(date-time)required

Calendar date when this minimum stock configuration stops being effective, if seasonally constrained.

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

effectiveStartDatestring(date-time)required

Calendar date when this minimum stock configuration becomes effective, if seasonally constrained.

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

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this minimum stock configuration is currently active.

locationOwnershipIdstringrequired

Identifier for the location/ownership context this minimum stock applies to (e.g., clinic location or inventory owner).

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

minimumStockQuantityobjectrequired

minimumStockQuantity.valuenumberrequired

Numeric value

minimumStockQuantity.unitstringrequired

Unit of measure

minimumStockQuantity.systemstring

Unit system URI

productIdstringrequired

Reference to the product this minimum stock configuration applies to.

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

productMinimumStockIdstringrequired

Canonical identifier for this product minimum stock configuration.

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

reorderQuantityExpressionstringrequired

Expression or value used to calculate reorder quantity, interpreted in conjunction with shouldReorderToMaxLevel and current quantity on hand.

shouldReorderToMaxLevelbooleanrequired

If true, reorder so that quantity on hand reaches the target maximum level; if false, reorder at least the suggested quantity.

updatedAtstring(date-time)required

Timestamp when this record was last updated.

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

Response

application/json

{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "effectiveEndDate": "2025-01-01T00:00:00Z",
  "effectiveStartDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "locationOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
  "minimumStockQuantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productMinimumStockId": "123e4567-e89b-12d3-a456-426614174000",
  "reorderQuantityExpression": "string",
  "shouldReorderToMaxLevel": true,
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update product minimum stock

Request

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

Security

bearer

Path

siteIdnumberrequired

Site identifier

productMinimumStockIdstringrequired

Product Minimum Stock unique identifier (UUID)

Bodyapplication/jsonrequired

effectiveEndDatestring

Calendar date when this minimum stock configuration stops being effective, if seasonally constrained.

Example: "2025-01-01"

effectiveStartDatestring

Calendar date when this minimum stock configuration becomes effective, if seasonally constrained.

Example: "2025-01-01"

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this minimum stock configuration is currently active.

locationOwnershipIdstring

Identifier for the location/ownership context this minimum stock applies to (e.g., clinic location or inventory owner).

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

minimumStockQuantityobject

productIdstring

Reference to the product this minimum stock configuration applies to.

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

reorderQuantityExpressionstring

Expression or value used to calculate reorder quantity, interpreted in conjunction with shouldReorderToMaxLevel and current quantity on hand.

shouldReorderToMaxLevelboolean

If true, reorder so that quantity on hand reaches the target maximum level; if false, reorder at least the suggested quantity.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-minimum-stock/{productMinimumStockId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "effectiveEndDate": "2025-01-01",
    "effectiveStartDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "locationOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
    "minimumStockQuantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "reorderQuantityExpression": "string",
    "shouldReorderToMaxLevel": true
  }'

Responses

Product Minimum Stock updated successfully

Bodyapplication/json

createdAtstring(date-time)required

Timestamp when this record was created.

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

effectiveEndDatestring(date-time)required

Calendar date when this minimum stock configuration stops being effective, if seasonally constrained.

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

effectiveStartDatestring(date-time)required

Calendar date when this minimum stock configuration becomes effective, if seasonally constrained.

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

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this minimum stock configuration is currently active.

locationOwnershipIdstringrequired

Identifier for the location/ownership context this minimum stock applies to (e.g., clinic location or inventory owner).

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

minimumStockQuantityobjectrequired

minimumStockQuantity.valuenumberrequired

Numeric value

minimumStockQuantity.unitstringrequired

Unit of measure

minimumStockQuantity.systemstring

Unit system URI

productIdstringrequired

Reference to the product this minimum stock configuration applies to.

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

productMinimumStockIdstringrequired

Canonical identifier for this product minimum stock configuration.

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

reorderQuantityExpressionstringrequired

Expression or value used to calculate reorder quantity, interpreted in conjunction with shouldReorderToMaxLevel and current quantity on hand.

shouldReorderToMaxLevelbooleanrequired

If true, reorder so that quantity on hand reaches the target maximum level; if false, reorder at least the suggested quantity.

updatedAtstring(date-time)required

Timestamp when this record was last updated.

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

Response

application/json

{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "effectiveEndDate": "2025-01-01T00:00:00Z",
  "effectiveStartDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "locationOwnershipId": "123e4567-e89b-12d3-a456-426614174000",
  "minimumStockQuantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productMinimumStockId": "123e4567-e89b-12d3-a456-426614174000",
  "reorderQuantityExpression": "string",
  "shouldReorderToMaxLevel": true,
  "updatedAt": "2025-01-01T00:00:00.000Z"
}