Get Customer Mapping Impact
GET/api/channel-partners/:id/customer-mappings/:id2/impact
Returns the candidate orders the Apply endpoint can act on for this mapping.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
- failed_events: failed inbound orders referencing this identifier, each with an eligibility — ready (replayable now), blocked (other identifiers on the payload are still unresolved, listed in remaining_blockers), or duplicate (an order with that number already exists).
- existing_orders (customer mappings only): orders currently billed to the customer this identity resolves to without the mapping, each with its accounting state — none, local (accounting exists but is not posted externally), posted (posted to an accounting provider; re-billing requires acknowledge_accounting), or locked (accounting falls in a locked period; cannot be re-billed).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.