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.
GetCompanyItemCurrentMapping

Retrieve a company item's current mapping

Retrieve the owning Company's catalog-item SKEY, current mapping status, per-item mapping revision, complete association count, and navigation links for one exact company catalog item.

GET/v1/catalog/items/mapping

Request schema: None
Success schema: CompanyItemCurrentMappingResponseV1
Documented HTTP statuses: 200, 400, 401, 403, 404, 429, 503
Contract: v1-baseline.json

Authorization

The operation revalidates represented-company authority, optional partner delegation, current entitlement, read permission, and the current company field policy on every request.

Request guidance

Send the current exact company item ID as the company_item_id query parameter. Do not send an item_skey, application identity, continuation value, or request body.

Parameters

NameInTypePresenceConstraintsDescription
company_item_idquerystringRequiredminLength 1; maxLength 255

Request body

This operation has no JSON request body.

Idempotency and recovery

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

Response guidance

item_skey is HPH's stable identifier for the owning Company's catalog item and remains the same when company_item_id changes. Revision 0 with unmapped means the authoritative catalog item has never been mapped. A positive revision with unmapped means it was mapped previously but its current association became empty. The associations link is advertised only when the represented Company's current license and field policy permit HPH Item Code disclosure.

Success response

No synthetic example is approved for this operation. Use the success schema and response guidance above.