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 item fields.

mapping
object
required

Each column's target by the column's name: sku, name, description, type, make_or_buy, base_unit, barcodes or custom:. A column left out is not imported. The SKU must be mapped.

save_as
string | null

Saves the mapping under this name for later imports.

Maximum string length: 100

Response

ItemImportResource

data
ItemImportResource · object
required