Skip to content

Exemplo de Arquivo para Importação de Clientes

GET /customers/import/example

Endpoint responsável por retornar o arquivo de exemplo para importação de clientes

Descrição

Endpoint responsável por retornar um arquivo CSV de exemplo para importação de clientes 📄.

O arquivo contém o cabeçalho com todas as colunas obrigatórias, servindo como referência para o correto preenchimento dos dados.

Esse modelo pode ser utilizado como base para preparar e validar o arquivo de importação, reduzindo inconsistências no processamento.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {userToken}Token de autenticação do usuário

Exemplo de Requisição

1curl --request GET \
2  --url 'https://sua-loja-uappi.com.br/api/v3/customers/import/example' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
4  --output customer-example.csv

✅ Resposta de Sucesso

HTTP Status: 200 OK

Content-Type: application/octet-stream

Content-Disposition: attachment; filename="customer-example.csv"

O arquivo retornado contém o seguinte cabeçalho:

1Email,Name corporate name,Trade name,Is corporate,Gender,Nationality,Birthdate,Phone,Origin,Active,CPF,CNPJ,RG,IE,Document 1,Document 2,Document 3

Descrição das Colunas

ColunaTipoDescrição
EmailstringE-mail do cliente (identificador único)
Name corporate namestringNome do cliente ou razão social
Trade namestringNome fantasia (para pessoa jurídica)
Is corporatebooleanSe é pessoa jurídica (true/false)
GenderstringGênero (male, female, undefined)
NationalitystringNacionalidade do cliente
BirthdatestringData de nascimento (formato: YYYY-MM-DD)
PhonestringTelefone do cliente
OriginstringOrigem do cliente
ActivebooleanStatus de ativação (true/false)
CPFstringCPF do cliente
CNPJstringCNPJ do cliente
RGstringRG do cliente
IEstringInscrição estadual
Document 1stringDocumento extra 1
Document 2stringDocumento extra 2
Document 3stringDocumento extra 3

⚠️ Possíveis erros:

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_STORE_IMPORT_MODEL_NOT_FOUND",
6    "message": "The requested import model was not found."
7  }
8}

Importação de Clientes

POST /customers/import

Endpoint responsável por importar clientes através de arquivo CSV

Descrição

Endpoint que permite aos usuários administrativos importar clientes em massa por meio de um arquivo CSV 📂.

O arquivo deve seguir o modelo disponibilizado no endpoint de exemplo, garantindo que as colunas e o formato estejam adequados para processamento.

O limite máximo permitido é de 5.000 linhas por arquivo, assegurando controle e estabilidade durante a importação.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {token}Token de autenticação do usuário
Content-Typemultipart/form-dataTipo do conteúdo

Parâmetros do Corpo (multipart/form-data)

ParâmetroTipoObrigatórioDescrição
filefileSimArquivo CSV com os clientes (máximo 4MB, mimetype: text/csv)
salesChannelIdintegerSimID do canal de vendas
replaceDatabooleanSimSe deve substituir dados existentes

Estrutura do Arquivo CSV

O arquivo CSV deve conter as seguintes colunas:

ColunaTipoDescrição
EmailstringE-mail do cliente (identificador único)
Name corporate namestringNome do cliente ou razão social
Trade namestringNome fantasia (para pessoa jurídica)
Is corporatebooleanSe é pessoa jurídica (true/false)
GenderstringGênero (male, female, undefined)
NationalitystringNacionalidade do cliente
BirthdatestringData de nascimento (formato: YYYY-MM-DD)
PhonestringTelefone do cliente
OriginstringOrigem do cliente
ActivebooleanStatus de ativação (true/false)
CPFstringCPF do cliente
CNPJstringCNPJ do cliente
RGstringRG do cliente
IEstringInscrição estadual
Document 1stringDocumento extra 1
Document 2stringDocumento extra 2
Document 3stringDocumento extra 3

Exemplo de Requisição

1curl --request POST \
2  --url '{{MAIN_URL}}/customers/import' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
4  --header 'Content-Type: multipart/form-data' \
5  --form 'file=@customers.csv' \
6  --form 'salesChannelId=1' \
7  --form 'replaceData=false'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": [
4    {
5      "id": 123,
6      "externalId": "cliente@email.com",
7      "error": null,
8      "nameCorporateName": "João Silva",
9      "tradeName": "",
10      "isCorporate": false,
11      "gender": "male",
12      "nationality": "brasileiro",
13      "birthdate": "1990-01-15",
14      "phone": "11999999999",
15      "origin": "importacao",
16      "active": true,
17      "cpf": "12345678900",
18      "cnpj": "",
19      "rg": "",
20      "ie": "",
21      "document1": "",
22      "document2": "",
23      "document3": ""
24    },
25    {
26      "id": null,
27      "externalId": "cliente2@email.com",
28      "error": "UAPPI_STORE_CUSTOMER_EMAIL_ALREADY_EXISTS",
29      "nameCorporateName": "Maria Santos",
30      "tradeName": "",
31      "isCorporate": false,
32      "gender": "female",
33      "nationality": "brasileira",
34      "birthdate": "1985-05-20",
35      "phone": "11988888888",
36      "origin": "importacao",
37      "active": true,
38      "cpf": "98765432100",
39      "cnpj": "",
40      "rg": "",
41      "ie": "",
42      "document1": "",
43      "document2": "",
44      "document3": ""
45    }
46  ]
47}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código InternoCódigo HTTPDescrição
UAPPI_CORE_IMPORT_FILE_HEADER_REQUIRED400O arquivo não possui cabeçalho
UAPPI_CORE_IMPORT_FILE_REQUIRED_FIELDS400O arquivo não possui os campos obrigatórios
UAPPI_CORE_IMPORT_FILE_LINE_LIMIT400O arquivo excede o limite de 5000 linhas

Possíveis Erros por Linha

Código do ErroDescrição
UAPPI_STORE_CUSTOMER_EMAIL_ALREADY_EXISTSE-mail já cadastrado

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;