====== GET - Consulta transportadoras ======

Este método consulta o cadastro de transportadoras do Prosyst. Na consulta geral, os filtros informados no corpo da requisição são combinados entre si: a transportadora precisa atender a todos eles. Filtro não informado não restringe a consulta. Quando nenhuma situação é informada, são retornados somente os cadastros **ativos**. A consulta não é paginada: todas as transportadoras que atendem aos filtros são retornadas de uma vez.

A consulta por código retorna somente a transportadora informada na URL, inclusive quando o cadastro está **cancelado**.

===== Exemplo URL =====

Consulta geral:

<code>
api/transportadora
</code>

Consulta de uma transportadora:

<code>
api/transportadora/{codigo}
</code>

===== Parâmetros da URL =====

^Nome^Tipo^Descrição^Obrigatório?^
|codigo|Long|Código da transportadora no Prosyst. Utilizado somente na consulta por código.|Não|

===== Parâmetros do Header =====

^Nome^Descrição^
|auth|Token adquirido no [[:enduser:erp:developer:integracao:integracaowebservice:primeirospassos:login|Login]].|
|Content-Type|application/json|

===== Parâmetros do Body =====

^Nome^Tipo^Descrição^Obrigatório?^
|Codigos|Array de Long|Códigos das transportadoras no Prosyst.|Não|
|Nome|String|Parte do nome da transportadora. A comparação não diferencia maiúsculas e minúsculas.|Não|
|Documentos|Array de String|CPF ou CNPJ das transportadoras, com ou sem máscara.|Não|
|Situacao|String|Situação do cadastro: **ativo** ou **cancelado**. Quando não informada, considera **ativo**.|Não|
|DataAlteracaoInicial|String|Retorna as transportadoras alteradas a partir desta data. Formatos aceitos: dd-MM-yyyy ou yyyy-MM-ddTHH:mm:ss.|Não|

O corpo da requisição é usado somente na consulta geral. Na consulta por código, a transportadora é localizada apenas pelo código informado na URL.

===== Exemplo de Body =====

<code json>
{
    "Codigos": [1, 2],
    "Nome": "transportes",
    "Documentos": ["11.222.333/0001-81", "11222333000181"],
    "Situacao": "ativo",
    "DataAlteracaoInicial": "01-01-2026"
}
</code>

===== Sucesso =====

As duas consultas retornam o mesmo formato: uma lista de transportadoras em **dados**. Na consulta por código, a lista tem uma única transportadora.

<code json>
{
    "bemSucedido": true,
    "mensagemFalha": null,
    "novoCodigo": null,
    "dados": [
        {
            "codigoTransportadora": 1,
            "descricao": "TRANSPORTES EXEMPLO LTDA",
            "situacao": 0,
            "descricaoSituacao": "Ativo",
            "cpfCnpj": "11.222.333/0001-81",
            "inscricaoEstadual": "255123456",
            "endereco": "RUA EXEMPLO, 1000",
            "bairro": "CENTRO",
            "cEP": "89040000",
            "codMunicipio": 4202404,
            "municipio": "BLUMENAU",
            "estado": "SC",
            "fone": "4733220000",
            "email": "contato@exemplo.com.br",
            "codigoFornecedor": 5001,
            "nomeFornecedor": "TRANSPORTES EXEMPLO LTDA",
            "codigoContador": 12,
            "nomeContador": "CONTABILIDADE EXEMPLO",
            "codigoRNTRC": 12345678,
            "quantidadePaletesGiro": 50,
            "transportadoraPropria": false,
            "transportadoraCooperada": false,
            "naoContribuinteICMS": false,
            "consideraDestinatarioNF": false,
            "dataCadastro": "2024-03-10T00:00:00",
            "dataAlteracao": "2026-01-15T00:00:00"
        }
    ]
}
</code>

^Campo^Descrição^
|situacao|Situação do cadastro: 0 = Ativo, 9 = Cancelado.|
|cpfCnpj|CPF ou CNPJ da transportadora, formatado com máscara.|
|codigoFornecedor / nomeFornecedor|Fornecedor vinculado à transportadora.|
|codigoContador / nomeContador|Contador vinculado à transportadora.|
|transportadoraPropria|Indica se a transportadora é própria.|
|transportadoraCooperada|Indica se a transportadora é cooperada.|
|naoContribuinteICMS|Indica se a transportadora não é contribuinte de ICMS.|
|consideraDestinatarioNF|Indica se os dados cadastrais considerados são os do destinatário da nota fiscal.|

===== Erros =====

^HTTP^Situação^Mensagem^
|400|Filtro com valor inválido (data fora dos formatos aceitos ou situação diferente de ativo/cancelado).|Algumas validações para a consulta de transportadoras não foram bem-sucedidas. Consulte os detalhes para mais informações.|
|400|Corpo da requisição em formato inválido.|Payload inválido ou incompatível com o modelo!|
|404|Código informado na URL não é numérico.|Código de transportadora inválido: {codigo}.|
|404|Transportadora não encontrada.|Transportadora inexistente no Prosyst.|

<code json>
{
    "bemSucedido": false,
    "mensagemFalha": "Transportadora inexistente no Prosyst.",
    "novoCodigo": null,
    "dados": null
}
</code>