pfx-api:products

pfx-api:products

Trigger a product Datamart load. This instructs Pricefx to reload product master data into the Datamart.

URI Format

pfx-api:products?param1=value1&param2=value2

Parameters

Parameter

Type

Default

Description

incrementalDate

String

--

Incremental date for the product Datamart load. If provided, only data changed since this date is loaded

XML Route Examples

Full product Datamart load

XML
<route>
    <from uri="direct:loadProducts"/>
    <to uri="pfx-api:products"/>
</route>

Incremental product Datamart load

XML
<route>
    <from uri="direct:loadProductsIncremental"/>
    <to uri="pfx-api:products?incrementalDate=2026-01-01"/>
</route>

Product load as part of a larger pipeline

XML
<route>
    <from uri="direct:fullDatamartPipeline"/>
    <to uri="pfx-api:loaddata?objectType=P&amp;mapper=productMapper&amp;businessKeys=sku"/>
    <to uri="pfx-api:products"/>
    <to uri="pfx-api:refresh?targetName=MyDatamart"/>
</route>

Common Pitfalls

  • No objectType needed: Unlike most pfx-api methods, products does not require the objectType parameter. The object type is implicitly Product (P).

  • incrementalDate format: The date must be provided as a string recognized by Pricefx (e.g. 2026-01-01). If omitted, a full load is performed.

  • Order of operations: In a typical Datamart pipeline, product data should be loaded into Pricefx first (via loaddata), then trigger the product Datamart load (via products), and finally refresh the Datamart (via refresh).

  • Long-running operation: Product Datamart loads can be time-consuming on large datasets. Plan your route timeouts accordingly.