Enviar agentes de coleta

Envia os registros de agentes de coleta (Motoristas) cadastradas no ERP para a Plataforma Milk's.

Método POST

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

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 agentes de coleta (motoristas)
    ]
}

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

Propriedades do agente de coleta

Campo

Descrição

Tipo

Obrigatório

codigo

Código do agente

Texto

SIM

nome

Nome do agente de coleta

Texto

SIM

rg

Documento de identidade

Texto

NÃO

cpf

Registro de pessoa física

Texto

NÃO

cnh

Número da carteira de habilitação

Texto

NÃO

categoria_cnh

Categoria da carteira de habilitação

Texto

NÃO

vencimento_cnh

Data de vencimento da habilitação

Data

NÃO

telefone

Telefone de contato

Texto

NÃO

email

E-mail de contato do agente

Texto

NÃO

transportadora

Código da transportadora

Texto

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": 9999,
    "token": "s0637r",
    "doc": "99.999.999/9999-90",
    "data": [
        {
            "codigo": "C-1010",
            "nome": "Coletor_C1010",
            "deleted": "0"
        },
        {
            "codigo": "C-1020",
            "nome": "Coletor_C1020",
            "deleted": "0"
        },
        {
            "codigo": "C-1030",
            "nome": "Coletor_C1030",
            "deleted": "0"
        },
        {
            "codigo": "C-1040",
            "nome": "",
            "deleted": "0"
        },
    ]
}

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": "C-1040", // Código do agente não importado
            "error_message": "Nome 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