API do Demander - Transportadoras

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

Documentação para consultar, inserir, atualizar e excluir transportadoras.

Consulta

Lista as transportadoras da empresa. Sem filtro, considera dataAlteracao dos ú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"
    }
  ]
}

Inserir ou atualizar

POST upsert pela chave codigo.

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

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	string	15	✓	Código da transportadora. Identificador único usado para inserir ou atualizar (upsert).
descricao	string	500	✓	Nome/descrição da transportadora.
ativo	int			Valores: `0` ou `1`. Padrão na inclusão: `1`.
cnpj	string	18		CNPJ da transportadora.
codCidade	int			Código da cidade no Demander.
endereco	string	255		Endereço da transportadora.
telefone	string	30		Telefone da transportadora.
codTipoTransportadora	int			Valores: `0` Transportadora/Redespacho, `1` Transportadora, `2` Redespacho. Padrão na inclusão: `0`.

Body:

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

Excluir

Remove a transportadora.

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

Retorno:

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