> For the complete documentation index, see [llms.txt](https://docs.milksrota.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.milksrota.com.br/milks-rota/rota-1/enviar-rota.md).

# Enviar rota

> ## Método POST
>
> <http://app.milksrota.com.br/api/retaguardasync/writeRota>

## Requisição

### Dados da requisição

```javascript
{
    "conta_id": "DDDDD",
    "token": "XXXX-XXXX-XXXX-XXXX",
    "doc": "99.999.999/9999-99",
    "data": [
        // lista de registros de rotas
    ]
}
```

{% hint style="info" %}
**conta\_id**: Deve ser informado o ID da conta que você encontra na tela ***"Sua conta"*** no menu principal no painel do Milk's Rota.

**token**: Deve ser informado o Token da conta, que você encontra na tela ***"Sua conta"*** no menu principal no painel do Milk's Rota.

**doc:** Deve ser informado o CNPJ da conta cadastra. Pode ser encontrado na tela ***"Sua conta"*** no menu principal do painel Milk's Rota.

**data**: Lista que deve conter um ou mais registros de fazendas. Cada registro de fazenda pode ser informando com a relação de propriedades detalhadas abaixo. Apenas os campos obrigatórios não podem ser ignorados.
{% endhint %}

### Propriedades da rota

| **Campo**          | **Descrição**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | **Tipo** | **Obrigatório** |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------- |
| **codigo**         | Código da rota                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Texto    | SIM             |
| **nome**           | Nome da rota                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Texto    | SIM             |
| **tipo\_descarga** | <p>Indica como será feito o procedimento de liberação e descarga das viagens executas em linhas de coleta vinculadas a esta rota:  </p><p><strong>TT</strong> = Descarga por tanque pelo técnico;</p><p><strong>TC</strong> = Descarga por tanque pelo coletor;</p><p><strong>TP</strong> = Descarga por tanque pela plataforma;</p><p><strong>PT</strong> = Descarga por pesagem pelo técnico;</p><p><strong>PC</strong> = Descarga por pesagem pelo coletor;</p><p><strong>PP</strong> = Descarga por pesagem pela plataforma</p> | Texto    | SIM             |
| **deleted**        | Se o registro deve ser excluído. Se enviar o valor **1** ele será excluído caso já exista na plataforma. Se for enviado **0** ele será reativado na plataforma.                                                                                                                                                                                                                                                                                                                                                                     | Número   | SIM             |
| grupo              | Código do grupo de rotas ao qual esta rota está vinculada                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Texto    | NÃO             |

{% hint style="info" %}
**codigo**: O campo código deverá ser preenchido com o mesmo código  já cadastrado no ERP, esta propriedade é utilizada para localizar os registros na base de dados da Plataforma Milk's e direcionar as operações CRUD.

A propriedade ***"deleted"*** é utilizada para comandar o processo de atualização, inclusão ou exclusão lógica do registro. Caso seu valor seja **"0" (zero)** e o registro não tenha sido encontrado, ele será criado. Se for encontrado, o valor será atualizado e se o valor for "**1" (um)**, o conteúdo será excluído logicamente da base de dados.&#x20;
{% endhint %}

### Exemplo de requisição

```javascript
{
    "conta_id": 99999,
    "token": "aa4e-15c1-2f69-a734",
    "data": [
        {
            "codigo": "01",
            "gruporota": "01",
            "nome": "GERAL",
            "tipo_descarga": "TP",
            "deleted": "0"
        },
        {
            "codigo": "02",
            "gruporota": "01",
            "nome": "POSTO 1",
            "tipo_descarga": "TP",
            "deleted": "0"
        },
        {
            "codigo": "03",
            "gruporota": "",
            "nome": "FAST COLETA TRANSPORTE",
            "tipo_descarga": "TP",
            "deleted": "0"
        }
    ]
}
```

## Resposta

### 200: Registros importados

```javascript
{
  "succes": true,
    "message": "OK",
    "data": [],
    "monitor.time": 2.14737200737 // Tempo de execução
}  
```

{% hint style="success" %}
Os registros foram enviados para a Plataforma Milk's e importados sem erro.
{% endhint %}

### 200: Importação com falhas

```javascript
{
    "succes": true,
    "message": "OK",
    "data": [ // Falhas de importação
        {
            "codigo": "03", // Código da rota não importada
            "error_message": "código do grupo de rotas inválido", // mensagem de erro
            "error_code": 40003 // código do erro
        }
    ],
    "monitor.time": 2.14737200737 // Tempo de execução
}
```

{% hint style="info" %}
Os registros foram enviados para a Plataforma Milk's e importados, entretanto, alguns registros não puderam ser importados.
{% endhint %}

### 404: Conta não localizada&#x20;

```javascript
{    
    "success": false,
    "message": "Conta não localizada",
    "data": [],
    "monitor.time": 2.14737200737 // Tempo de execução
}
```

{% hint style="danger" %}
**O que isso significa?** Significa que o ID da conta não foi localizado na Plataforma Milk's.
{% endhint %}

### 403: Token inválido

```javascript
{
    "success": false,
    "message": "Token inválido",
    "data": [],
    "monitor.time": 2.14737200737 // Tempo de execução
}
```

{% hint style="danger" %}
**O que isso significa?** Significa que o token informado na requisição não corresponde ao token cadastrado para a conta.
{% endhint %}