Enviar linhas

Envia os registros de linhas de coleta cadastradas no ERP para a Plataforma Milk's.

Método POST

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

Requisição

Dados da requisição

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

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.

Propriedades da linha

Campo

Descrição

Tipo

Obrigatório

codigo

Código da linha

Texto

SIM

nome

Nome da linha

Texto

SIM

rota

Código da rota em que a linha está associada

Texto

SIM

distancia

Distância em KM total da linha de coleta

Número

NÃO

km_adicional

Quantidade de quilômetros(km) que o sistema deve adicionar a linha de coleta quando o rastreamento estiver habilitado

Número

NÃO

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

bloqueado

Indica se o registro deve ser bloqueado para atualizações pela API: "1" (um) - Sim; "0" (zero) - Não.

Texto

NÃO

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.

Exemplo de requisição

{
"conta_id":99999,
"token":"s0637r",
"doc":"99.999.999/9999-99",
"data":[{
	"codigo":"L-2010",
	"rota":"002",
	"nome":"Linha_L2010" ,
	"deleted":"0"
	},
	{
	"codigo":"L-2020",
	"rota":"002",
	"nome":"Linha_L2020",
	"deleted":"0"
	},
	{
	"codigo":"L-2030",
	"rota":"",
	"nome":"Linha_L2030",
	"deleted":"0"
	}
	]
	
}

Resposta

200: Registros importados

{
  "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": "L-2030", // Código da linha não importada
            "error_message": "código da rota inválido", // 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