...

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

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",
"tipo": 0,
"situacao": 0,
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
]

Column

width

50%

Definições dos campos

do body

Campo	Tipo	Descrição	Obrigatório

Observações

Observação
descricao	string	Descrição do motivo

Obrigatório

Sim

Tamanho máximo: 100 caracteres

tipo

int

Tipo do motivo

Obrigatório

Descrição dos tipos abaixo

Sim

Código	Tipo
0	AcrescimoDesconto
1	TrocaDevolucao
5	CancelamentoVenda
6	Sangria
7	Suprimento

situacao

int

Stituação do

motivo (

motivo

Não

0 - Inativo; 1 - Ativo

)

Se não enviado será cadastrado como 0

idInquilino

string

Identificador do inquilino

Obrigatório

Sim
idRetaguarda	string	Identificador do motivo na retaguarda

Obrigatório

Sim
idProprietario	string	Identificador do proprietário do dado

Obrigatório

Sim
loteOrigem	string	Identificador do lote

Obrigatório para a integração

Expandir

title	Tipo

Código

Tipo

0

AcrescimoDesconto

1

TrocaDevolucao

5

CancelamentoVenda

6

Sangria

7

Suprimento

Expandir

title	Retorno da requisição

200 - Oktitle

Sim

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

Expandir

title

{
"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"
}
]
}

Expandir

title	Definição dos campos de retorno

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

expandtitle

Card

label	V3.2

Expandir

title	200 - Ok

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

[
{
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"situacao": 0,
"IdPromocaoMotor":"string",
"tipoMecanica":0
"tipo": 0
}
]

Column

width	50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

string

Descrição do motivo

Não

Tamanho máximo: 250 caracteres

tipo

int

Tipo do motivo

Sim

Código	Tipo
0	AcrescimoDesconto
1	TrocaDevolucao
2	AlteracaoFormaPagto
3	AusenciaFuncionario
4	CassificacaoDia
5	CancelamentoVenda
6	Sangria
7	Suprimento
8	DevolucaoPedidoOMS

situacao

int

Define se o motivo em questão está ativo ou inativo.

Sim

0 - Inativo; 1 - Ativo

IdPromocaoMotor

string

Código de identificação do motivo vinculado ao motor de promoções terceiro (não TOTVS)

Não

Tamanho máximo: 100 caracteres

tipoMecanica

int

Tipo de mecânica da promoção retornada do motor de promoções terceiro (não TOTVS) juntamente com a identificação do mesmo

Não

idInquilino

string

Identificador do inquilino

Sim

idRetaguarda

string

Identificador do motivo na retaguarda

Sim

idProprietario

string

Identificador do proprietário do dado

Sim

loteOrigem

string

Identificador do lote

Sim

Retornos

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "string",
"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

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

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

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

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

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