Import Customer Mappings CSV
POST/api/channel-partners/:id/customer-mappings/import
Bulk imports customer redirects from a CSV upload (multipart/form-data, field name: file).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Columns read per row: external_key (targets an existing row, e.g. an email identity created by a failed order) OR referenced_customer_id (a customer id in this system that the partner references — creates/updates the redirect), plus bill_to_customer_id (the customer to bill; empty = unmap an existing row). Other columns are ignored, so a file downloaded from the Export endpoint can be edited and uploaded directly.
Both customers must exist, and a redirect from a customer to itself is rejected. Imported writes carry source and match_method = import.
Validation is all-or-nothing: if ANY line has a problem, the response has status validation_failed with per-line errors and nothing is written.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.