Carga de Clientes¶
Esta página especifica a documentação necessária para geração dos arquivos de importação de clientes.
Regras gerais do arquivo¶
- O arquivo deve ser gerado no formato CSV.
- O caractere delimitador deve ser a barra vertical (
|). - Os campos devem seguir a ordem de definição apresentada na tabela abaixo.
- O arquivo deve ser gerado com o seguinte nome:
CADASTRO_CLIENTE.csv
Cabeçalho
O cabeçalho do arquivo é opcional — os campos são reconhecidos através de sua ordem.
Campos opcionais x configuração do painel
Os campos marcados como Opcional podem ser configurados como obrigatórios pelo varejista no painel. Quando configurados dessa forma, devem ser enviados em todos os clientes.
Sempre obrigatórios
Os campos cpfCnpj e dataNascimento são sempre obrigatórios em todos os clientes.
Definição dos campos¶
A ordem das colunas abaixo é a ordem exata em que os campos devem aparecer no arquivo CSV.
| # | Nome | Detalhe | Tipo | Obrigatório |
|---|---|---|---|---|
| 1 | nome |
Nome completo (nome + sobrenome). Pessoas físicas não podem conter números no nome. | String(150) | Sim |
| 2 | cpfCnpj |
Somente números. O sistema reconhece o documento conforme a nacionalidade: Brasileira = CPF (11) ou CNPJ (14); Argentina = DNI, Documento Nacional de Identidade (9); Paraguai = NIP, Número de Identificação Pessoal (8). | String(14) | Sim |
| 3 | nacionalidade |
Somente números: 1 - Brasileiro(a), 2 - Argentino(a), 3 - Paraguaio(a). |
Inteiro | Opcional |
| 4 | cidade |
Cidade da residência do cliente. | String(150) | Opcional |
| 5 | estado |
Apenas UF. Exemplo: SP. |
String(2) | Opcional |
| 6 | genero |
Enviar somente a abreviatura: F - Feminino, M - Masculino, OU - Outros, PI - Prefiro Não Informar. |
String(2) | Opcional |
| 7 | dataNascimento |
Formato dd/MM/yyyy ou yyyy-MM-dd hh:mm:ss, sendo maior de 18 anos. Exemplo: 28/04/2023 ou 1990-09-12 00:00:00. |
Date | Sim |
| 8 | razaoSocial |
Se for um CNPJ, alimentar esse campo. | String(200) | Opcional |
| 9 | senha |
Caso informado, é considerado um cadastro completo; caso contrário, é considerado um pré-cadastro. | Numeric(6) | Opcional |
| 10 | rg |
Somente números. | String(9) | Opcional |
| 11 | email |
Tem que ser válido e atender ao mínimo de requisitos. | String | Opcional |
| 12 | telefone |
Somente números, composto por DDD + número. Ex: DD99999999. |
Numeric(10) | Opcional |
| 13 | celular |
Somente números, composto por DDD + número. Ex: DD999999999. |
Numeric(11) | Opcional |
| 14 | pushid |
Identificador de push notification (ver formato abaixo). | Text | Opcional |
| 15 | logradouro |
Endereço da residência do cliente. | String(150) | Opcional |
| 16 | numero |
Somente números. Número da residência. | String(6) | Opcional |
| 17 | bairro |
Bairro da residência do cliente. | String(150) | Opcional |
| 18 | complemento |
Livre para complemento do endereço. | String(150) | Opcional |
| 19 | cep |
Somente números, especificamente todos os dígitos. | String(9) | Opcional |
| 20 | idEstadoCivil |
Enviar somente o ID: 1 - Solteiro(a), 2 - Divorciado(a), 3 - Viúvo(a), 4 - União Estável, 5 - Casado(a), 6 - Separado(a). |
Numeric | Opcional |
| 21 | receberOferta |
Deve ser um booleano: True ou False. |
Boolean | Opcional |
| 22 | modulo |
Descrição da origem de cadastro. | Varchar(50) | Opcional |
| 23 | funcionario |
Indicar se é um funcionário ou não (true/false). |
Boolean | Opcional |
| 24 | classificacao |
Descrição da classificação. | Varchar(50) | Opcional |
| 25 | lojaFavorita |
Código de identificação da loja que o shopper marcar como favorita. | Varchar(15) | Sim |
| 26 | aceiteEmail |
Booleano true/false/vazio. Se vier vazio, não será alterado o valor que já temos no CRM. Se informado, será assumido como informação nova, alterando o aceite do shopper (OptIn/OptOut individual). |
Boolean | Opcional |
| 27 | aceiteSms |
Booleano true/false/vazio. Se vier vazio, não será alterado o valor que já temos no CRM. Se informado, será assumido como informação nova, alterando o aceite do shopper. |
Boolean | Opcional |
| 28 | aceitePush |
Booleano true/false/vazio. Se vier vazio, não será alterado o valor que já temos no CRM. Se informado, será assumido como informação nova, alterando o aceite do shopper. |
Boolean | Opcional |
Formato do campo pushid¶
O campo pushid deve ser preenchido conforme a plataforma do dispositivo.
Exemplo de arquivo final¶
Exemplo de arquivo CADASTRO_CLIENTE.csv gerado, delimitado por barra vertical: