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 |
|
||||||||||||
| 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 |
|
||||||||||||||||||||
| 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 |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas