# Transportadoras

## Consultando as transportadoras

Envie uma requisição GET para o endpoint de transportadoras:

{% code title="Endpoint transportadoras" %}

```url
https://api.logapi.com.br/carriers
```

{% endcode %}

Retornaremos um array completo com todos os dados de cada uma das tranportadoras, contendo:

* `carrierName` que você precisará para consultar o rastreamento.
* `integrationFields` para você saber quais credenciais de autentiação são necessárias.
* `trackingFields` para saber quais dados podem ser utilizados para rastrear entregas.
* `logo` com a imagem em PNG da logo da transportadora
* `statusMappings` que são os status da transportadora convertidos para o padrão LogAPI. 

Exemplo de objeto de transportadora:

```json
{
        "active": true,
        "logo_visibility": true,
        "_id": "655ebb94d08d04a86df31c0e",
        "carrierName": "total-express",
        "trackingFields": [
            {
                "fieldName": "trackingCode",
                "fieldType": "string",
                "required": false,
                "description": "Código de Rastreamento (AWB)",
                "_id": "655ebb94d08d04a86df31c0f"
            },
            {
                "_id": "672d6de260d4816f00fffa6a",
                "fieldName": "invoiceNumber",
                "fieldType": "string",
                "required": false,
                "description": "Número da Nota Fiscal"
            },
            {
                "_id": "672d6de260d4816f00fffa6b",
                "fieldName": "orderNumber",
                "fieldType": "string",
                "required": false,
                "description": "Número do Pedido"
            }
        ],
        "integrationFields": [
            {
                "fieldName": "reid",
                "fieldType": "string",
                "required": true,
                "_id": "655ebb94d08d04a86df31c10"
            },
            {
                "fieldName": "usuario",
                "fieldType": "string",
                "required": true,
                "_id": "655ebb94d08d04a86df31c11"
            },
            {
                "fieldName": "senha",
                "fieldType": "string",
                "required": true,
                "_id": "655ebb94d08d04a86df31c12"
            }
        ],
        "createdAt": "2023-11-23T02:40:20.586Z",
        "updatedAt": "2024-06-02T20:43:14.408Z",
        "logo": "https://api.logapi.com.br/public/carrier/total-express.png",
        "statusMappings": [
            {
                "carrier_status": "57",
                "logapi_status": "PendingPostage",
                "_id": "65e76a469ec7c33756bbaa64"
            },
            {
                "carrier_status": "99",
                "logapi_status": "PendingPostage",
                "_id": "65e76a469ec7c33756bbaa65"
            },
            {
                "carrier_status": "100",
                "logapi_status": "PendingPostage",
                "_id": "65e76a469ec7c33756bbaa66"
            },
            {
                "carrier_status": "82",
                "logapi_status": "PendingPostage",
                "_id": "65e76a469ec7c33756bbaa67"
            },
            {
                "carrier_status": "60",
                "logapi_status": "InTransit",
                "_id": "65e76a469ec7c33756bbaa68"
            },
            {...}
     ],
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ajuda.logapi.com.br/intergrando-logapi/transportadoras.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.