Cliente
Cliente comprador da loja.
| Campo | Tipo | Descrição |
|---|---|---|
externalId |
string | Código identificador externo |
externalCode |
type | Código externo do cliente (referência) |
customerSource |
object | Origem de cadastro do cliente |
customerSource.id |
integer | Id da origem de acesso do cliente |
customerClassification |
object | Classificação na qual o cliente está inserido |
customerClassification.id |
integer | Id da classificação do cliente |
companyName |
string | Razão social do cliente * Só está presente caso cnpj esteja preenchido |
fantasyName |
string | Nome fantasia do cliente * Só está presente caso cnpj esteja preenchido |
cnpj |
string | Cadastro nacional de pessoa jurídica * Pelo menos um dos documentos estará preenchido (cnpj ou cpf) |
im |
string | Código de inscrição municipal |
ie |
string | Código de inscrição estadual |
firstName |
string | Primeiro nome do cliente * Só está presente caso cpf esteja preenchido |
lastName |
string | Sobrenome do cliente * Só está presente caso cpf esteja preenchido |
cpf |
string | Cadastro de pessoa física * Pelo menos um dos documentos estará preenchido (cnpj ou cpf) |
rg |
string | Número do registro geral (RG) |
gender |
string | Gênero do cliente, sendo: M - Masculino F - Feminino |
phone |
string | Telefone principal, seguindo o formato (99) 9999-9999 ou (99) 99999-9999 |
cellphone |
string | Telefone celular, seguindo o formato (99) 99999-9999 |
email |
string | Endereço de email do cliente |
password |
string | Senha do cliente |
facebookId |
integer | Id do facebook para login |
facebookToken |
string | Token de autenticação do facebook para login |
exempt |
boolean | Estado de isenção de inscrição estadual |
newsletter |
boolean | Estado de inscrição do cliente em newsletter |
birthDate |
string | Data de nascimento do cliente |
createdAt |
string | Data de criação do cadastro |
updatedAt |
string | Data de última atualização do cliente |
customFields |
array | Campos customizados do cadastro * possui o objeto com as configurações do campo |
Objeto customFields
| Campo | Tipo | Descrição |
|---|---|---|
index |
string | Índice do campo customizado |
value |
string | Valor do campo preenchido pelo cliente |
parameters |
object | Configurações do campo |
parameters.title |
string | Título de exibição do campo customizado |
parameters.maxLength |
int | Número máximo de caracteres permitido do campo |
parameters.required |
boolean | Obrigatoriedade do campo |
parameters.active |
boolean | Estado atual do campo |
Modificado em 2026-08-07 15:49:11