Ajustes da API Aciona ONE

ajustes-aciona-one.md

API aciona one

API do aplicativo Aciona ONE.

Filas

Conteúdo relacionado a filas e tipos.

Obter todas as filas de vendas

Alterações

• Criar tarefa para criar endpoint para listar as filas de atendimento de vendas.

Endpoint

  GET v1/vendas/filas

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": [
        {
            "idFila": 1,
            "descricao": "Agendamento de Interesse"
        },
        {
            "idFila": 2,
            "descricao": "Agendamento Finalização Venda"
        },
        {
            "idFila": 3,
            "descricao": "Agendamento Retirar Mercadoria"
        },
        {
            "idFila": 4,
            "descricao": "Agendamento de Interesse"
        }
    ]
}

Obter fila de vendas por tipo

Alterações

• Remover id do usuário da URL do endpoint.
• O id do usuário deve ser recuperado através do token de acesso.

Endpoint

  GET v1/vendas/filas/{idTipoFila}

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
idTipoFila	Obrigatório. Id do tipo de fila.

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": [
        {
            "nome": "João da Silva",
            "cpfCnpj": "123.456.789-00",
            "tipoDeAcionamento": "Agendamento de Interesse",
            "dataHora": "2023-09-15 14:00:00"
        },
        {
            "nome": "Maria Souza",
            "cpfCnpj": "987.654.321-00",
            "tipoDeAcionamento": "Agendamento Finalização Venda",
            "dataHora": "2023-09-16 10:30:00"
        },
        {
            "nome": "Carlos Pereira",
            "cpfCnpj": "111.222.333-44",
            "tipoDeAcionamento": "Agendamento Retirar Mercadoria",
            "dataHora": "2023-09-17 15:45:00"
        },
        {
            "nome": "Ana Rodrigues",
            "cpfCnpj": "555.666.777-88",
            "tipoDeAcionamento": "Agendamento de Interesse",
            "dataHora": "2023-09-18 09:15:00"
        }
    ]
}

Obter fila de vendas por tipo de fila e tipo de acionamento

Alterações

• Remover id do usuário da URL do endpoint.
• O id do usuário deve ser recuperado através do token de acesso.

Endpoint

  GET v1/vendas/filas/{idTipoFila}/{idTipoAcionamento}

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
idTipoFila	Obrigatório. Id do tipo de fila.
idTipoAcionamento	Obrigatório. Id do tipo de acionamento.

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": [
        {
            "nome": "João da Silva",
            "cpfCnpj": "123.456.789-00",
            "tipoDeAcionamento": "Agendamento de Interesse",
            "dataHora": "2023-09-15 14:00:00"
        },
        {
            "nome": "Ana Rodrigues",
            "cpfCnpj": "555.666.777-88",
            "tipoDeAcionamento": "Agendamento de Interesse",
            "dataHora": "2023-09-18 09:15:00"
        }
    ]
}

Clientes

Conteúdo relacionado a Clientes e seus dados.

Obter cliente por CPF

Alterações

• Buscar dados básicos do cliente

Endpoint

  GET v1/vendas/clientes/{cpf}

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
cpf	Obrigatório. CPF do cliente.

Retorno

• 200

{
    "erro": false,
    "mensagem": "Sucesso.",
    "dados": {
        "idCliente": 1,
        "nome": "João da Silva",
        "cpfCnpj": "123.456.789-00"
    }
}

• 404

{
    "erro": false,
    "mensagem": "Cliente não encontrado",
}

• 500

{
    "erro": true,
    "mensagem": "Erro inesperado.",
}

Obter telefones do cliente por id

Alterações

• Alterar para o dominio clientes

Endpoint

  GET v1/vendas/clientes/{idCliente}/telefones

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
idCliente	Obrigatório. Id do cliente.

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": [
        {
            "telefone": "(55)95555-5555",
            "tipo": "Pessoal"
        },
        {
            "telefone": "(55)5555-5555",
            "tipo": "Comercial"
        }
    ]
}

Obter limites do cliente por id

Alterações

• Alterar para o dominio clientes

Endpoint

  GET v1/vendas/clientes/{idCliente}/limites

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
idCliente	Obrigatório. Id do cliente.

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": {
        "status": "sucesso",
        "validadeCadastro": "2023-12-31",
        "limiteCrediarioTotal": 5000.0,
        "limiteCrediarioDisponivel": 2500.0,
        "validadeCrediario": "2023-12-31",
        "cashbackDisponivel": 100.0,
        "vigenciaCashback": "2023-12-31"
    }
}

Obter produtos desejados do cliente por id

Alterações

• Alterar para o dominio clientes

Endpoint

  GET v1/vendas/clientes/{idCliente}/produtos-desejados

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
idCliente	Obrigatório. Id do cliente.

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": [
        {
            "produto": "Produto Desejável",
            "caracteristicas": "Características do Produto",
            "marca": "Marca do Produto",
            "valor": 199.99,
            "dataIntencaoCompra": "2023-09-25",
            "mesIntencaoCompra": "setembro"
        },
        {
            "produto": "Produto Desejável",
            "caracteristicas": "Características do Produto",
            "marca": "Marca do Produto",
            "valor": 199.99,
            "dataIntencaoCompra": "2023-09-25",
            "mesIntencaoCompra": "setembro"
        }
    ]
}

Obter cliques do cliente por id

Alterações

• Alterar para o dominio clientes

Endpoint

  GET v1/vendas/clientes/{idCliente}/cliques

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
idCliente	Obrigatório. Id do cliente.

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": [
        {
            "codigoLoja": "C001",
            "loja": "Loja 1",
            "codigoVendedor": "C001",
            "vendedor": "João Silva",
            "produtos": [
                {
                    "codigoProduto": "P001",
                    "produto": "Produto A",
                    "valor": 25.99
                },
                {
                    "codigoProduto": "P001",
                    "produto": "Produto A",
                    "valor": 25.99
                }
            ]
        }
    ]
}

Obter ultimas vendas do cliente por id

Alterações

• Alterar para o dominio clientes

Endpoint

  GET v1/vendas/clientes/{idCliente}/ultimas-vendas

Cabeçalhos

Chave	Descrição
authorization	Obrigatório. Bearer token
content-type	application/json

Parâmetros

Parâmetro	Descrição
idCliente	Obrigatório. Id do cliente.

Retorno

• 200

{
    "erro": false,
    "mensagem": "sucesso",
    "dados": [
        {
            "data": "2023-09-19",
            "produtos": [
                {
                    "codigoProduto": "P001",
                    "produto": "Produto A",
                    "valor": 25.99,
                    "quantidade": 2,
                    "total": 51.98
                },
                {
                    "codigoProduto": "P002",
                    "produto": "Produto B",
                    "valor": 19.99,
                    "quantidade": 3,
                    "total": 59.97
                }
            ]
        }
    ]
}