Delete product pricing

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/product-pricing' \
  -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",
    "productPricingId": "123e4567-e89b-12d3-a456-426614174000",
    "sellPrice": "100.00",
    "sellPriceTax": "100.00",
    "taxRate": {}
  }'

Responses

Product Pricing created successfully

Bodyapplication/json

basedOnstringrequired

Indicates whether the pricing is defined directly by sell price or derived from markup on cost.

Enum"price""markup"

costPricestringrequired

Net cost price for the product in the billing currency, as a decimal string.

Example: "100.00"

createdAtstring(date-time)required

Timestamp when this pricing record was created.

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

currencystringrequired

ISO 4217 currency code for all monetary amounts in this record.

dispenseFeestringrequired

Additional dispense or handling fee applied per unit, as a decimal string.

Example: "100.00"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this pricing record is currently active.

markupnumberrequired

Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).

ownershipIdstringrequired

Identifier of the ownership or business entity context for this pricing.

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

productIdstringrequired

Identifier of the product this pricing applies to.

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

productPricingIdstringrequired

Canonical identifier for this product pricing record.

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

sellPricestringrequired

Sell price excluding tax in the billing currency, as a decimal string.

Example: "100.00"

sellPriceTaxstringrequired

Tax amount applicable to the sellPrice, as a decimal string.

Example: "100.00"

taxRateobjectrequired

Tax rate applied to this product pricing.

updatedAtstring(date-time)required

Timestamp when this pricing record was last updated.

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

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"
}

List product pricings

Request

Returns a paginated list of Product Pricings 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""costPrice""currency""dispenseFee""markup""sellPrice""sellPriceTax"

sortOrderstring

Sort order

Default "asc"

Enum"asc""desc"

basedOnstring

Indicates whether the pricing is defined directly by sell price or derived from markup on cost.

Enum"price""markup"

currencystring

ISO 4217 currency code for all monetary amounts in this record.

isActiveboolean

Whether this pricing record is currently active.

ownershipIdstring

Identifier of the ownership or business entity context for this pricing.

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

productIdstring

Identifier of the product this pricing applies to.

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

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

Responses

Paginated list of Product Pricings

Get product pricing

Request

Returns a single Product Pricing by its unique identifier.

Security

bearer

Path

siteIdnumberrequired

Site identifier

productPricingIdstringrequired

Product Pricing unique identifier (UUID)

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

Responses

Product Pricing found

Bodyapplication/json

basedOnstringrequired

Indicates whether the pricing is defined directly by sell price or derived from markup on cost.

Enum"price""markup"

costPricestringrequired

Net cost price for the product in the billing currency, as a decimal string.

Example: "100.00"

createdAtstring(date-time)required

Timestamp when this pricing record was created.

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

currencystringrequired

ISO 4217 currency code for all monetary amounts in this record.

dispenseFeestringrequired

Additional dispense or handling fee applied per unit, as a decimal string.

Example: "100.00"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this pricing record is currently active.

markupnumberrequired

Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).

ownershipIdstringrequired

Identifier of the ownership or business entity context for this pricing.

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

productIdstringrequired

Identifier of the product this pricing applies to.

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

productPricingIdstringrequired

Canonical identifier for this product pricing record.

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

sellPricestringrequired

Sell price excluding tax in the billing currency, as a decimal string.

Example: "100.00"

sellPriceTaxstringrequired

Tax amount applicable to the sellPrice, as a decimal string.

Example: "100.00"

taxRateobjectrequired

Tax rate applied to this product pricing.

updatedAtstring(date-time)required

Timestamp when this pricing record was last updated.

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

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"
}

Update product pricing

Request

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

Security

bearer

Path

siteIdnumberrequired

Site identifier

productPricingIdstringrequired

Product Pricing unique identifier (UUID)

Bodyapplication/jsonrequired

basedOnstring

Indicates whether the pricing is defined directly by sell price or derived from markup on cost.

Enum"price""markup"

costPricestring

Net cost price for the product in the billing currency, as a decimal string.

Example: "100.00"

currencystring

ISO 4217 currency code for all monetary amounts in this record.

dispenseFeestring

Additional dispense or handling fee applied per unit, as a decimal string.

Example: "100.00"

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this pricing record is currently active.

markupnumber

Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).

