Saltar al contenido principal
PUT
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

kind
string
requerido

Lo que trae la importación: customers o prices.

import
string
requerido

El ID de la importación, un UUID, tal como se devolvió al subir el archivo.

Cuerpo

application/json

Cómo se asignan las columnas de un archivo subido a los campos. No se importa nada hasta que se ejecuta la importación.

mapping
object
requerido

El campo al que se importa cada columna, con el nombre de la columna como clave. Para clientes: code, name, billing_address, shipping_address, payment_terms_days, notes, tax_treatment, tax_exemption_reference, tax_rate, price_list, shelf_life_minimum o shelf_life_unit; code y name deben asignarse. Para precios: price_list, item y prices, que deben asignarse todos. Una columna omitida no se importa.

save_as
string | null

Guarda la asignación con este nombre, de hasta 100 caracteres, para reutilizarla en el siguiente archivo.

Maximum string length: 100

Respuesta

SalesImportResource

data
SalesImportResource · object
requerido

Un archivo CSV de clientes o precios que se está importando, con el informe de lo que hizo o haría cada fila.