List Customer Mappings
GET/api/channel-partners/:id/customer-mappings
Paginated customer mappings for a channel partner. A mapping redirects any identity the partner sends — their own customer id (external_id), a customer id from this system (sent_customer_id), an email, or a name — to the customer the orders should bill to. A mapping is never required for orders to process, but always wins when present — including over an explicitly sent customer id.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Search covers: ID (exact), referenced customer name (sentCustomer.name), billed customer name (customer.name), external name, email, external ID and key. Advanced filter columns include mapping (mapped|unmapped|needs_review), source, external_name, external_email, external_id, sent_customer_id, sent_customer_name, customer_name, match_method, hit_count, last_seen_at, created_at, updated_at.
Rows keyed by a sent customer id include a nested sent_customer object (the referenced customer) for display.
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.