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
mapping
object
required

Each column's field by the column's name. For suppliers: code, name, lead_time_days, payment_terms, address or notes; code and name must be mapped. For supplier catalogs: supplier, item, supplier_sku, description, purchase_unit, minimum_quantity, order_multiple, lead_time_days, preferred, origin_country or prices; supplier and item must be mapped. A column left out is not imported.

save_as
string | null

Saves the mapping under this name, for the next file.

Maximum string length: 100

Response

ImportResource

data
ImportResource · object
required