TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 5

changes.mady.by.user William da Silva Sombra

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user William da Silva Sombra

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Definições dos campos do body

Sim

Sim

Retorno

Deck of Cards
idv1
Card
labelDescrição dos campos e regras

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


Informação

Coluna

Obrigatório

Tipo

Tamanho

Descrição

Identificação no retaguardaid_retaguardaNãoTexto100
Descrição do motivo que será apresentado no PDVdescricaoNãoTexto255Descriçã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 motivotipoSimInteiro

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çãosituacaoSimInteiro

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

  • 0 - Inativo
  • 1 - Ativo
Data de cadastrodata_cadastroSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualizaçãodata_atualizacaoSimData
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 terceiroid_promocao_motor_promocao_terceiroNãoTexto100Có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 terceirotipo_mecanicaNãoInteiro
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 motivoorigemNãoInteiro
Defasado

Requisição

Card
labelComo integrar

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

Aviso

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

Deck of Cards
idversções
Card
labelV3.1 (V2)
Section
Column
width50%

Exemplo de body da requisição

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

Column
width50%

Campo

Tipo

Descrição

Obrigatório

Observação

descricao

string

Descrição do motivo

Tamanho máximo: 100 caracterestipointTipo do motivo
CódigoTipo
0AcrescimoDesconto
1TrocaDevolucao
5CancelamentoVenda
6Sangria
7Suprimento
situacaointStituação do motivo  Não

0 - Inativo; 1 - Ativo

Se não enviado será cadastrado como 0

idInquilinostringIdentificador do inquilinoSimidRetaguardastringIdentificador do motivo na retaguardaSimidProprietariostringIdentificador do proprietário do dadoSimloteOrigemstringIdentificador do lote

Sim

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucessoMessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campoDataobjetoObjeto compartilhamento criadoErrorsListaListas com os erros encontrados no processoTotalTimeinttempo da requisiçãoNumberOfRecordsintnúmero de dados inseridos Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erromessagestringMensagem do errodetailedMessagestringDetalhamento do errohelpUrlstringurl de ajudaTotalTimestringTempo total de buscadetailslista de objetoLista de objeto de errosdetails.guidstringIdentificador do errodetails.codestringCódigo do errodetails.messagestringMensagem do erro details.detailedMessagestringDetalhamento do erro Card
labelV3.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
width50%

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
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricaostringDescrição do motivo

Não

Tamanho máximo: 250 caracteres

tipointTipo do motivo

Sim

CódigoTipo0AcrescimoDesconto1TrocaDevolucao2AlteracaoFormaPagto3AusenciaFuncionario4CassificacaoDia5CancelamentoVenda6Sangria7Suprimento8DevolucaoPedidoOMSsituacaointDefine se o motivo em questão está ativo ou inativo.Sim

0 - Inativo; 1 - Ativo

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

Tamanho máximo: 100 caracteres

tipoMecanica intTipo de mecânica da promoção retornada do motor de promoções terceiro (não TOTVS) juntamente com a identificação do mesmoNãoidInquilinostringIdentificador do inquilinoSimidRetaguardastringIdentificador do motivo na retaguardaSimidProprietariostringIdentificador do proprietário do dadoSimloteOrigemstringIdentificador do lote

Sim

Retornos

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

{
    "success": true,
    "message": "string",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucessoMessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campoDataobjetoObjeto compartilhamento criadoErrorsListaListas com os erros encontrados no processoTotalTimeinttempo da requisiçãoNumberOfRecordsintnúmero de dados inseridos Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erromessagestringMensagem do errodetailedMessagestringDetalhamento do errohelpUrlstringurl de ajudaTotalTimestringTempo total de buscadetailslista de objetoLista de objeto de errosdetails.guidstringIdentificador do errodetails.codestringCódigo do errodetails.messagestringMensagem do erro details.detailedMessagestringDetalhamento do erro

Para maiores informações de como integrar o Motivo, clique aqui.