Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

multipart/form-data

A migration to start: CSV files or ZIP files of them, up to 50 MB in all, or a connection to pull from.

name
string
required

A name for the migration, such as Move from Katana. Up to 120 characters.

Maximum string length: 120
files
file[]

CSV files named after the entity they hold, such as items.csv or boms.csv, or ZIP files of them. Up to 20 files and 50 MB in all. Required unless connection_id is sent, and not allowed with it.

Required array length: 1 - 20 elements

One CSV or ZIP file.

connection_id
string<uuid> | null

The ID of a connection to pull the records from. Required unless files are sent, and not allowed with them.

Response

MigrationResource

data
MigrationResource · object
required

A migration: one move of records into the organization from CSV files or a connection, with its status and check report. Its entities are listed only when one migration is shown.