ÍNDICE

  1. Datos generales
  2. Descripción
  3. Sintaxis
  4. Parámetros
  5. Devolución
  6. Ejemplo

01. VISIÓN GENERAL

Producto:

TOTVS Backoffice

Línea de producto:

Línea Protheus

Segmento:

Backoffice

Módulo:

SIGAFIN - Financiero

Función:

pc.products.data.protheus - API de Productos del Portal del cliente

Alcances:

Microsiga Protheus 12

Versiones:

Microsiga Protheus 12

Compatible Países:

Todos los países

Sistemas operativos:

Todos

Compatible con las bases de datos:

Todas

Nivel de acceso:

Nivel 1 (Acceso Clientes)

Idiomas:

Todos

02. DESCRIPCIÓN

El punto de entrada PCPRDQRY permite incluir un filtro personalizado en la query que busca los productos que se devolverán por la API del Portal del cliente. Este punto de entrada se ejecuta en los end-points mostrados a continuación:

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

¡IMPORTANTE!

Este punto de entrada no incluye campos en la interfaz del sistema.

03. SINTAXIS

PCPRDQRY() ---> cRet

04. PARÁMETROS

Nombre

Tipo

Descripción

Estándar

Obligatorio

Referencia

aParamIXBVetor

Vector con los datos del cliente que están informados en la requisición HTTP, siendo:
[ 01 ] - cCod - Tipo: Carácter - Código del cliente
[ 02 ] - cLoja - Tipo: Carácter - Tienda del cliente
[ 03 ] - cCodTab - Tipo: Carácter - Código de la Lista de precios informada en la
requisição.

NA

05.DEVOLUCIÓN

Devolución

Tipo

Descripción

Obrigatorio

cRetCarácter

Condición SQL. La string debe ser iniciada por el operador "AND" para incluirse en el filtro de la consulta que será ejecutada por la API. Si ninguna condición fuera necesaria, este punto de entrada debe devolver una string vacía ("").

Sim

06. EJEMPLO

Ejemplo

#INCLUDE "Protheus.ch"
 
//-----------------------------------------------------------
/*/{Protheus.doc} PCPRDQRY
    Este punto de entrada se activa en el montaje de la Query de la
    API de Productos del Portal Gestión de ventas
    @type function
    @author Lucas Panão / Squad CRM/Facturación

    @since 30/11/2023
    @version 1.0
/*/
//-----------------------------------------------------------
user function PCPRDQRY()
    local cQuery    := ""
    Local cCodCli   := ParamIxb[1] // Código del cliente
    Local cLoja     := ParamIxb[2] // Tienda del cliente
    Local cCodTab   := ParamIxb[3] // Código de la lista de precios
 
    cQuery := " AND SB1.B1_TIPO = 'PA' "
    cQuery += " AND SB1.B1_TS <> ' ' "
     
return cQuery