API de Demander: rutas y clientes de rutas

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar rutas y clientes de rutas.

Rutas

Consulta de ruta

Enumera las rutas de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

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

Precaución

Filtros

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

Retorno:

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

Insertar o actualizar Ruta

POST inserción mediante la tecla codigo + codVendedor.

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

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	entero		✓	Código de ruta. Inserte la parte clave con codVendedor.
codVendedor	entero		✓	Código de vendedor de ruta. Parte de la clave upsert.
descripción	cadena	100	✓	Nombre de la ruta.
activo	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 1.

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devolver 201.

Actualización

• La clave codigo+codVendedor es obligatoria. Devuelve 200.

Cuerpo:

{
  "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"
}

Eliminar ruta

Elimina la ruta y los clientes vinculados a ella.

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

Retorno:

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

Clientes de Rota

Consulta al cliente de Rota

Enumera los clientes vinculados a una ruta.

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

Precaución

Parámetros

• codRota — obligatorio
• codVendedor — obligatorio

Retorno:

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

Insertar o actualizar Route Client

POST inserción por tecla codRota + codVendedor + codCliente + cpfCNPJCliente.

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

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
codRota	entero		✓	Código de ruta. Parte de la clave upsert.
codVendedor	entero		✓	Código de vendedor. Parte de la clave upsert.
codCliente	entero		✓	Código de cliente. Parte de la clave upsert.
cpfCNPJCliente	cadena	100	✓	Cliente CPF/CNPJ. Parte de la clave upsert.
posición	entero		✓	Pedido del cliente en ruta.
activo	entero		✓	Valores: 0 o 1.

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devolver 201.

Actualización

• La clave codRota+codVendedor+codCliente+cpfCNPJCliente es obligatoria.
• En la actualización, solo se cambian posicao y/o ativo. Devuelve 200.

Cuerpo:

{
  "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"
}

Eliminar cliente de la ruta

Elimina el enlace del cliente a la ruta.

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

Retorno:

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