top of page
Início > Calendário de Visitas > Post Calendário de Visitas
Versão: 1.0

Post Calendário de Visitas

Última Atualização: 28/02/2024

O post calendário de visitas permite que sejam adicionados novas visitas para os vendedores aos varejistas, bem como as possibilidade de editar estas visitas.
Uma visita que ainda não tenha sido adicionada, será enviada e agendada.

Uma visita que já tenha sido adicionada, será atualizada.

Endpoint Post

Sintaxe da Requisição

Para que a requisição do método Post seja bem-sucedida, é necessário que

seja passado os seguintes valores dentro de um JSON:

Elementos da Requisição

cliente

ID do cliente.

Tipo: String.

consultor

E-mail do Consultor.

Tipo: String.

codigo_consultor

Código do consultor.

Tipo: String.

data_visita

Tipo: Array com JSONs.

data

Data e hora da visita. Está data não pode ser um dia que já tenha passado.

Tipo: DateTime

ordenacao

Ordem das visitas que serão realizadas pelo consultor naquele dia(1 = primeira visita do dia, 2 = segunda visita... E por assim em diante).

Tipo: Integer

Sintaxe da Resposta

Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:

Elementos da Resposta

created

IDs dos calendários que foram criados.

Tipo: Array.

updated

IDs dos calendários que foram atualizados.

Tipo: Array.

failures

Tipo: Array.

error_type

Tipo do erro que pode ter acontecido durante a requisição.

Tipo: String

readable_message

Mensagem para explicar o tipo de erro dependendo do que possa aparecer no "error_type".

Tipo: String.

additional_data

Dados adicionais sobre o erro.

Tipo: Array.

Respostas para erros

Caso ocorra algum erro durante a requisição, os possíveis erros são:

422 Validation Error

bottom of page