pfx-api:getAssignedCustomers

pfx-api:getAssignedCustomers

Retrieve the list of customers assigned to a specific entity in Pricefx (e.g., customers assigned to a Price List, Rebate Agreement, or Simulation).


URI Format

pfx-api:getAssignedCustomers?typedId=42.PL

Parameters

Parameter

Type

Required

Default

Description

typedId

String

Yes

--

The typedId of the parent entity whose assigned customers to retrieve (e.g., 42.PL, 10.RBA, 5.SIM).

objectType

ObjectType

No

--

The object type of the parent entity (e.g., PL, RBA, SIM).


XML Route Examples

Get customers assigned to a Price List:

XML
<route>
    <from uri="direct:getAssignedCustomers"/>
    <to uri="pfx-api:getAssignedCustomers?typedId=42.PL"/>
</route>

Get customers assigned to a Rebate Agreement:

XML
<route>
    <from uri="direct:getRebateCustomers"/>
    <to uri="pfx-api:getAssignedCustomers?typedId=10.RBA"/>
</route>

Common Pitfalls

  • The typedId must reference a valid entity that supports customer assignment.

  • The result is a list of customer objects. If no customers are assigned, an empty list is returned.