Este 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
Para que a baixa do Perfil criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 3 = perfil
Requisição
Exemplo de body da requisição
[
{
"nome": "string",
"tipoPerfil": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string",
"situacao": 1
}
]
Definições dos campos do body
Campo |
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 |
|
||||||||
| 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
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
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 |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
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 |
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
Exemplo de body da requisição
[
{
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"nome": "string",
"descontoMaximoItem": "string",
"descontoMaximoTotal": "string",
"situacao": 1,
"tipoPerfil": "string"
}
]
Definições dos campos do body
Campo |
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 |
|
||||||||
| 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
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
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 |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
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 |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas