Skip to main content
GET
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 whose rows are listed.

Query Parameters

entity
enum<string>

The entity whose rows are listed: units, locations, items, boms, suppliers, supplier_items, price_lists, customers, opening_stock, open_purchase_orders or open_sales_orders. When left out, it is the first entity in commit order with rows in the status asked for, else the first the migration holds. What a migration brings in, in the order it commits them: each entity comes after everything it names, so a BOM's items exist before its lines and a location before the stock at it. Undo runs the other way.

Available options:
units,
locations,
items,
boms,
suppliers,
supplier_items,
price_lists,
customers,
opening_stock,
open_purchase_orders,
open_sales_orders
status
enum<string> | null

Only rows in this status: staged, valid, invalid, committed, skipped or archived. When left out, rows in every status are listed.

Available options:
staged,
valid,
invalid,
committed,
skipped,
archived
after
integer

The row number the page starts after: the next value of the page before. Defaults to 0, the first page.

Required range: x >= 0

Response

MigrationRowsResource

data
MigrationRowsResource · object
required

A page of one entity's staged rows, with the migration they belong to and the row number the next page starts after.