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 CSV of opening stock, and optionally a saved mapping to start from.

file
file
required

Comma separated, with a header row, at most 10,000 rows and 20 MB.

mapping_id
string<uuid> | null

A saved mapping to map the columns with, instead of by their names.

Response

StockImportResource

data
StockImportResource · object
required