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

List current mapping associations

Retrieve the complete current HPH parent association for one company catalog item: either an empty collection or exactly one association.

GET/v1/catalog/items/mapping/associations

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

Authorization

The request is authenticated and authorized again, including the represented Company's current HPH Item Code disclosure decision. An item_skey, company item ID, or prior successful response grants no authority.

Request guidance

Send the mapping_revision advertised by current metadata. The bounded page_size field remains accepted for v1 compatibility, but forward associations are complete and do not return a continuation link.

Parameters

NameInTypePresenceConstraintsDescription
company_item_idquerystringRequiredminLength 1; maxLength 255
mapping_revisionqueryinteger or string (int64)Requiredminimum 0; 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 page retrieval is read-only.

Response guidance

association_count is exactly 0 or 1 and equals the returned collection length. links.next is null. A 409 mapping-revision-changed response means the active association changed; restart from current mapping metadata. item_skey identifies the owning Company's catalog item.

Success response

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