TOTVS Moda

Páginas filhas
  • DT DVAARM-1310 Criar API para consulta de pré-venda

Versões comparadas

Versão antiga 5

changes.mady.by.user Arnaldo Takeshi Miyashiro

Gravado em

comparado com

Nova versão 6

changes.mady.by.user Juliana Aline Petri

Gravado em

Chave

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


01. DADOS GERAIS

Linha de Produto:TOTVS Moda
Segmento:Moda
Módulo:Virtual.PDV
Função:

Pré-Venda Mobile - Criar API para consulta de transação

Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :DVAARM-1310


02. SITUAÇÃO/REQUISITO

Com a criação do endpoint search-pre-sale na ApiTransaction, API responsável pela criação e consulta de pré-vendas na retaguarda, foi necessário a criação de um endpoint na API interna do Virtual PDV. Dessa forma, a aplicação de pré-venda mobile estaria apto a consultar as pré-vendas locais ou da retaguarda.

03. SOLUÇÃO

O endpoint api/PreVendaMobile/Listar foi criado no webservice interno do Virtual PDV para o consumo do endpoint da retaguarda. Necessário a configuração do parâmetro TP_FINALIZACAO_PRE_VENDA para apontar o local da consulta de pré-vendas, se será na base local ou da retaguarda.

...

Totvs custom tabs box
tabsToken v2,Tipo finalização pré-venda,Endpoint do webservice interno do PDV
idstoken,tipofinaliza,endpoint
Totvs custom tabs box items
defaultyes
referenciatoken

Imagem 1: Componente ADMFM007, com informações sobre o parâmetro URL_TOKEN_V2

Imagem 2: Componente ADMFM007, com informações do parâmetro TOKEN_V2_CLIENT_ID

Imagem 3: Componente ADMFM007, com informações do parâmetro TOKEN_V2_CLIENT_SECRET

Imagem 4: Componente LOGFM015. Os campos Usuário e Senha correspondem às informações do client_id e client_secret, respectivamente

Imagem 5: Ainda no componente LOGFM015, ao clicar no botão "Liberação..." ele se extenderá, apresentando as permissões dessa credencial

Imagem 6: Tela Configuração de Parâmetros no Virtual PDV. Em destaque, a localização da configuração do endereço do token v2

Totvs custom tabs box items
defaultno
referenciatipofinaliza


Imagem 1: Componente ADMFM007, com informações do parâmetro TP_FINALIZACAO_PRE_VENDA

Imagem 2: Tela Configuração de Parâmetros no Virtual PDV. Em destaque, a localização da configuração do tipo de finalização de pré-venda

Totvs custom tabs box items
defaultno
referenciaendpoint
Totvs custom tabs box
tabsInformações da requisição,Modelo JSON envio,Modelo JSON retorno
idsendpointTab1,endpointTab2,endpointTab3
Totvs custom tabs box items
defaultyes
referenciaendpointTab1

Informações do endpoint da requisição de consulta de pré-venda na API do PDV


Endpoint:

  • api/PreVendaMobile/Listar

Headers:

  • Token: ( O token que o PDV disponibiliza pela requisição api/Usuario/ValidarAcesso )
Totvs custom tabs box items
defaultno
referenciaendpointTab2
Bloco de código
linenumberstrue
{
  "DocumentoEmpresa": "",
  "NumeroTransacao": 0,
  "DataTransacao": "",
  "DocumentoPessoa": "",
  "CodigoVendedor": "",
  "NumeroComanda": 0,
  "Checkout": "",
}
Totvs custom tabs box items
defaultno
referenciaendpointTab3
Bloco de código
linenumberstrue
{
    "Conteudo": [
        {
            "CodigoEmpresa": 1,
            "Numero": 1,
            "Data": "2020-04-13T00:00:00-03:00",
            "DocumentoPessoa": "11122233300",
            "CodigoOperacao": 1000,
            "CodigoCondicaoPagamento": 1,
            "CodigoEmpresaFaturamento": 1,
            "CodigoGrupoEmpresa": 1,
            "TipoSituacao": 1,
            "TipoOrigem": "1",
            "SequencialEndereco": 1,
            "CodigoVendedor": 102,
            "TipoOperacao": "S",
            "PercentualDesconto": null,
            "ValorTransacao": null,
            "ValorDesconto": null,
            "ValorTotal": null,
            "InformacaoAdicionalTransacao": {
                "NumeroComanda": 8,
                "Checkout": "8c9b766c-eea0-471b-bbf0-b396753b9bc2"
            },
            "Itens": [
                {
                    "Numero": 1,
                    "CodigoGrupoEmpresa": 1,
                    "CodigoBarraProduto": "708",
                    "CodigoProduto": 708,
                    "DescricaoProduto": "UM PRODUTO",
                    "CodigoEmpresaFaturamento": 1,
                    "CodigoEspecie": "PC ",
                    "CodigoVendedor": 102,
                    "ValorTotalBruto": 39.9,
                    "ValorDescontoCapa": 0.0,
                    "ValorDesconto": 0.0,
                    "ValorTotalLiquido": 39.9,
                    "QuantidadeSolicitada": 1.0,
                    "QuantidadeAtendida": 0.0,
                    "Saldo": 1.0,
                    "ValorUnitarioBruto": 39.9,
                    "ValorUnitarioDescontoCapa": 0.0,
                    "ValorUnitarioDesconto": 0.0,
                    "ValorUnitarioLiquido": 39.9,
                    "PercentualDesconto": 0.0
                }
            ]
        }
    ],
    "Mensagem": "",
    "NomeException": null
}


04. DEMAIS INFORMAÇÕES

Link para a documentação de referência da ApiTransaction: Link

...