Listagem de filiais

Esta funcionalidade permite que um usuário administrador busque a lista de filiais cadastradas no sistema. Os dados das filiais podem ser utilizados no momento do cadastramento ou edição dos dados do usuário.

Autenticação
Para acessar este endpoint, é necessário que o usuário esteja autenticado. A autenticação é feita através de um token JWT, que deve ser enviado no cabeçalho da requisição.

Endpoint
Base URL: A base URL varia conforme o cliente.
Path do Endpoint: shipper-api/api/UsersExternalProvider/Branches
Método HTTP: GET

Exemplo de Requisição
Veja um exemplo de como configurar a URL no Postman:

Dados Disponibilizados
Os dados retornados para cada filial incluem:

id → ID (Uniqueidentifier)
displayName → NomeExibicao
companyName → RazaoSocial
nationalRegistry → CNPJ
domainNameXid → Identificação TMS
isParentCompany → Tipo (Se é matriz ou filial)

Exemplo de Retorno
Segue um exemplo de retorno JSON para a requisição:

CODE

[
    {
        "id": "c2cea1f3-d84e-e811-80d5-00155dfca711",
        "displayName": "filial 12",
        "companyName": "filial 12",
        "nationalRegistry": "05..........0",
        "domainNameXid": "EMBDEV.ORG-154-211",
        "isParentCompany": false,
        "municipalRegistration": null
    },
    {
        "id": "acf580a5-f997-4dd9-8637-3f348416e9eb",
        "displayName": "matriz 12",
        "companyName": "matriz 12",
        "nationalRegistry": "052.........0",
        "domainNameXid": "EMBDEV.ORG-8027-30018",
        "isParentCompany": true,
        "municipalRegistration": "7......4"
    }
]

As informações de "nationalRegistry" e "municipalRegistration" foram censuradas por conter dados sensíveis.

Em um caso em que um ambiente frete não possua nenhuma filial cadastrada, será retornado uma lista vazia.