...
| Deck of Cards |
|---|
|
| Card |
|---|
| id | card1 |
|---|
| label | Descrição dos campos e regras |
|---|
| | Informação | Coluna | Obrigatório | Tipo | Tamanho | Descrição |
|---|
| Nome | nome | Sim | Texto | 50 | Descrição do perfil do qual estará associado ao usuário, como por exemplo: | | Situação do perfil | situacao | Sim | Inteiro |
| Define se o perfil em questão está ativo ou inativo. | | Data cadastro | data_cadastro | Sim | Data |
| Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente. | | Data atualização | data_atualizacao | Sim | Data |
| Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente. | | Identificação no retaguarda | id_retaguarda | Não | Texto | 100 |
| | Tipo de Perfil | tipo_perfil | Sim | Inteiro |
| - 1 - Administrativo
- 2 - Caixa
- 3 - Vendedor
| | Percentual máximo de desconto no item | desconto_maximo_item | Não | Numérico |
| O percentual máximo de desconto que o usuário associado ao perfil poderá aplicar no item. | | Percentual máximo de desconto no total | desconto_maximo_total | Não | Numérico |
| O percentual máximo de desconto que o usuário associado ao perfil poderá aplicar no total da venda. |
|
| Card |
|---|
| id | card2 |
|---|
| label | Microsserviço |
|---|
| ste método é responsável pela criação de um novo perfil - Endpoint: /api/retaguarda/v2/perfis
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de perfis para que possam ser enviados vários na mesma requisição | Aviso |
|---|
Para que a baixa do Perfil criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 3 = perfil |
| Deck of Cards |
|---|
| | Card |
|---|
| Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"nome": "string",
"tipoPerfil": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string",
"situacao": 1
}
]
|
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
nome | string | Nome dado ao perfil | Sim | Tamanho máximo: 50 caracteres | | tipoPerfil | int | Tipo do perfil | Sim | | Código | Tipo |
|---|
| 1 | Administrador | | 2 | Operador | | 3 | Vendedor | | 4 | Profissional |
| | idInquilino | string | Identificador do inquilino | Sim |
| | idRetaguarda | string | Identificador do perfil na retaguarda | Sim |
| | idProprietario | string | Identificador do proprietário | Sim |
| | loteOrigem | string | Lote vinculado ao dado | Sim |
| | situacao | int | Situação do perfil | Não | 0 - Inativo, 1 - Ativo Caso não enviado será cadastrado com 0 |
|
|
Retorno | Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
| Card |
|---|
| | Informações |
|---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"nome": "string",
"descontoMaximoItem": "string",
"descontoMaximoTotal": "string",
"situacao": 1,
"tipoPerfil": "string"
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
| nome | string | Nome dado ao perfil | Sim | Tamanho máximo: 50 caracteres | | tipoPerfil | int | Tipo do perfil | Sim | | Código | Tipo |
|---|
| 1 | Administrador | | 2 | Operador | | 3 | Vendedor | | 4 | Profissional |
| | idInquilino | string | Identificador do inquilino | Sim |
| | idRetaguarda | string | Identificador do perfil na retaguarda | Sim | Tamanho máximo: 100 caracteres | | idProprietario | string | Idendtificador do proprietário | Sim |
| | loteOrigem | string | Lote vinculado ao dado | Sim |
| | situacao | int | Situação do perfil | Sim | 0 - Inativo, 1 - Ativo | | descontoMaximoItem | numérico | O percentual máximo de desconto que o usuário associado ao perfil poderá aplicar no item. | Não |
| | descontoMaximoTotal | numérico | O percentual máximo de desconto que o usuário associado ao perfil poderá aplicar no total da venda. | Não |
|
|
|
Retornos| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|
|
|
...
O cadastro de usuário irá permitir as seguintes configurações:
| Informação | Coluna | Obrigatório | Tipo | Tamanho | Descrição |
|---|
| Perfil | perfil_id | Sim | Inteiro |
| Perfil associado ao usuário para validação de permissão de acesso a funcionalidades. |
| Nome | nome | Sim | Texto | 150 | O nome do usuário será utilizado nas operações: - Impressão dos comprovantes emitidos no PDV como venda, caixa, TEF.
- Identificação do vendedor na venda
- Apresentação do usuário logado em tela do PDV
. |
| CPF | cpf | Não | Texto | 20 | Utilizado na integração com o TOTVS Fidelidade. O campo CPF em banco não é obrigatório, mas quando utilizado Fidelidade OU a integração da senha é criptografada, o campo é obrigatório para o funcionamento correto do sistema. |
| Login | login | Sim | Texto | 30 | Login que será utilizado pelo usuário para acessar o PDV e se identificar como vendedor na operação de venda. |
| Senha | senha | Sim | Texto | 256 | Senha do login que será utilizado pelo usuário para acessar o PDV. |
| Administrador | administrador | Sim | Inteiro |
| Identifica se o usuário terá acesso administrador independente do seu perfil. |
Situação | situacao | Sim | Inteiro |
| |
| Data de cadastro | data_cadastro | Sim | Data |
| Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente. |
| Data de atualização | data_atualizacao | Sim | Data |
| Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente. |
| Identificação no retaguarda | id_retaguarda | Não | Texto | 100 |
|
| Senha criptografada | senha_criptografada | Não | Texto | 256 | Senha do login que será utilizado pelo usuário para acessar o PDV. Caso esse campo esteja preenchido, a coluna "senha", comum, será ignorada e será levado em consideração somente o dado criptografado. |
| Código de matricula do usuário | matricula | Não | Texto | 50 | O código da matricula poderá ser utilizado para identificar o vendedor/supervisor quando solicitado pelo PDV. Ou seja, quando apresentado o popup solicitando o vendedor ou supervisor, pode ser informado tanto o login como a matricula. |
| Aviso |
|---|
Obrigatoriamente é necessário que o login possua uma senha cadastrada. O acesso utilizando apenas o login não é permitido no PDV Omni. O login deverá ser único em banco de dados, caso exista mais de um usuário com o mesmo login, o PDV Omni sempre irá obter o primeiro registro como usuário. |
...
