API do Demander - Rotas e Clientes da Rota

Este artigo faz parte da documentação da API de Integração REST.

Documentação para consultar, inserir, atualizar e excluir rotas e clientes da rota.

Rotas

Consulta de Rotas

Lista as rotas da empresa. Sem filtro, considera dataAlteracao dos últimos 6 meses.

Rota: {host}/public/v1/rotas?filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Cuidado

Filtros

• filtroDataAlteracao — formato Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (padrão >=)

Retorno:

[
  {
    "codigo": 100,
    "codVendedor": 78123,
    "descricao": "RT LAJEADO",
    "ativo": 1,
    "dataAlteracao": "2025-06-01 14:30:00"
  }
]

Inserir ou atualizar Rota

POST upsert pela chave codigo + codVendedor.

Rota: {host}/public/v1/rotas
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	int		✓	Código da rota. Parte da chave de upsert com codVendedor.
codVendedor	int		✓	Código do vendedor da rota. Parte da chave de upsert.
descricao	string	100	✓	Nome da rota.
ativo	int			Valores: 0 ou 1. Padrão na inclusão: 1.

Cuidado

Inclusão

• É necessário enviar todos os atributos que são obrigatórios. Retorno 201.

Atualização

• A chave codigo+codVendedor é obrigatória. Retorno 200.

Body:

{
  "codigo": 100,
  "codVendedor": 78123,
  "descricao": "RT LAJEADO",
  "ativo": 1
}

Retorno:

{
  "codigo": 100,
  "codVendedor": 78123,
  "descricao": "RT LAJEADO",
  "ativo": 1,
  "dataAlteracao": "2025-06-02 10:00:00"
}

Excluir Rota

Remove a rota e os clientes vinculados a ela.

Rota: {host}/public/v1/rotas?codigo={codigo}&codVendedor={codVendedor}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}

Clientes da Rota

Consulta de Clientes da Rota

Lista os clientes vinculados a uma rota.

Rota: {host}/public/v1/rotas/clientes?codRota={codRota}&codVendedor={codVendedor}
Método: GET

Cuidado

Parâmetros

• codRota — obrigatório
• codVendedor — obrigatório

Retorno:

[
  {
    "codRota": 100,
    "cpfCNPJCliente": "261.840.230-80",
    "codCliente": 64068,
    "posicao": 1,
    "codVendedor": 78123,
    "ativo": 1,
    "dataAlteracao": "2025-06-01 14:30:00"
  }
]

Inserir ou atualizar Cliente da Rota

POST upsert pela chave codRota + codVendedor + codCliente + cpfCNPJCliente.

Rota: {host}/public/v1/rotas/clientes
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codRota	int		✓	Código da rota. Parte da chave de upsert.
codVendedor	int		✓	Código do vendedor. Parte da chave de upsert.
codCliente	int		✓	Código do cliente. Parte da chave de upsert.
cpfCNPJCliente	string	100	✓	CPF/CNPJ do cliente. Parte da chave de upsert.
posicao	int		✓	Ordem do cliente na rota.
ativo	int		✓	Valores: 0 ou 1.

Cuidado

Inclusão

• É necessário enviar todos os atributos que são obrigatórios. Retorno 201.

Atualização

• A chave codRota+codVendedor+codCliente+cpfCNPJCliente é obrigatória.
• Na atualização, apenas posicao e/ou ativo são alterados. Retorno 200.

Body:

{
  "codRota": 100,
  "codVendedor": 78123,
  "codCliente": 64068,
  "cpfCNPJCliente": "261.840.230-80",
  "posicao": 1,
  "ativo": 1
}

Retorno:

{
  "codRota": 100,
  "cpfCNPJCliente": "261.840.230-80",
  "codCliente": 64068,
  "posicao": 1,
  "codVendedor": 78123,
  "ativo": 1,
  "dataAlteracao": "2025-06-02 10:00:00"
}

Excluir Cliente da Rota

Remove o vínculo do cliente com a rota.

Rota: {host}/public/v1/rotas/clientes?codRota={codRota}&codVendedor={codVendedor}&codCliente={codCliente}&cpfCNPJCliente={cpfCNPJCliente}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}