Passer au contenu principal
PUT
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

kind
string
requis

Ce que l'importation apporte : customers ou prices.

import
string
requis

L'ID de l'importation, un UUID, tel que renvoyé lors du téléversement du fichier.

Corps

application/json

Comment les colonnes d'un fichier téléversé correspondent aux champs. Rien n'est importé tant que l'importation n'est pas lancée.

mapping
object
requis

Le champ dans lequel chaque colonne est importée, indexé par le nom de la colonne. Pour les clients : code, name, billing_address, shipping_address, payment_terms_days, notes, tax_treatment, tax_exemption_reference, tax_rate, price_list, shelf_life_minimum ou shelf_life_unit ; code et name doivent être associés. Pour les prix : price_list, item et prices, qui doivent tous être associés. Une colonne omise n'est pas importée.

save_as
string | null

Enregistre la correspondance sous ce nom, jusqu'à 100 caractères, pour la réutiliser avec le fichier suivant.

Maximum string length: 100

Réponse

SalesImportResource

data
SalesImportResource · object
requis

Un fichier CSV de clients ou de prix en cours d'importation, avec le rapport de ce que chaque ligne a fait ou ferait.