DT PE GVPRDQRY - Complemento do filtro na query da API de Produtos do PGV

CONTEÚDO

Dados Gerais
Descrição
Sintaxe
Parâmetros
Retorno
Exemplo

01. DADOS GERAIS

Produto:	TOTVS Backoffice
Linha de Produto:	Linha Protheus
Segmento:	Backoffice
Módulo:	SIGAFAT - Faturamento
Função:	tgv.products.data.protheus - Programa de tratamento de dados da API de Produtos - Portal Gestão de Vendas tgv.products.data.protheus.sync - Programa de tratamento de dados da API de Sincronização de Produtos - Portal Gestão de Vendas
Abrangências:	Microsiga Protheus 12
Versões:	Microsiga Protheus 12
Compatível Países:	Todos os países
Sistemas Operacionais:	Todos
Compatível com as Bases de Dados:	Todos
Nível de Acesso:	Nível 1 (Acesso Clientes)
Idiomas:	Todos

02. DESCRIÇÃO

O ponto de entrada GRVPRDQRY permite a incluir um filtro customizado na query que busca os produtos que serão retornado pela API do Portal Gestão de Vendas (PGV). Este ponto de entrada é executado nos end-points apresentados a seguir:

/api/tgv/products/sync
/api/tgv/products/sync/diff/:dateSync
/api/tgv/products/
/api/tgv/products/:priceListId/:customerId/:storeId

03. SINTAXE

GVPRDQRY() ---> cRet

04. PARÂMETROS

Nome	Tipo	Descrição	Default	Obrigatório	Referência
aParamIXB	Vetor	Vetor com os dados do cliente que está informados na requisição HTTP, sendo: [ 01 ] - cCod - Tipo: Caracter - Código do Cliente [ 02 ] - cLoja - Tipo: Caracter - Loja do Cliente [ 03 ] - cCodTab - Tipo: Caracter - Código da Tabela de Preços informada na requisição. [ 04 ] - lOnLine - Tipo: Lógico - Indica se a requisição foi realizada para o PGV Online ou Offline.	NA

Importante

Os Parâmetros Código do Cliente, Loja e Tabela de Preços estarão disponíveis apenas se o Portal estiver operando Online.

05. RETORNO

Retorno	Tipo	Descrição	Obrigatório
cRet	Caracter	Condição SQL. A string deve ser iniciada pelo operador "AND" para ser adicionada no filtro da consulta a ser executada pela API. Caso nenhuma condição seja necessária, este ponto de entrada deve ser retornar uma string vazia ("").	Sim

06. EXEMPLO

Exemplo

#INCLUDE "Protheus.ch"

//-----------------------------------------------------------
/*/{Protheus.doc} GVPRDQRY
    Este ponto de entrada é chamado na montagem da Query da 
    API de Produtos do Portal Gestão de Vendas
    @type function
    @author Squad CRM/Faturamento
    @since 05/07/2022
    @version 1.0
/*/
//-----------------------------------------------------------
user function GVPRDQRY()
    local cQuery    := ""
    Local cCodCli   := ParamIxb[1] // Código do Cliente
    Local cLoja     := ParamIxb[2] // Loja do CLiente
    Local cCodTab   := ParamIxb[3] // Código da Tabela de Preços
    Local lOnline   := ParamIxb[4] // Se Consulta é online
    // Importante os Parametros Cod. do Cliente, Loja e Tabela de Preços estarão disponiveis apenas 
    // Se o Portal estiver operando Online.

    cQuery := " AND SB1.B1_TIPO = 'PA' "
    cQuery += " AND SB1.B1_TS <> ' ' "
    
return cQuery

Árvore de páginas