For the complete documentation index, see llms.txt. This page is also available as Markdown.

Review import errors

Returns the messages for records that were rejected during an import. Use it after (or while) tracking progress to find out why records failed, so they can be corrected in the source file and re-uploaded.

Each message describes one rejected record. Validation failures are prefixed with the field name (field: message), but failures raised while the record is being saved (for example a duplicate email on re-import) surface as the raw error text without a field prefix, so do not assume every message follows the field: message shape.

The field name in a message is the serializer field, which for a few columns differs from the file column: the customer link (file column customer_code) is reported as user, and the order link (file column order_number) is reported as order.

If no records were rejected — or the identifier is not recognised — an empty list is returned.

get
/migrations/{migration_id}/errors/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters
migration_idstringRequired

Identifier returned when the import was started.

Example: 3f2a1c9e8b7d4a6f9c0e1d2b3a4c5e6f
Responses
200

The list of error messages collected during the import.

application/json
errorsstring[]Optional

One message per rejected record. Empty when there are no errors.

get/migrations/{migration_id}/errors/
GET /api/remote/1/migrations/{migration_id}/errors/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "errors": [
    "email: Enter a valid email address.",
    "phone: This field is required.",
    "user: Object with attributes__migration_customer_code=CUST-999 does not exist.",
    "duplicate key value violates unique constraint"
  ]
}

Last updated

Was this helpful?