Endpoints responsáveis pela consulta e criação de novos clientes na Yandeh.
Início > Cadastro de clientes
Versão: 2.0
Cadastro de Clientes
GET Processamento clientes
Endpoint responsável por consultar o status de processamento dos clientes já
cadastrados.
Endpoint GET
URL
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta de clientes.
filtrarPor: Define o filtro que será utilizado na consulta
-
Parâmetros disponíveis:
-
cnpj: CNPJ do cliente a ser pesquisado.
-
register: ID da requisição (id_registro).
-
-
Parâmetro obrigatório.
valor: Define o valor correspondente ao filtro selecionado em filtrarPor
-
Exemplo (quando utilizado cnpj): 10256698000110
-
Parâmetro obrigatório.
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/onboarding/consultar-processamento-clientes?filtrarPor=cnpj&valor=48050634000185' \
--header 'Authorization: Bearer ...' \
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200.
Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Consulta de processamento de clientes realizada com sucesso"
},
"data": [
{
"id": "c30d47d2-4502-avbg5-ade9-a5bae381kic6",
"id_registro": "a335359d-c65-4fdd-866d-edaf2fcjuede",
"cnpj": "10256698000110",
"status": "Em fila",
"mensagem": null,
"data_criacao": "2025-01-01T16:44:18.441Z",
"data_atualizacao": null
},
{
"id": "cddf67d2-4502-avbg5-ade9-a5baad691kic6",
"id_registro": "a33hu89d-c65-4fdd-966d-w78wf2fcjuede",
"cnpj": "10256698000110",
"status": "Processando",
"mensagem": null,
"data_criacao": "2025-01-01T16:44:18.441Z",
"data_atualizacao": "2025-01-01T16:48:00.001Z"
},
{
"id": "c30d47d2-4502-avbg5-ade9-a5bae381kic6",
"id_registro": "a335359d-c65-4fdd-866d-edaf2fcjuede",
"cnpj": "10256698000110",
"status": "Ocorreu um erro",
"mensagem": "Empresa não está ativa",
"data_criacao": "2025-01-01T16:44:18.441Z",
"data_atualizacao": "2025-01-01T16:50:00.001Z"
}
]
}
Elementos da Resposta
id: Identificador único da requisição.
Tipo: String
id_registro: Identificador único do registro.
Tipo: String
cnpj: Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente.
Tipo: String.
status: Status da requisição.
Tipo: String.
mensagem: Mensagem de retorno da requisição
Tipo: String.
data_criacao: Data de criação do registro.
Tipo: Datetime.
data_atualizacao: Data de atualização do registro.
Tipo: Datetime.
Respostas para erros
400 Bad Request
Filtros inválidos
{
"detail": {
"success": false,
"message": "'filtrarPor' deve ser 'cnpj' ou 'register' e o 'valor' é obrigatório"
},
"data": {}
}
POST Clientes
Endpoint responsável pelo cadastro de novos clientes.
Endpoint POST
URL
Sintaxe da Requisição
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"cnpj": "97693357000134",
"razaoSocial": "Empresa 97693357000134",
"email": "empresa.teste@email.com",
"telefone": "+5511912345678",
"cluster": "Mercearia",
"regiao": "Leste",
"codigo_do_cliente": "123"
}
]
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/onboarding/clientes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw ' [
{
"cnpj": "97693357000134",
"razaoSocial": "Empresa 97693357000134",
"email": "empresa.teste@email.com",
"telefone": "+5511912345678",
"cluster": "Mercearia",
"regiao": "Leste",
"codigo_do_cliente": "123"
}
]'
Elementos da Requisição
cnpj: Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente.
-
Campo obrigatório.
Tipo: String
razaoSocial: Nome empresarial (Razão Social) do cliente.
-
Campo obrigatório.
Tipo: String
email: Endereço de e-mail da empresa ou do responsável.
-
Campo obrigatório.
Tipo String.
telefone: Número de telefone da empresa ou do responsável.
Tipo: String.
cluster: Classificação do tipo de cliente ou estabelecimento.
Tipo: String.
região: Região do endereço do estabelecimento.
Tipo: Integer.
codigo_do_cliente: Código do cliente no fornecedor.
Tipo: Integer.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200.Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Clientes válidos estão em processamento"
},
"data": {
"clientesInvalidos": [],
"clientesValidos": [
{
"phone": "+5511912345678",
"fullName": "Empresa 97693357000134",
"pdvQty": 1,
"cnpj": "97693357000134",
"razaoSocial": "Empresa 97693357000134",
"email": "empresa.teste@email.com",
"telefone": "+5511912345678",
"cluster": "Mercearia",
"regiao": "Leste",
"codigo_do_cliente": "123"
}
],
"successResponse": {
"registerId": "20683de3-1021-4cb8-af4b-ca678f849ad5"
}
}
}
Respostas para erros
400 Bad Request - Tentativa de cadastro com um CNPJ inválido
{
"detail": {
"success": false,
"message": "A lista de clientes deve ser corrigida"
},
"data": {
"clientesInvalidos": [
{
"cnpj": "abcdef123",
"razaoSocial": "Empresa 97693357000134",
"email": "empresa.97693357000134@email.com",
"telefone": "+55 (11) 91234-5678",
"cluster": "Mercearia",
"regiao": "Leste",
"codigo_do_cliente": "123"
"erros": [
"CNPJ inválido"
]
}
],
"clientesValidos": []
}
}
PUT Clientes - Atributos
Endpoint responsável por cadastrar atributos dos clientes.
Endpoint PUT
URL
Sintaxe da Requisição
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"cnpj": "01479971000111",
"chave": "cluster12",
"valor": "Originalidade"
}
]
Exemplo:
curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/clientes/atributos' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw ' [
{
"cnpj": "01479971000129",
"chave": "cluster12",
"valor": "Originalidade"
}
]'
Elementos da Requisição
cnpj: Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente.
-
Campo obrigatório.
Tipo: String
chave: Chave para o atributo.
-
Campo obrigatório.
Tipo: String
valor: Valor do atributo.
-
Campo obrigatório.
Tipo String.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200.Exemplo de retorno:
[{}]
Respostas para erros
400 Bad Request - Tentativa de cadastro com um CNPJ inválido
{
"mensagem": "Erro ao processar atualização de atributos de clientes",
"detalhes": {
"processados": 11,
"sucessos": 0,
"falhas": 1,
"erros": [
{
"indice": 1,
"statusCode": 500,
"erro": "{}"
}
]
}
}