Skip to main content
PUT
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.

Path Parameters

migration
string
required

The ID of the migration to map.

entity
string
required

The entity whose columns are mapped, such as items or boms.

Body

application/json

The target field chosen for each source column of one entity.

columns
object[]
required

Each source column with the target field it fills. At least one. Columns left out of the list keep their mapping.

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.