🇧🇷
Milk's API
Português
Português
  • Plataforma Milk's
  • Milk's Rota
    • Análise de qualidade
      • Enviar resultados
    • Agente de coleta
      • Enviar agentes de coleta
      • Baixar agentes de coleta
    • Entrada Spot
      • Entrada de Leite Spot
    • Fazenda
      • Enviar fazendas
      • Baixar fazendas
    • Grupo de rota
      • Enviar grupos de rota
      • Baixar grupos de rota
    • Rota
      • Enviar rotas
      • Baixar rotas
    • Laboratório e Análise
      • Enviar indicadores
      • Baixar análise
      • Baixar resultados
    • Itinerário
      • Enviar itinerário
      • Baixar itinerário
    • Linha
      • Enviar linhas
      • Baixar linhas
    • Motivo de cancelamento
      • Enviar motivos
      • Baixar motivos
    • Ponto de coleta
      • Baixar pontos de coleta
      • Enviar pontos de coleta
    • Produtor
      • Enviar produtores
      • Baixar produtores
    • Programação de coleta
      • Enviar programação
      • Baixar programação
    • Rota
      • Enviar rota
      • Baixar rota
    • Transportadoras
      • Enviar transportadoras
      • Baixar transportadora
    • Tanque
      • Enviar tanques
      • Baixar tanques
    • Tanque coletivo
      • Enviar produtores vinculados
    • Técnico
      • Enviar técnicos
      • Baixar técnicos
    • Veículo
      • Enviar veículos
      • Baixar veículos
    • Viagens
      • Baixar viagem
      • Baixar viagem: TOTVS Datasul
      • Resumo de viagem
      • Atualizar coleta
      • Baixar coletas
      • Baixar visitas
      • Baixar visitas de uma viagem
      • Resumo de coleta
      • Coleta real
      • Enviar descarga
      • Baixar descarga
      • Baixar eventos coleta
    • Métodos auxiliares
      • Status do integrador
      • Status viagem
  • Milk's Camp
  • Milk's Farmer
    • *️⃣Categoria de produtos
      • Categorias de produtos
    • ⏺️Produtos
      • Enviar produtos
      • Baixar produtos
    • ⏹️Convênios
      • Enviar convênios
      • Baixar convênios
    • 🔡Produtos de um convênio
      • Enviar produtos do convênio
      • Baixar produtos do convênio
    • #️⃣Documentos
      • ⤴️Enviar documentos
  • Milk's Pay
    • 💱Folha
      • Listar folhas
      • Baixar folha
    • Nota fiscal
      • Registrar Nota Fiscal
Powered by GitBook
On this page
  • Requisição
  • Dados da requisição
  • Propriedades do veículo
  • Exemplo de requisição
  • Resposta
  • 200: Registros importados
  • 200: Importação com falhas
  • 404: Conta não localizada
  • 403: Token inválido
  1. Milk's Rota
  2. Veículo

Enviar veículos

Envia os registros de veículos cadastradas no ERP para a Plataforma Milk's.

Método POST

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

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 veículos
    ]
}

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 veículos. Cada registro de veículo pode ser informando com a relação de propriedades detalhadas abaixo. Apenas os campos obrigatórios não podem ser ignorados.

Propriedades do veículo

Campo

Descrição

Tipo

Obrigatório

codigo

Código do veículo

Texto

SIM

placa

placa de identificação

Texto

SIM

tipo

Identifica o veículo quanto a seu tipo: V - Veículo simples; R - Reboque (julieta)

Texto

NÃO

fabricante

Nome do fabricante do veículo

Texto

NÃO

modelo

Modelo do veículo

Texto

NÃO

cor

Cor predominante

Texto

NÃO

ano

Ano de fabricação/Modelo

Texto

NÃO

categoria_cnh

Categoria mínima de habilitação requerida para condução do veículo

Texto

NÃO

peso_bruto

Peso total do veículo

Decimal

NÃO

peso_liquido

Peso líquido do veículo

Decimal

NÃO

bloqueado

Indica se o registro deve ser bloqueado para atualizaçoes pela API:

1 (um) - Sim;

0 (zero) - Não.

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.

Texto

SIM

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": "b66c-78f2-fd62-e931",
    "doc": "99.999.999/9999-99",
    "data": [
        {
            "codigo": "5",
            "placa": "OPA-4421",
            "tipo": "V",
            "pesoBruto": "3100",
            "pesoLiquido": "17100",
            "capacidade": "14000",
            "deleted": "1"
        },
        {
            "codigo": "6",
            "placa": "AYJ-4801",
            "tipo": "V",
            "pesoBruto": "",
            "pesoLiquido": "",
            "capacidade": "",
            "deleted": "1"
        },
        {
            "codigo": "",
            "placa": "BCM-6572",
            "tipo": "V",
            "pesoBruto": "",
            "pesoLiquido": "",
            "capacidade": "",
            "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": "", // Código do veículo não importada
            "error_message": "código 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.

PreviousVeículoNextBaixar veículos

Last updated 9 months ago