ownershipIdstring

Identifier of the ownership or business entity context for this pricing.

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

productIdstring

Identifier of the product this pricing applies to.

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

sellPricestring

Sell price excluding tax in the billing currency, as a decimal string.

Example: "100.00"

sellPriceTaxstring

Tax amount applicable to the sellPrice, as a decimal string.

Example: "100.00"

taxRateobject

Tax rate applied to this product pricing.

curl -i -X PATCH \
  '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": {}
  }'

Responses

Product Pricing updated successfully

Bodyapplication/json

basedOnstringrequired

Indicates whether the pricing is defined directly by sell price or derived from markup on cost.

Enum"price""markup"

costPricestringrequired

Net cost price for the product in the billing currency, as a decimal string.

Example: "100.00"

createdAtstring(date-time)required

Timestamp when this pricing record was created.

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

currencystringrequired

ISO 4217 currency code for all monetary amounts in this record.

dispenseFeestringrequired

Additional dispense or handling fee applied per unit, as a decimal string.

Example: "100.00"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this pricing record is currently active.

markupnumberrequired

Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).

ownershipIdstringrequired

Identifier of the ownership or business entity context for this pricing.

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

productIdstringrequired

Identifier of the product this pricing applies to.

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

productPricingIdstringrequired

Canonical identifier for this product pricing record.

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

sellPricestringrequired

Sell price excluding tax in the billing currency, as a decimal string.

Example: "100.00"

sellPriceTaxstringrequired

Tax amount applicable to the sellPrice, as a decimal string.

Example: "100.00"

taxRateobjectrequired

Tax rate applied to this product pricing.

updatedAtstring(date-time)required

Timestamp when this pricing record was last updated.

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

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"
}

Replace product pricing

Request

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

Security

bearer

Path

siteIdnumberrequired

Site identifier

productPricingIdstringrequired

Product Pricing unique identifier (UUID)

Bodyapplication/jsonrequired

basedOnstringrequired

Indicates whether the pricing is defined directly by sell price or derived from markup on cost.

Enum"price""markup"

costPricestringrequired

Net cost price for the product in the billing currency, as a decimal string.

Example: "100.00"

currencystringrequired

ISO 4217 currency code for all monetary amounts in this record.

dispenseFeestringrequired

Additional dispense or handling fee applied per unit, as a decimal string.

Example: "100.00"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this pricing record is currently active.

markupnumberrequired

Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).

ownershipIdstringrequired

Identifier of the ownership or business entity context for this pricing.

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

productIdstringrequired

Identifier of the product this pricing applies to.

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

sellPricestringrequired

Sell price excluding tax in the billing currency, as a decimal string.

Example: "100.00"

sellPriceTaxstringrequired

Tax amount applicable to the sellPrice, as a decimal string.

Example: "100.00"

taxRateobjectrequired

Tax rate applied to this product pricing.

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": {}
  }'

Responses

Product Pricing replaced successfully

Bodyapplication/json

basedOnstringrequired

Indicates whether the pricing is defined directly by sell price or derived from markup on cost.

Enum"price""markup"

costPricestringrequired

Net cost price for the product in the billing currency, as a decimal string.

Example: "100.00"

createdAtstring(date-time)required

Timestamp when this pricing record was created.

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

currencystringrequired

ISO 4217 currency code for all monetary amounts in this record.

dispenseFeestringrequired

Additional dispense or handling fee applied per unit, as a decimal string.

Example: "100.00"

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this pricing record is currently active.

markupnumberrequired

Markup percentage applied to costPrice to derive sellPrice when basedOn = 'markup'. Expressed as a percentage (e.g., 20 for 20%).

ownershipIdstringrequired

Identifier of the ownership or business entity context for this pricing.

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

productIdstringrequired

Identifier of the product this pricing applies to.

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

productPricingIdstringrequired

Canonical identifier for this product pricing record.

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

sellPricestringrequired

Sell price excluding tax in the billing currency, as a decimal string.

Example: "100.00"

sellPriceTaxstringrequired

Tax amount applicable to the sellPrice, as a decimal string.

Example: "100.00"

taxRateobjectrequired

Tax rate applied to this product pricing.

updatedAtstring(date-time)required

Timestamp when this pricing record was last updated.

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

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"
}