Demander API - Routes and Route Customers

This article is part of the REST Integration API documentation.

Documentation for querying, inserting, updating and deleting routes and route customers.

Routes

Route Query

Lists the company’s routes. Without filter, considers dataAlteracao from the last 6 months.

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

Caution

Filters

• filtroDataAlteracao — format Y-m-d
• operadorFiltro (optional) — <, >, =, <=, >= (default >=)

Return:

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

Insert or update Route

POST upsert by key codigo + codVendedor.

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

Property	Type	Size	Mandatory	Description
code	int		✓	Route code. Upsert key part with codVendedor.
codVendedor	int		✓	Route seller code. Part of the upsert key.
description	string	100	✓	Route name.
active	int			Values: 0 or 1. Default on inclusion: 1.

Caution

Inclusion

• It is necessary to send all attributes that are mandatory. Return 201.

Update

• The key codigo+codVendedor is mandatory. Return 200.

Body:

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

Return:

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

Delete Route

Removes the route and the customers linked to it.

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

Return:

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

Rota Customers

Rota Customer Consultation

Lists customers linked to a route.

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

Caution

Parameters

• codRota — mandatory
• codVendedor — mandatory

Return:

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

Insert or update Route Client

POST upsert by key codRota + codVendedor + codCliente + cpfCNPJCliente.

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

Property	Type	Size	Mandatory	Description
codRota	int		✓	Route code. Part of the upsert key.
codVendedor	int		✓	Seller code. Part of the upsert key.
codCliente	int		✓	Customer code. Part of the upsert key.
cpfCNPJCliente	string	100	✓	Customer CPF/CNPJ. Part of the upsert key.
position	int		✓	Customer order on route.
active	int		✓	Values: 0 or 1.

Caution

Inclusion

• It is necessary to send all attributes that are mandatory. Return 201.

Update

• The key codRota+codVendedor+codCliente+cpfCNPJCliente is mandatory.
• In the update, only posicao and/or ativo are changed. Return 200.

Body:

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

Return:

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

Delete Customer from Route

Removes the client’s link to the route.

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

Return:

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