API de Demander: transportadores

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

Documentación para consultar, insertar, actualizar y eliminar transportistas.

Consulta

Enumere los transportistas de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

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

Retorno:

{
  "transportadoras": [
    {
      "codigo": "3",
      "descricao": "Transportadora Sul",
      "ativo": 1,
      "cnpj": "12345678/0001-23",
      "codCidade": 45654,
      "endereco": "Rua Araça, 841",
      "telefone": "51999654501",
      "codTipoTransportadora": 1,
      "dataAlteracao": "2026-07-24 10:00:00"
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla codigo.

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

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	cadena	15	✓	Código de operador. Identificador único utilizado para insertar o actualizar (upsert).
descripción	cadena	500	✓	Nombre/descripción del transportista.
activo	entero			Valores: `0` o `1`. Valor predeterminado de inclusión: `1`.
cnpj	cadena	18		CNPJ del transportista.
codCidade	entero			Código de ciudad en Demander.
dirección	cadena	255		Dirección del transportista.
teléfono	cadena	30		Teléfono del transportista.
codTipoTransportadora	entero			Valores: `0` Transportista/Reenvío, `1` Transportista, `2` Redespacho. Valor predeterminado de inclusión: `0`.

Cuerpo:

{
  "codigo": "3",
  "descricao": "Transportadora Sul",
  "ativo": 1,
  "cnpj": "12345678/0001-23",
  "codCidade": 45654,
  "endereco": "Rua Araça, 841",
  "telefone": "51999654501",
  "codTipoTransportadora": 1
}

Retorno:

{
  "codigo": "3",
  "descricao": "Transportadora Sul",
  "ativo": 1,
  "cnpj": "12345678/0001-23",
  "codCidade": 45654,
  "endereco": "Rua Araça, 841",
  "telefone": "51999654501",
  "codTipoTransportadora": 1,
  "dataAlteracao": "2026-07-24 10:00:00"
}

Eliminar

Retire el transportador.

Rota: {host}/public/v1/transportadoras?codigo={codigo}
Método: DELETE

Retorno:

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