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

Data Migration

Bulk-import existing customer, address, order and store records into the commerce platform. These endpoints are used when moving a merchant's data from an external or legacy system into Akinon — most commonly during an initial go-live or a platform migration — without re-entering records by hand.

What you can migrate

Each import handles a single kind of record. Choose the type that matches the data file you are uploading:

  • Customers — customer accounts, including their login credentials

  • Addresses — delivery and billing addresses linked to migrated customers

  • Orders — historical orders linked to migrated customers

  • Order items — the line items belonging to migrated orders

  • Retail stores — physical store records

Typical workflow

A migration runs in the background, so the three endpoints are used in order:

  1. Start the import by uploading one or more data files for a given record type. The response returns an identifier for the import.

  2. Track progress by polling with that identifier until the import finishes.

  3. Review errors with the same identifier to see which records were rejected and why, so they can be corrected and re-uploaded.

Because addresses, orders and order items reference customers (and order items reference orders), migrate the records in a dependency-friendly order: customers first, then addresses and orders, then order items.

Data files

Uploaded files must be tabular: the first row is the header, and each of the following rows is one record. Every column header must exactly match a field name of the record type you are importing (for example customer_code, order_number), and the values must follow the types described for that type.

The file format is taken from the file extension. CSV is the primary format — its separator (;, , or |) is detected automatically — and common spreadsheet formats such as Excel are also accepted. More than one file may be uploaded in a single request; all rows are imported together.

Last updated

Was this helpful?