pfx-api:customers

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

URI Format

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

Parameters

Parameter	Type	Default	Description
incrementalDate	String	--	Incremental date for the customer Datamart load. If provided, only data changed since this date is loaded

XML Route Examples

Full customer Datamart load

XML

<route>
    <from uri="direct:loadCustomers"/>
    <to uri="pfx-api:customers"/>
</route>

Incremental customer Datamart load

XML

<route>
    <from uri="direct:loadCustomersIncremental"/>
    <to uri="pfx-api:customers?incrementalDate=2026-01-01"/>
</route>

Customer load as part of a larger pipeline

XML

<route>
    <from uri="direct:fullDatamartPipeline"/>
    <to uri="pfx-api:loaddata?objectType=C&amp;mapper=customerMapper&amp;businessKeys=customerId"/>
    <to uri="pfx-api:customers"/>
    <to uri="pfx-api:refresh?targetName=MyDatamart"/>
</route>

Common Pitfalls

No objectType needed: Unlike most pfx-api methods, customers does not require the objectType parameter. The object type is implicitly Customer (C).
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, customer data should be loaded into Pricefx first (via loaddata), then trigger the customer Datamart load (via customers), and finally refresh the Datamart (via refresh).
Long-running operation: Customer Datamart loads can be time-consuming on large datasets. Plan your route timeouts accordingly.