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

List a historical association snapshot

Retrieve the complete empty-or-one HPH parent association recorded for one immutable positive mapping revision.

GET/v1/catalog/items/mapping/history/{mapping_revision}/associations

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

Authorization

The snapshot request is reauthenticated and reauthorized, including the represented Company's current HPH Item Code disclosure decision. The revision is bound to the represented company and catalog item.

Request guidance

Use the positive mapping_revision and relative associations link advertised by a history entry. The bounded page_size field remains accepted for v1 compatibility, but the snapshot is complete and has no continuation.

Parameters

NameInTypePresenceConstraintsDescription
company_item_idquerystringRequiredminLength 1; maxLength 255
mapping_revisionpathinteger or string (int64)Requiredminimum 1; maximum 9223372036854775807; pattern ^-?(?:0|[1-9]\d*)$
page_sizequeryinteger or string (int32)Optionalminimum 1; maximum 100; pattern ^-?(?:0|[1-9]\d*)$
continuationquerystringOptionalminLength 1; maxLength 64

Request body

This operation has no JSON request body.

Idempotency and recovery

No idempotency key is used because snapshot retrieval is read-only.

Response guidance

When this resource is advertised, the immutable collection is empty or contains one exact HPH Item Code. Current HPH descriptions are intentionally not presented as historical evidence. item_skey identifies the Company catalog item. If the link is absent, do not construct the URL.

Success response

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