O MOTIVO poderá ter a seguintes informações:

Informação	Coluna	Obrigatório	Tipo	Tamanho	Descrição
Identificação no retaguarda	id_retaguarda	Não	Texto	100
Descrição do motivo que será apresentado no PDV	descricao	Não	Texto	255	Descrição do motivo cadastrado no ERP/Retaguarda. Esse campo será apresentado na tela para que o usuário selecione o motivo para operação que ele está realizando
Tipo de motivo	tipo	Sim	Inteiro		Tipo do motivo que está cadastrado 0 - Acréscimo ou desconto 1 - Troca/Devolução 2 - Alteração de forma de pagamento 3 - Ausência funcionário 4 - Classificação dia 5 - Cancelamento venda 6 - Sangria 7 - Suprimento 8 - Devolução de pedido OMS De acordo com o tipo, o mesmo será apresentado em tela. Por exemplo, no fluxo de sangria será apresentado somente os motivos vinculados ao tipo 6 - Sangria.
Situação	situacao	Sim	Inteiro		Define se o motivo em questão está ativo ou inativo. 0 - Inativo 1 - Ativo
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 da promoção no motor terceiro	id_promocao_motor_promocao_terceiro	Não	Texto	100	Código de identificação do motivo vinculado ao motor de promoções terceiro (não TOTVS)
Tipo de mecânica da promoção do motor terceiro	tipo_mecanica	Não	Inteiro		Tipo de mecânica da promoção retornada do motor de promoções terceiro (não TOTVS) juntamente com a identificação do mesmo
Origem do cadastro do motivo	origem	Não	Inteiro		Defasado

Este método é responsável pela criação de motivos

Endpoint: /api/retaguarda/v2/motivos
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda

Este endpoint recebe uma lista de motivos para que possam ser enviados vários na mesma requisição

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

Requisição

Exemplo de body da requisição

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

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observação

descricao

string

Descrição do motivo

Sim

Tamanho máximo: 100 caracteres

tipo

int

Tipo do motivo

Sim

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

situacao

int

Stituação do motivo

Não

0 - Inativo; 1 - Ativo

Se não enviado será cadastrado como 0

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

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

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

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

Exemplo de body de retorno

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