Linha Microsiga Protheus

Árvore de páginas


CONTEÚDO

  1. Dados Gerais
  2. Descrição
  3. Sintaxe
  4. Parâmetros
  5. Retorno
  6. Exemplo


01. VISÃO GERAL

Produto:

TOTVS Backoffice

Linha de Produto:

Linha Protheus

Segmento:

Backoffice

Módulo:SIGAFIN - Financeiro
Função:

pc.products.data.protheus - API de Produtos do Portal do Cliente

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 PCPRDQRY permite a incluir um filtro customizado na query que busca os produtos que serão retornado pela API do Portal do Cliente. Este ponto de entrada é executado nos end-points apresentados a seguir:

  • /api/pc/v1/products/
  • /api/pc/v1/products/:priceListId/:customerId/:storeId

IMPORTANTE!

Este ponto de entrada não inclui campos na interface do sistema.

03. SINTAXE

PCPRDQRY() ---> cRet

04. PARÂMETROS

Nome

Tipo

Descrição

Default

Obrigatório

Referência

aParamIXBVetor

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.

NA

05.RETORNO

Retorno

Tipo

Descrição

Obrigatório

cRetCaracter

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} PCPRDQRY
    Este ponto de entrada é chamado na montagem da Query da
    API de Produtos do Portal Gestão de Vendas
    @type function
    @author Lucas Panão / Squad CRM/Faturamento
    @since 30/11/2023
    @version 1.0
/*/
//-----------------------------------------------------------
user function PCPRDQRY()
    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
 
    cQuery := " AND SB1.B1_TIPO = 'PA' "
    cQuery += " AND SB1.B1_TS <> ' ' "
     
return cQuery