Get HPH item details
Retrieve disclosure-reduced product details and the represented Company's exact catalog-usage count for one through ten exact HPH Item Codes.
POST/v1/hph/catalog/items/details
Request schema: HphItemDetailsByCodeBatchRequestV1
Success schema: HphItemDetailsByCodeBatchResponseV1
Documented HTTP statuses: 200, 400, 401, 403, 409, 429, 503
Contract: hph-item-catalog-usage-v1.openapi.json
Authorization
Current Enterprise authority is required. The operation revalidates the represented Company and applies its current data restrictions before returning protected identifiers.
Request guidance
Send one through ten unique exact HPH Item Codes in the JSON body. Optional request_key values correlate results without becoming item authority.
Request fields
| Field | Type | Presence | Constraints |
|---|---|---|---|
items | array | Required | See the versioned schema |
Synthetic request example
{
"items": [
{
"request_key": "line-1",
"hph_item_code": "012NI0018"
}
]
}Idempotency and recovery
No idempotency key is used because this POST is read-only.
Response guidance
Results preserve request order and use available, not_found_or_concealed, or temporarily_unavailable outcomes. company_item_count is the exact number of the represented Company's current catalog items using the code. Restricted HPH Item Code, Manufacturer part number, Manufacturer order number, and Manufacturer UPC fields are omitted; the remaining authorized product details are still returned. No internal item identity or continuation value is exposed.
Synthetic success example: Available HPH item details
{
"contract_version": "v1",
"results": [
{
"outcome": "available",
"request_index": 0,
"request_key": "line-1",
"item": {
"item_ids": {
"hph_item_code": "012NI0018",
"manufacturer_part_number": "SYN-607",
"manufacturer_order_number": "SYN-9055750",
"manufacturer_upc": "000000000001"
},
"company_item_count": 2,
"lifecycle": "active",
"availability_status": "A",
"size": "1 in",
"descriptions": {
"company": null,
"hph_long": "Synthetic copper elbow",
"hph_short": "Synthetic elbow",
"manufacturer": null
},
"manufacturer": {
"manufacturer_id": "org-0000-1411",
"name": "Synthetic Manufacturer",
"short_name": null
},
"categorization": {
"category": "Synthetic Fittings",
"subcategory": "Synthetic Elbows"
},
"weight": {
"value": 0.177,
"unit_of_measure": "LB"
}
}
}
]
}Additional response examples
Protected identifiers withheld
{
"contract_version": "v1",
"results": [
{
"outcome": "available",
"request_index": 0,
"request_key": "line-1",
"item": {
"item_ids": {},
"company_item_count": 1,
"lifecycle": "active",
"availability_status": "A",
"size": "1 in",
"descriptions": {
"company": null,
"hph_long": "Synthetic copper elbow",
"hph_short": "Synthetic elbow",
"manufacturer": null
},
"manufacturer": {
"manufacturer_id": "org-0000-1411",
"name": "Synthetic Manufacturer",
"short_name": null
},
"categorization": {
"category": "Synthetic Fittings",
"subcategory": "Synthetic Elbows"
},
"weight": {
"value": 0.177,
"unit_of_measure": "LB"
}
}
}
]
}