Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
Batch-level breakdown of the stock adjustment.
Identifier of the batch record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this batch record was created.
Example: "2025-01-01T00:00:00.000Z"
Quantity from this batch associated with the receive invoice item.
Identifier of the ledger account associated with this adjustment line, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the inventory location where the adjustment is applied.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the product being adjusted.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the parent stock adjustment.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/stock-adjustment-item/{stockAdjustmentItemId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/stock-adjustment-item/{stockAdjustmentItemId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/stock-adjustment-item/{stockAdjustmentItemId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"batches": [
{
"batchId": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2025-01-01T00:00:00.000Z",
"expiryDate": "2025-01-01",
"isActive": true,
"name": "string",
"quantity": 0,
"type": "string",
"updatedAt": "2025-01-01T00:00:00.000Z"
}
],
"currency": "string",
"extensions": {},
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": 0,
"stockAdjustmentId": "123e4567-e89b-12d3-a456-426614174000",
"unitPrice": "100.00"
}'Stock Adjustment Item replaced successfully
Batch-level breakdown of the stock adjustment.
Identifier of the batch record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when this batch record was created.
Example: "2025-01-01T00:00:00.000Z"
Quantity from this batch associated with the receive invoice item.
Timestamp when this stock adjustment item was created.
Example: "2025-01-01T00:00:00.000Z"
Identifier of the ledger account associated with this adjustment line, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the inventory location where the adjustment is applied.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the product being adjusted.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the parent stock adjustment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical identifier for this stock adjustment line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Unit price of the product at the time of adjustment, represented as a decimal string.
Example: "100.00"
Response
application/json
{ "batches": [ { … } ], "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "extensions": {}, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "locationId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": 0, "stockAdjustmentId": "123e4567-e89b-12d3-a456-426614174000", "stockAdjustmentItemId": "123e4567-e89b-12d3-a456-426614174000", "unitPrice": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/stock-adjustment-item/{stockAdjustmentItemId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/stock-adjustment-item/{stockAdjustmentItemId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/stock-adjustment-item/{stockAdjustmentItemId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'