Importar clientes de um arquivo

POST/api/crm/v2/clients_import.importv2

operationId: clientsImport.import

Importa clientes da rede a partir de um arquivo CSV: delimitador ;, três colunas — nome, telefone, bônus. Para cada linha, o telefone é normalizado e validado; se o cliente ainda não existir, ele é criado. O perfil do cliente é criado na primeira filial da rede e os bônus são creditados. Telefones inválidos e valores de bônus zero são ignorados. Se o arquivo não for enviado, retorna o erro 106; se o CSV for inválido, retorna o erro 108.

Autorização

api-token + language + role

Parâmetros de consulta

chain_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `multipart/form-data`

object

filestring · binaryobrigatório

Arquivo *.csv

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

Uma das opções

object

Descrição do erro

errorobjectobrigatório

codeintegerobrigatório

object

Dados

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/clients_import.import?chain_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -F 'file=@file.jpg'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/clients_import.import?chain_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'multipart' => [
        [
            'name' => 'file',
            'contents' => '<file>',
        ],
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const body = new FormData()
body.append("file", "<file>")

const response = await fetch("https://foodsoul.pro/api/crm/v2/clients_import.import?chain_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/clients_import.import?chain_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    files={
        "file": [
            None,
            "<file>",
        ],
    },
)
data = response.json()

Resposta 200

{
  "error": {
    "code": 0
  }
}

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Importar clientes de um arquivo

Autorização

Parâmetros de consulta

Corpo da solicitação multipart/form-data

Respostas

Corpo da solicitação `multipart/form-data`