Enviar rotas

Envia os registros de rotas cadastrados no ERP para a Plataforma Milk's.

Método POST

http://app.milksrota.com.br/api/retaguardasync/writeRota

Requisição

Dados da requisição

{
    "conta_id": "DDDDD",
    "token": "XXXX-XXXX-XXXX-XXXX",
    "data": [
        // lista de registros de produtores
    ]
}

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.

data: Lista que deve conter um ou mais registros de rotas. Cada registro de rota pode ser informando com a relação de propriedades detalhadas abaixo. Apenas os campos obrigatórios não podem ser ignorados.

Propriedades do grupo de rota

Campo

Descrição

Tipo

Obrigatório

codigo

Código da rota

Texto

SIM

nome

Nome da rota

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

tipo_descarga

Tipo de descarga padrão da rota. TP = Descarga pelo técnico pelo painel web.

Texto

Não

gruporota

Código do grupo de rota

Texto

Não

grupo_rota: O campo grupo_rota deverá ser preenchido com o mesmo código do grupo de rota já cadastrado na Plataforma Milk's. Caso seja informado um código de grupo de rota não cadastrado, a rota será cadastrada sem um vínculo com grupo de rota.

Exemplo de requisição

{
    "conta_id": XXXX, 
    "token": "0000-0000-0000-0000", 
    "data": [
        {
            "nome": "Rota MURIAE",
            "codigo": "105",
            "tipo_descarga": "TP",
            "grupo_rota": null,
            "deleted": "0"
        },    
        {
            "nome": "Rota MURIAE II ",
            "codigo": "106",
            "tipo_descarga": "TP",
            "grupo_rota": "100",
            "deleted": "1"
        }
    ]
}

Resposta

200: Importação realizada

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

Os registros foram enviados para a plataforma Milk's e importados sem erro.

200: Importação com falhas

{
    "succes": true,
    "message": "OK",
    "data": [ // Falhas de importação
        {
            "codigo": "001", // Código do grupo de rota não importado
            "error_message": "Nome não informado", // mensagem de erro
            "error_code": 40003 // código do erro
        }
    ],
    "monitor.time": 2.14737200737 // Tempo de execução
}

Os registros foram enviados para a plataforma Milk's e importados, entretanto, alguns registros não puderam ser importados.

404: Conta não localizada

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

O que isso significa? Significa que o ID da conta não foi localizado na Plataforma Milk's.

403: Token inválido

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

O que isso significa? Significa que o token informado na requisição não corresponde ao token cadastrado para a conta.

Last updated