...

Aviso
Para que a baixa do Perfil criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 3 = perfil

titleexpandtitleDefinição de requisição

Deck of Cards

id	versções

Card

label	V3.1 (V2)

Requisição

Section

Column

width	50%

Expandir

Exemplo de body da requisição

[
{
"nome": "string",
"tipoPerfil": "string",
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string",
"situacao": 1
}
]

Column

width	50%

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

Código	Tipo
1	Administrador
2	Operador
3	Vendedor

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

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

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

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",

"lote

"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

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

Card

label	V3.2

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

width	50%

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

width

50%

Definições dos campos

do body

Campo	Tipo	Descrição	Obrigatório	Observações

Obrigatório

nome

string

Nome dado ao perfil

Sim

Tamanho máximo: 50 caracteres

Sim

tipoPerfil

int

Tipo do perfil

Sim

Código	Tipo
1	Administrador
2	Operador
3	Vendedor

Sim

idInquilino	string	Identificador do inquilino	Sim
idRetaguarda	string	Identificador do perfil na retaguarda	Sim	Tamanho máximo: 100 caracteres

Sim


idProprietario	string	Idendtificador do proprietário	Sim
loteOrigem

stringLote vinculado ao dadoSimlote

	string	Lote vinculado ao dado	Sim
situacao	int	Situação do perfil	Sim	0 - Inativo, 1 - Ativo

Sim


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

expand

Deck of Cards

title

id

Retorno da requisiçãoexpandtitletitle

retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Expandir

Column

width	50%

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

Card

label

	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

expand

width

title

50%

Definição

Definições dos campos

de retorno400 - Bad Request

Expandir

title	200 - Ok

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

Expandir

title

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

Árvore de páginas

Versões comparadas

Versão antiga 7

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos

do retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 7

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos

do retorno