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
Indicates whether the pricing is defined directly by sell price or derived from markup on cost.
Enum"price""markup"
Net cost price for the product in the billing currency, as a decimal string.
Example: "100.00"
Additional dispense or handling fee applied per unit, as a decimal string.
Example: "100.00"
Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).
Identifier of the ownership or business entity context for this pricing.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the product this pricing applies to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Sell price excluding tax in the billing currency, as a decimal string.
Example: "100.00"
Tax amount applicable to the sellPrice, as a decimal string.
Example: "100.00"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-pricing/{productPricingId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/product-pricing/{productPricingId}
- 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/product-pricing/{productPricingId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"basedOn": "price",
"costPrice": "100.00",
"currency": "string",
"dispenseFee": "100.00",
"extensions": {},
"isActive": true,
"markup": 0,
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"sellPrice": "100.00",
"sellPriceTax": "100.00",
"taxRate": {}
}'Product Pricing replaced successfully
Indicates whether the pricing is defined directly by sell price or derived from markup on cost.
Enum"price""markup"
Net cost price for the product in the billing currency, as a decimal string.
Example: "100.00"
Timestamp when this pricing record was created.
Example: "2025-01-01T00:00:00.000Z"
Additional dispense or handling fee applied per unit, as a decimal string.
Example: "100.00"
Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).
Identifier of the ownership or business entity context for this pricing.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the product this pricing applies to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical identifier for this product pricing record.
Example: "123e4567-e89b-12d3-a456-426614174000"
Sell price excluding tax in the billing currency, as a decimal string.
Example: "100.00"
Tax amount applicable to the sellPrice, as a decimal string.
Example: "100.00"
Response
application/json
{ "basedOn": "price", "costPrice": "100.00", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "dispenseFee": "100.00", "extensions": {}, "isActive": true, "markup": 0, "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "productPricingId": "123e4567-e89b-12d3-a456-426614174000", "sellPrice": "100.00", "sellPriceTax": "100.00", "taxRate": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-pricing/{productPricingId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/product-pricing/{productPricingId}
- 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/product-pricing/{productPricingId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'