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

import
string
required

Body

application/json

How an import's columns map to stock fields.

mapping
object
required

Each column's field by the column's name: item, location, status, lot, lot_expires_on, origin_country, serial, quantity, unit, unit_cost or value. A column left out is not imported. The item, location and quantity must be mapped.

save_as
string | null

Saves the mapping under this name for later imports.

Maximum string length: 100

Response

StockImportResource

data
StockImportResource · object
required