...

Aviso
Para que a baixa da Classificação criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 11 = ClassificacaoProduto

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

[
{
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"idRetaguardaPai": "string",
"loteOrigem": "string",
"nome": "string",
"sigla": "string",
"situacao": 0
}
]

Column

width	50%

Definições dos campos do body

Campo	Tipo	Descrição	Obrigatório	Observações
descricao	string	Descrição da classificação	Sim	Tamanho máximo: 100 caracteres
idInquilino	string	Identificador do inquilino	Sim
idProprietario	string	Identificador do proprietário	Sim
idRetaguarda	string	Identificador do imposto na retaguarda	Sim	Tamanho máximo: 100 caracteres
idRetaguardaPai	string	Identificador na retaguar da classificação pai	Não	Tamanho máximo: 100 caracteres
loteOrigem	string	Identificador do lote para envio dos dados	Sim
nome	string	Nome da classificação	Sim	Tamanho máximo: 50 caracteres
sigla	string	Sigla da classificação	Não	Tamanho máximo: 50 caracteres
situacao	int	Situação da classificação	Sim	0 - Inativo, 1 - Ativo

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",
"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

[
{
"

situacao

descricao":

0

"string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"

idProprietario

idRetaguardaPai": "string",
"loteOrigem": "string",
"nome": "string",
"sigla": "string",
"situacao": 0
}
]

Column

width

50%

Definições dos campos

do body

Campo	Tipo	Descrição	Obrigatório	Observações
descricao	string	Descrição da classificação

Obrigatório

Sim	Tamanho máximo: 100 caracteres
nome	string	Nome da classificação

Obrigatório

Sim	Tamanho máximo: 50 caracteres
sigla	string	Sigla da classificação

Opcional

Não	Tamanho máximo: 50 caracteres
idRetaguardaPai	string	Identificador na

retaguar da

retaguarda classificação pai

Opcional

Não
situacao	int	Situação da classificação

(

Sim

0 - Inativo, 1 - Ativo

)

Obrigatório

idInquilino

string

Identificador do inquilino

Obrigatório

Sim
idRetaguarda	string	Identificador

do imposto

da classificação na retaguarda

Obrigatório

Sim
idProprietario	string	Identificador do proprietário

Obrigatório

Expandir

title	200 - Ok

Sim
loteOrigem	string	Identificador do lote para envio dos dados

Obrigatório para a integração Expandir

title	Definição dos campos de retorno

expandtitle

Sim

Retornos

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",
"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

Árvore de páginas

Versões comparadas

Versão antiga 3

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 3

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