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

List mapping history revisions

Traverse immutable per-item mapping revisions, including active, superseded, and previously mapped empty states.

GET/v1/catalog/items/mapping/history

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

Authorization

Every page is reauthorized for the represented company. History metadata remains available when HPH Item Code is withheld; association links are then omitted. Use only the continuation link returned by the service.

Request guidance

Use an optional page_size from 1 through 25. For another page, send the returned relative next link unchanged; do not add a revision watermark or expose the continuation in logs.

Parameters

NameInTypePresenceConstraintsDescription
company_item_idquerystringRequiredminLength 1; maxLength 255
page_sizequeryinteger or string (int32)Optionalminimum 1; maximum 25; 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 history retrieval is read-only.

Response guidance

item_skey identifies the same durable Company catalog item across item-ID changes. history_availability is complete or pre_cutover_unavailable. Revision 0 never appears in history. Each entry reports an association_count of 0 or 1 and links to its immutable snapshot 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.