Início > Pessoa fisica
Versão: 2.0
Cadastro de Pessoa Física
Endpoints responsáveis pelos cadastros de clientes pessoa física na Yandeh.
GET Cadastro Pessoa Física
Endpoint responsável pela consulta dos cadastros de pessoas físicas.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos clientes.
status: Status do cadastro de cliente.
-
Parâmetro não obrigatório.
cpf: CPF do cliente a ser consultado.
-
Parâmetro não obrigatório.
pagina: Página a ser exibida.
-
Default página 1.
-
Parâmetro não obrigatório.
por_pagina: Quantidade de registros a serem exibidos por página.
-
Default 50 registros por página.
-
Parâmetro não obrigatório.
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/cliente/pessoa-fisica?status=ativo&pagina=1&por_pagina=2' \
--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": "Clientes listados com sucesso"
},
"data": [
{
"id": 74071,
"nome": "JAQUELINE SILVA",
"email": "jaquelinesilva@gmail.com",
"cpf": "01114530115",
"status": "ativo",
"cep": "05388030",
"uf": "SP",
"cidade": "SAO PAULO",
"bairro": "JARDINS",
"endereco": "AVENIDA c",
"numero": "300",
"complemento": "",
"latitude": "0",
"longitude": "0"
},
{
"id": 60232,
"nome": "RAIMUNDO OLIVEIRA",
"email": "raimundo@hotmail.com",
"cpf": "21100050007",
"status": "ativo",
"cep": "00003105",
"uf": "SP",
"cidade": "COTIA",
"bairro": "CENTRO",
"endereco": "RUA DA LIBERDADE",
"numero": "2",
"complemento": "",
"latitude": "-23.506439",
"longitude": "-46.900132"
}
],
"pagina": 1,
"por_pagina": 2,
"total_paginas": 895
}
Elementos da Resposta
id: Identificador (ID) do cadastro do cliente na Yandeh.
Tipo: Integer
nome: Nome do cliente.
Tipo: String.
email: E-mail do cliente.
Tipo: String.
cpf: CPF do cliente.
Tipo: String.
status: Status do cadastro.
Tipo: String.
cep: CEP do estabelecimento do cliente.
Tipo: String.
uf: UF do estabelecimento do cliente.
Tipo: String.
cidade: Cidade do estabelecimento do cliente.
Tipo: String.
bairro: Bairro do estabelecimento do cliente.
Tipo: String.
endereco: Logradouro do estabelecimento do cliente.
Tipo: String.
numero: Número do estabelecimento do cliente.
Tipo: String.
complemento: Complemento do endereço.
Tipo: String.
latitude: Latitude do establecimento do cliente.
Tipo: String.
longitude: Longitude do estabelecimento do cliente.
Tipo: String.
POST Cadastro Pessoa Física
Endpoint responsável por cadastrar novos clientes pessoa física.
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:
[
{
"nome": "Ana Silva",
"email": "anasilva@gmail.com",
"cpf": "12345678910",
"status": "ativo",
"cep": "79621987",
"uf": "SP",
"cidade": "São Paulo",
"bairro": "Centro",
"endereco": "Rua Leste",
"numero": "123",
"complemento": "Casa 1",
"latitude": "-4.8708",
"longitude": "-34.4869"
}
]
Exemplo :
curl --location 'https://yandeh-seller-integration.yandeh.com.br/cliente/pessoa-fisica' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '[
{
"nome": "Ana Silva",
"email": "anasilva@gmail.com",
"cpf": "12345678910",
"status": "ativo",
"cep": "79621987",
"uf": "SP",
"cidade": "São Paulo",
"bairro": "Centro",
"endereco": "Rua Leste",
"numero": "123",
"complemento": "Casa 1",
"latitude": "-4.8708",
"longitude": "-34.4869"
}
]'
Elementos da Requisição
nome: Nome do cliente.
-
Parâmetro obrigatório.
Tipo: String.
email: E-mail do cliente.
-
Parâmetro obrigatório.
Tipo: String.
cpf: CPF do cliente.
-
Parâmetro obrigatório.
Tipo: String.
cep: CEP do estabelecimento do cliente.
-
Parâmetro obrigatório.
Tipo: String.
uf: UF do estabelecimento do cliente.
-
Parâmetro obrigatório.
Tipo: String.
cidade: Cidade do estabelecimento do cliente.
-
Parâmetro obrigatório.
Tipo: String.
bairro: Bairro do estabelecimento do cliente.
-
Parâmetro obrigatório.
Tipo: String.
endereco: Logradouro do estabelecimento do cliente.
-
Parâmetro obrigatório.
Tipo: String.
numero: Número do estabelecimento do cliente.
-
Parâmetro obrigatório.
Tipo: String.
complemento: Complemento do endereço.
Tipo: String.
latitude: Latitude do establecimento do cliente.
-
Parâmetro obrigatório.
Tipo: String.
longitude: Longitude do estabelecimento do cliente.
-
Parâmetro 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:
{
"detail": {
"success": true,
"message": "Clientes cadastrado com sucesso"
},
"data": {
"success": [
{
"id": 12345,
"nome": "Payload exemplo",
"email": "emailexemplo@yandeh.com",
"cpf": "65793397728",
"status": "ativo",
"cep": "79621987",
"uf": "SP",
"cidade": "São Paulo",
"bairro": "Centro",
"endereco": "Rua Teste",
"numero": "123",
"complemento": "Casa 1",
"latitude": "-4.8708",
"longitude": "-34.4869"
}
],
"erro": []
}
}
Caso algum registro apresente erro, será retornado o status 207 Multi-Status.
Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Registros inseridos parcialmente com sucesso"
},
"data": {
"success": [
{
"id": 12345,
"nome": "Payload exemplo",
"email": "emailexemplo@yandeh.com",
"cpf": "65793397728",
"status": "ativo",
"cep": "79621987",
"uf": "SP",
"cidade": "São Paulo",
"bairro": "Centro",
"endereco": "Rua Teste",
"numero": "123",
"complemento": "Casa 1",
"latitude": "-4.8708",
"longitude": "-34.4869"
}
],
"erro": [
{
"erro": "Cliente já cadastrado",
"id": 4567,
"nome": "Payload exemplo2",
"email": "emailexemplo2@yandeh.com",
"cpf": "12345678910",
"status": "ativo",
"cep": "79621987",
"uf": "SP",
"cidade": "São Paulo",
"bairro": "Centro",
"endereco": "Rua Teste",
"numero": "123",
"complemento": "Casa 1",
"latitude": "-4.8708",
"longitude": "-34.4869"
}
]
}
}
PATCH Cadastro Pessoa Física
Endpoint responsável por atualizar os clientes pessoa física.
Endpoint PATCH
URL:
Sintaxe da Requisição
-
Tipo de requisição: PATCH.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
{
"nome": "Ana Silva",
"email": "anasilva@gmail.com",
"cpf": "12345678910",
"status": "ativo",
"cep": "79621987",
"uf": "SP",
"cidade": "São Paulo",
"bairro": "Centro",
"endereco": "Rua Leste",
"numero": "123",
"complemento": "Casa 1",
"latitude": "-4.8708",
"longitude": "-34.4869"
}
Exemplo :
curl --location --request PATCH '
https://yandeh-seller-integration.yandeh.com.br/cliente/pessoa-fisica/123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '{
"nome": "Ana Silva",
"email": "anasilva@gmail.com",
"cpf": "12345678910",
"status": "ativo",
"cep": "79621987",
"uf": "SP",
"cidade": "São Paulo",
"bairro": "Centro",
"endereco": "Rua Leste",
"numero": "123",
"complemento": "Casa 1",
"latitude": "-4.8708",
"longitude": "-34.4869"
}'
Elementos da Requisição
nome: Nome do cliente.
Tipo: String.
email: E-mail do cliente.
Tipo: String.
cpf: CPF do cliente.
Tipo: String.
cep: CEP do estabelecimento do cliente.
Tipo: String.
uf: UF do estabelecimento do cliente.
Tipo: String.
cidade: Cidade do estabelecimento do cliente.
Tipo: String.
bairro: Bairro do estabelecimento do cliente.
Tipo: String.
endereco: Logradouro do estabelecimento do cliente.
Tipo: String.
numero: Número do estabelecimento do cliente.
Tipo: String.
complemento: Complemento do endereço.
Tipo: String.
latitude: Latitude do establecimento do cliente.
Tipo: String.
longitude: Longitude do estabelecimento do cliente.
Tipo: String.
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": "Cliente atualizado com sucesso"
}
}
DELETE Cadastro Pessoa Física
Endpoint DELETE
Endpoint responsável por remover os clientes pessoa física.
URL:
Sintaxe da Requisição
-
Tipo de requisição: DELETE.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Parâmetros:
-
CPF - Informar os CPFs dos clientes a serem deletados.
-
Exemplo :
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/cliente/pessoa-fisica?cpf=12345678910' \
--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": "Cliente removido com sucesso"
}
}