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

kind
string
required
import
string
required

Body

application/json
mapping
object
required

Each column's field by the column's name. For customers: code, name, billing_address, shipping_address, payment_terms_days, notes, tax_treatment, tax_exemption_reference, tax_rate, price_list, shelf_life_minimum or shelf_life_unit; code and name must be mapped. For prices: price_list, item and prices, which must all 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

SalesImportResource

data
SalesImportResource · object
required