Get HPH Catalog Item alternatives
Compare up to 49 eligible alternatives for one exact caller-known HPH Item Code.
POST/v1/hph/catalog/items/alternatives
Request schema: HphItemAlternativesRequestV1
Success schema: HphItemAlternativesResponseV1
Documented HTTP statuses: 200, 400, 401, 403, 409, 429, 503
Contract: hph-item-alternatives-v1.openapi.json
Authorization
Current Enterprise authority is required. The same represented-Company data restrictions, protected-content quota, and usage accounting apply across REST and MCP.
Request guidance
Send one exact HPH Item Code. Optionally include manufacturer_list_price. The operation does not browse HPH codes and does not accept Company, user, application, or authority fields in the body.
Request fields
| Field | Type | Presence | Constraints |
|---|---|---|---|
hph_item_code | HphItemCode | Required | See the versioned schema |
include | array | Optional | See the versioned schema |
Synthetic request example
{
"hph_item_code": "012NI0018",
"include": [
"manufacturer_list_price"
]
}Idempotency and recovery
No idempotency key is used because this POST is read-only.
Response guidance
The source item is excluded. Distinct eligible items are not collapsed merely because they have the same Manufacturer, and a distinct alternative from the source Manufacturer may be returned. Results are comparison options, not rankings or recommendations. option_reference is a short-lived action handle, not item identity. No source or alternative HPH Item Code is returned. Outcomes without alternatives are not_cross_referenced, not_found_or_concealed, collection_limit_exceeded, and temporarily_unavailable.
Synthetic success example: Alternatives with Manufacturer list price
{
"contract_version": "v1",
"outcome": "available",
"alternatives": [
{
"option_reference": "opaque-short-lived-option-reference",
"manufacturer": {
"name": "Synthetic Manufacturer"
},
"description": "Synthetic alternative description",
"size": "1 inch",
"manufacturer_part_number": "SYN-100",
"availability_status": "A",
"manufacturer_list_price": {
"price_sheet_skey": "3d4c7bfc-49b0-11e9-9891-00137268a1bf",
"price": 18.11,
"currency": "USD",
"unit_of_measure": "E",
"effective_date": "2026-10-01",
"price_sheet_number": "SYN-2026-10",
"price_sheet_name": "Synthetic price sheet"
}
}
],
"notices": []
}Additional response examples
Bounded comparison without alternative item codes
{
"contract_version": "v1",
"outcome": "available",
"alternatives": [
{
"option_reference": "opaque-short-lived-option-reference",
"manufacturer": {
"name": "Synthetic Manufacturer"
},
"description": "Synthetic alternative description",
"size": "1 inch",
"manufacturer_part_number": "SYN-100",
"availability_status": "A",
"manufacturer_list_price": null
}
],
"notices": []
}