HPH Integrations APIv1 · Customer Testing
Customer Testing. Available to the Customer Testing group. Production is not available. Environment and onboarding details are provided directly, never in this documentation.
GetHphItemAlternativesByCompanyItem

Get alternatives for a Company catalog item

Compare up to 49 eligible alternatives for one represented-Company item without disclosing its mapped HPH Item Code.

POST/v1/catalog/items/alternatives

Request schema: HphItemAlternativesByCompanyItemRequestV1
Success schema: HphItemAlternativesResponseV1
Documented HTTP statuses: 200, 400, 401, 403, 409, 429, 503
Contract: hph-item-alternatives-v1.openapi.json

Authorization

Current Enterprise authority and represented-Company access are required. Unknown, ambiguous, and wrong-Company identifiers are concealed identically. The same protected-content quota and usage accounting apply across REST and MCP.

Request guidance

Send exactly one company_item_id or alternate_company_item_id. Optionally include manufacturer_list_price. Do not send organization, Company, user, application, mapped HPH Item Code, or authority fields.

Request fields

FieldTypePresenceConstraints
company_item_idstringExactly one identifier requiredmaximum 512 characters
alternate_company_item_idstringExactly one identifier requiredmaximum 512 characters
includearrayOptionalSee the versioned schema

Synthetic request example

{
  "company_item_id": "SYNTHETIC-ITEM-100",
  "alternate_company_item_id": null,
  "include": [
    "manufacturer_list_price"
  ]
}

Idempotency and recovery

No idempotency key is used because this POST is read-only.

Response guidance

The source is resolved privately and excluded. Results use the same bounded alternative representation as the HPH Item Code operation. No source or alternative HPH Item Code, item_skey, or mapping revision is returned.

Synthetic success example: Alternatives resolved from a Company item

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