Endpoints responsáveis pela definição e roteirização das agendas dos vendedores.
Início > Calendário de Visitas
Versão: 2.0
Calendário de Visitas
POST Calendário de Visitas
Endpoint responsável pelo cadastro e atualização das rotas dos vendedores.
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:
Respostas para erros
Caso algum dos registros enviados apresente erro, ele será retornado no campo
"failures"
422 Validation Error
[
{
"cliente": "34719089000162",
"consultor": "consultor@yandeh.com.br",
"codigo_consultor": "123456",
"data_visita": [
{
"data": "2023-01-01T00:00:00",
"ordenacao": 1
},
{
"data": "2023-03-03T00:00:00",
"ordenacao": 1
}
]
}
]
Exemplo:
curl --location '
https://yandeh-seller-integration.yandeh.com.br/v2/calendario_de_visitas' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '[
{
"cliente": "04039770000507",
"consultor": "ana@gmail.com.br",
"data_visita": [
{
"data": "2025-01-29T00:00:00",
"ordenacao": 1
},
{
"data": "2025-02-03T00:00:00",
"ordenacao": 1
}
]
},
{
"cliente": "318060106000128",
"consultor": "ana@gmail.com.br",
"data_visita": [
{
"data": "2025-01-29T00:00:00",
"ordenacao": 2
}
]
}
]'
Elementos da Requisição
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200.Exemplo de retorno:
cliente: Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente.
-
Campo obrigatório.
Tipo: String
consultor: Endereço de e-mail do consultor.
-
Campo obrigatório.
Tipo: String
codigo_consultor: Código do consultor cadastrado no fornecedor.
Tipo: String.
data_visita: Array contendo os registros de visitas a serem cadastradas.
data: Data e hora programada da visita.
-
Campo obrigatório.
Tipo: datetime.
ordenacao: Define a ordem de execução das visitas pelo consultor.
Tipo: Integer.
{
"created": [
1,
5,
7,
9
],
"updated": [
1,
5,
7,
9
],
"failures": []
}
{
"created": [
1,
5,
7,
9
],
"updated": [
1,
5,
7,
9
],
"failures": [
{
"error_type": "permissao-negada",
"readable_message": "Permissão negada",
"additional_data": [
"calendario_visita_create"
]
}
]