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

Expand mapping candidates

Request the next ten candidates, expanding the cumulative result from five to fifteen and then to a maximum of twenty-five.

POST/v1/item-mapping-requests/{operation_reference}/candidate-expansions

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

Authorization

Expansion requires its exact permission plus current represented-company, entitlement, disclosure, and operation ownership checks.

Request guidance

Send the current result_revision from the latest successful result. A stale revision or a request beyond the candidate ceiling is rejected.

Parameters

NameInTypePresenceConstraintsDescription
operation_referencepathstringRequired

Request fields

FieldTypePresenceConstraints
result_revisioninteger or string (int64)Requiredminimum 1; maximum 3

Request example

No synthetic example is approved for this operation. Follow the request-field table and versioned schema.

Idempotency and recovery

Use a new idempotency key for a new expansion. Replay the same key and request after an ambiguous result; replays consume no additional expansion quota.

Response guidance

The response replaces the prior candidate snapshot and carries a new result_revision. Candidate disclosure remains subject to the current ceiling.

Success response

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