Skip to main content
Skip table of contents

Listagem de transportadores

Esta funcionalidade permite que um usuário administrador busque a lista de transportadores cadastrados no sistema. Os dados dos transportadores 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.
Como utilizar o Postman para fazer a autenticação do identity?

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

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

image.png

Dados Disponibilizados
Os dados retornados para cada transportador incluem:

  • id → ID (Uniqueidentifier)

  • displayName → Nome de Exibição

  • companyName → Nome da Empresa

  • domainNameXid → Identificação TMS

  • nationalRegistry → Registro Nacional (CNPJ/CPF)

  • carrierType → Tipo de Transportador

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

CODE
[
    {
        "id": "52049280-d599-e911-80d2-00155d96372d",
        "displayName": "C..........S",
        "companyName": "C..........S",
        "domainNameXid": "EMBDEV.26308125000177",
        "nationalRegistration": "2..........7",
        "carrierType": "ETC Equiparado"
    },
    {
        "id": "2761a89a-d599-e911-80d2-00155d96372d",
        "displayName": "B......A",
        "companyName": "B......A",
        "domainNameXid": "EMBDEV.01899247590",
        "nationalRegistration": "0.........0",
        "carrierType": "TAC"
    },
    {
        "id": "a65fb8ab-d599-e911-80d2-00155d96372d",
        "displayName": "D.....L",
        "companyName": "D.....L",
        "domainNameXid": "EMBDEV.CAR-12521",
        "nationalRegistration": "0.............7",
        "carrierType": "ETC Normal"
    }
]

As informações de "displayName" , "companyName", "nationalRegistration", foram censuradas por conter dados sensíveis.

Em um caso em que um ambiente frete não exista nenhum transportador cadastrado, será retornado uma lista vazia.

{{component-feedback-article}}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.