Summary: Complete reference of all Pricefx object types used in pfx-api operations — defines what data entities can be imported, exported, and manipulated.
Overview
The ObjectType enum (defined in net.pricefx.integration.api.ObjectType) identifies every Pricefx data entity that the Integration Manager can interact with. Each enum constant carries a label (the API type string used internally by the Pricefx platform) and is passed to pfx-api operations via the objectType parameter.
Object Types by Category
Products
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Core product master data |
loaddata, fetch, integrate, delete, massedit, update |
|
|
|
Product attribute metadata definitions |
fetch |
|
|
|
Product Bill of Materials entry |
loaddata, fetch |
|
|
|
Product competition data |
loaddata, fetch |
|
|
|
Product description / localization |
loaddata, fetch |
|
|
|
Product extension table (custom attributes) |
loaddata, fetch, integrate, delete, massedit, update |
|
|
|
Product extension attribute metadata |
fetch |
|
|
|
Product cross-reference mappings |
loaddata, fetch |
|
|
|
Product extension with 3-key lookup |
loaddata, fetch |
|
|
|
Product extension with 6-key lookup |
loaddata, fetch |
|
|
|
Product extension with 8-key lookup |
loaddata, fetch |
|
|
|
Product extension with 10-key lookup |
loaddata, fetch |
|
|
|
Product extension with 20-key lookup |
loaddata, fetch |
|
|
|
Product extension with 30-key lookup |
loaddata, fetch |
|
|
|
Product extension with 50-key lookup |
loaddata, fetch |
Customers
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Core customer master data |
loaddata, fetch, integrate, delete, massedit, update |
|
|
|
Customer-to-seller assignment |
loaddata, fetch |
|
|
|
Customer attribute metadata definitions |
fetch |
|
|
|
Customer description / localization |
loaddata, fetch |
|
|
|
Customer extension table (custom attributes) |
loaddata, fetch, integrate, delete, massedit, update |
|
|
|
Customer extension attribute metadata |
fetch |
|
|
|
Customer extension with 3-key lookup |
loaddata, fetch |
|
|
|
Customer extension with 6-key lookup |
loaddata, fetch |
|
|
|
Customer extension with 8-key lookup |
loaddata, fetch |
|
|
|
Customer extension with 10-key lookup |
loaddata, fetch |
|
|
|
Customer extension with 20-key lookup |
loaddata, fetch |
|
|
|
Customer extension with 30-key lookup |
loaddata, fetch |
|
|
|
Customer extension with 50-key lookup |
loaddata, fetch |
Sellers
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Seller master data |
loaddata, fetch |
|
|
|
Seller extension table (custom attributes) |
loaddata, fetch, integrate, update |
|
|
|
Seller extension attribute metadata |
fetch |
Company Parameters (Lookup Tables)
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Lookup table definition/header |
fetch, delete |
|
|
|
Simple (single-key) lookup table values |
loaddata, fetch, integrate, delete, massedit |
|
|
|
Matrix lookup table attribute metadata |
fetch |
|
|
|
Matrix lookup table values (1 key) |
loaddata, fetch, integrate, delete, massedit |
|
|
|
Matrix lookup table values (2 keys) |
loaddata, fetch, integrate, delete, massedit |
|
|
|
Matrix lookup table values (3 keys) |
loaddata, fetch, integrate, delete |
|
|
|
Matrix lookup table values (4 keys) |
loaddata, fetch, integrate, delete |
|
|
|
Matrix lookup table values (5 keys) |
loaddata, fetch, integrate, delete |
|
|
|
Matrix lookup table values (6 keys) |
loaddata, fetch, integrate, delete |
|
|
|
JSON-type lookup table values |
loaddata, fetch |
|
|
|
JSON-type lookup table values (2 keys) |
loaddata, fetch |
|
|
|
Lookup table tree/hierarchy |
fetch |
Note: Lookup table value types (
LTV,MLTV,MLTV2..MLTV6,JLTV,JLTV2) require apricingParameterNameparameter. Matrix types (MLTV..MLTV6) also require a lookup table ID for metadata fetch operations (seerequiresLookupTableIdOnMetadataFetch).
Company Parameter Table Types and Field Structures
The Pricefx table type (configured in Administration) determines the IM objectType and the field names used in the mapper.
|
Table Type |
IM objectType |
Keys |
Description |
|---|---|---|---|
|
|
|
|
Single key, single value. Exchange rates, discount codes, status lookups. |
|
|
|
|
Range-based lookup. Tax brackets, volume discounts. |
|
|
|
|
1-key matrix with multiple value attributes. Price by product. |
|
|
|
|
2-key matrix. Price by region + product type. |
|
|
|
|
3-key matrix. |
|
|
|
|
4-key matrix. |
|
|
|
|
5-key matrix. |
SIMPLE (LTV — single key/value):
|
Field |
Description |
|---|---|
|
|
The lookup key (required) |
|
|
The lookup value (required) |
RANGE (LTV — range lookup):
|
Field |
Description |
|---|---|
|
|
The lookup key (required) |
|
|
Range lower bound |
|
|
Range upper bound |
|
|
The lookup value (required) |
MATRIX (MLTV2 — 1-key matrix):
Uses name as the single key (same field name as SIMPLE), plus attribute value fields:
|
Field |
Description |
|---|---|
|
|
The lookup key (required) |
|
|
Value fields |
MATRIX2–MATRIX5 (MLTV2 — multi-key matrix):
MATRIX2 and above use key1–keyN instead of name:
|
Field |
MATRIX2 |
MATRIX3 |
MATRIX4 |
MATRIX5 |
|---|---|---|---|---|
|
|
yes |
yes |
yes |
yes |
|
|
yes |
yes |
yes |
yes |
|
|
— |
yes |
yes |
yes |
|
|
— |
— |
yes |
yes |
|
|
— |
— |
— |
yes |
|
|
values |
values |
values |
values |
Note: The pricingParameterName in pfx-api operations is the table's uniqueName from the Pricefx partition — not the display label.
Data Sources & Datamarts
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
(empty) |
Generic data source (resolved at runtime) |
loaddata, fetch |
|
|
(empty) |
Generic data feed (resolved at runtime) |
loaddata, fetch |
|
|
|
Datamart data |
loaddata, fetch, import, truncate, flush, refresh, export, calculate |
|
|
|
Datamart data source definition |
import, fetch |
|
|
|
Datamart schema |
fetch |
|
|
|
Simulation datamart |
fetch |
|
|
|
Simulation datamart schema |
fetch |
|
|
|
Datamart data chunk |
internal |
|
|
|
Datamart data load tracking |
internal |
|
|
|
Datamart data feed |
fetch |
|
|
|
Datamart model |
fetch |
|
|
|
Datamart query cache |
internal |
|
|
|
Sales simulation datamart calculation |
internal |
|
|
|
Datamart view |
fetch |
|
|
|
Datamart model (alias) |
fetch |
|
|
|
Data warehouse table |
fetch |
Price Lists
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Price list header |
fetch |
|
|
|
Price list line items |
fetch, update, loaddata |
|
|
|
Price list item attribute metadata |
fetch |
|
|
|
Price list tree/hierarchy |
fetch |
|
|
|
Price list / price grid type mapping |
fetch |
|
|
|
Manual price list header |
fetch, calculate |
|
|
|
Manual price list line items |
fetch, integrate, loaddata |
|
|
|
Manual price list item attribute metadata |
fetch |
|
|
|
Manual price list tree |
fetch |
|
|
|
Manual price list integration tag |
fetch |
Price Grids
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Price grid header |
fetch, calculate |
|
|
|
Price grid line items |
fetch, update, loaddata |
|
|
|
Price grid item attribute metadata |
fetch |
|
|
|
Price grid tree/hierarchy |
fetch |
|
|
|
Live price grid |
fetch, update |
|
|
|
Matrix price list item |
fetch, loaddata |
|
|
|
Matrix price grid item |
fetch, loaddata |
|
|
|
Matrix live price grid |
fetch, update |
|
|
|
Matrix simulation item |
fetch |
Price Records
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Price record data |
loaddata, fetch, integrate |
|
|
|
Price record attribute metadata |
fetch |
Quotes
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Quote header |
fetch, save, price, addProducts, createNewRevision |
|
|
|
Quote line items |
fetch |
|
|
|
Quote attribute metadata |
fetch |
|
|
|
Quote tree/hierarchy |
fetch |
|
|
|
Quote type definition |
fetch |
|
|
|
Quote type attribute metadata |
fetch |
Contracts
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Contract header |
fetch, loaddata |
|
|
|
Contract line items |
fetch |
|
|
|
Contract term type definition |
fetch |
|
|
|
Contract term type attribute metadata |
fetch |
|
|
|
Contract attribute metadata |
fetch |
|
|
|
Contract tree/hierarchy |
fetch |
Rebates
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Rebate agreement header |
fetch, loaddata |
|
|
|
Rebate agreement line items |
fetch |
|
|
|
Rebate agreement attribute metadata |
fetch |
|
|
|
Rebate agreement tree |
fetch |
|
|
|
Rebate agreement template |
fetch |
|
|
|
Rebate agreement template attribute metadata |
fetch |
|
|
|
Rebate record data |
loaddata, fetch, integrate |
|
|
|
Rebate record attribute metadata |
fetch |
|
|
|
Rebate record set |
fetch |
|
|
|
Rebate record set calculation |
fetch |
|
|
|
Rebate type definition |
fetch |
|
|
|
Rebate type attribute metadata |
fetch |
|
|
|
Payout record (rebate payout) |
loaddata, fetch |
|
|
|
Payout record attribute metadata |
fetch |
Claims
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Claim header |
fetch, loaddata |
|
|
|
Claim line items |
fetch |
|
|
|
Claim line item attribute metadata |
fetch |
|
|
|
Claim record data |
loaddata, fetch |
|
|
|
Claim type definition |
fetch |
Custom Forms
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Custom form instance |
fetch, add, update, delete, duplicate, changeStatus, createNewRevision |
|
|
|
Custom form type definition |
fetch |
Simulations
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Simulation header |
fetch |
|
|
|
Simulation line items |
fetch |
|
|
|
Simulation item attribute metadata |
fetch |
Calculated Field Sets
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Calculated field set |
fetch, calculate, cancel |
Condition Records
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Condition record processing/load trigger |
loaddata |
|
|
|
Condition record items (1-12 key variants) |
fetch, loaddata |
|
|
|
Condition record item history (1-12 key variants) |
fetch |
|
|
|
Condition record items - all records (1-12 key variants) |
fetch |
|
|
|
Condition record set definition |
fetch |
Formulas & Logic
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Pricing formula (logic element) |
fetch, execute |
|
|
|
Pricing formula element |
fetch |
|
|
|
Formula invariant |
fetch |
|
|
|
Formula invariant element |
fetch |
|
|
|
Formula invariant engine run |
fetch |
|
|
|
Calculation flow |
fetch |
|
|
|
Calculation flow trait |
fetch |
|
|
|
Workflow formula |
fetch |
|
|
|
Workflow formula element |
fetch |
Users, Roles & Security
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
User account |
fetch, save |
|
|
|
User group |
fetch |
|
|
|
Security role |
fetch |
|
|
|
Business role |
fetch |
|
|
|
API key |
fetch |
|
|
|
Login audit trail |
fetch |
|
|
|
Security audit trail |
fetch |
|
|
|
Password history |
internal |
|
|
|
Two-factor authentication token |
internal |
|
|
|
Refresh token |
internal |
Workflows & Events
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Workflow definition |
fetch |
|
|
|
Event/task |
fetch |
|
|
|
To-do / action item |
fetch |
|
|
|
Internal system event |
internal |
|
|
|
Email task |
internal |
Data Change Requests
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Data change request header |
fetch |
|
|
|
Data change request line item |
fetch |
|
|
|
Data change request item attribute metadata |
fetch |
|
|
|
Data change request type |
fetch |
|
|
|
Data change request log |
fetch |
|
|
|
Data change request mass change |
fetch |
System & Administration
|
Enum Value |
API Type Code |
Description |
Used In |
|---|---|---|---|
|
|
|
Application/partition properties |
fetch |
|
|
|
Bound partition configuration |
fetch |
|
|
|
Partition definition |
fetch |
|
|
|
Partition help content |
fetch |
|
|
|
Dashboard definition |
fetch |
|
|
|
Saved chart |
fetch |
|
|
|
Saved chart tree |
fetch |
|
|
|
Filter node definition |
fetch |
|
|
|
Cluster node info |
fetch |
|
|
|
Calculation schedule |
fetch |
|
|
|
User/system preferences |
fetch |
|
|
|
Inline details UI configuration |
fetch |
|
|
|
Information flow processor |
fetch |
|
|
|
Binary data (file attachments) |
bdManagerUpload, fetch |
|
|
|
Data archive |
fetch |
|
|
|
Data export job |
fetch |
|
|
|
Data import job |
fetch |
|
|
|
Device registration |
fetch |
|
|
|
Integration status history |
fetch |
|
|
|
Job status tracker |
fetch |
|
|
|
Upload status |
fetch |
|
|
|
Price API job |
fetch |
|
|
|
Comment history |
fetch |
|
|
|
Model definition |
fetch |
|
|
|
Model record |
fetch, loaddata |
|
|
|
Model record attribute metadata |
fetch |
Usage in Camel Routes
The objectType parameter is passed to the pfx-api Camel component to specify which Pricefx entity an operation targets. Below are common usage patterns.
Loading Data (loaddata)
Load product master data:
<to uri="pfx-api:loaddata?objectType=P&mapper=productMapper&businessKeys=sku"/>
Load customer master data:
<to uri="pfx-api:loaddata?objectType=C&mapper=customerMapper&businessKeys=customerId"/>
Load company parameter (lookup table) values:
<to uri="pfx-api:loaddata?objectType=LTV&mapper=currencyMapper&pricingParameterName=currency"/>
Load matrix company parameter values (2-key):
<to uri="pfx-api:loaddata?objectType=MLTV2&mapper=discountMapper&pricingParameterName=discount"/>
Load product extension data:
<to uri="pfx-api:loaddata?objectType=PX&mapper=carsMapper&businessKeys=sku,name,attribute1"/>
Load condition records:
<to uri="pfx-api:loaddata?objectType=CRCP&mapper=conditionRecordsMapper"/>
Load seller extension data:
<to uri="pfx-api:loaddata?objectType=SX&mapper=sellerExtensionMapper"/>
Fetching Data (fetch)
Fetch product extensions with SQL-like filtering:
<to uri="pfx-api:fetch?objectType=PX&sql=select sku,attribute1 where name='Cars'"/>
Fetch with batched mode for large datasets:
<toD uri="pfx-api:fetch?objectType=DM&dsUniqueName=DMDS.PriceAdjustments&filter=myFilter&batchedMode=true&batchSize=50000"/>
Fetch condition record items:
<to uri="pfx-api:fetch?objectType=CRCI1&filter=conditionRecordsFilter"/>
Fetch with a named filter bean:
<to uri="pfx-api:fetch?objectType=P&filter=filterProductsBySku&countOnly=true"/>
Integrating Data (integrate)
Upsert company parameter values:
<to uri="pfx-api:integrate?objectType=LTV&mapper=exchangeRateMapper&pricingParameterName=ExchangeRate"/>
Importing into Datamarts (import)
Import data directly into a datamart data source:
<to uri="pfx-api:import?objectType=DMDS&dsUniqueName=Transaction&mapper=myMapper"/>
Mass Edit (massedit)
Mass-edit product extension attributes:
<pfx:dsMassEdit id="myMassEdit" objectType="PX" filter="theFilter">
<pfx:field name="attribute1" value="newValue"/>
</pfx:dsMassEdit>
Helper Methods
The ObjectType enum and its companion utility class ObjectTypeUtils provide helper methods for type classification:
-
ObjectType.requiresLookupTableIdOnMetadataFetch(type)-- ReturnstrueforLTV,MLTV,MLTV2..MLTV6(lookup table value types that need a table ID when fetching metadata). -
ObjectTypeUtils.isExtensionType(type)-- ReturnstrueforPX,CX,SX(extension entity types). -
ObjectTypeUtils.isLookupTableValueType(type)-- ReturnstrueforLTV,MLTV,MLTV2..MLTV6,JLTV,JLTV2. -
ObjectTypeUtils.isConditionalRecordType(type)-- ReturnstrueforCRCI1..CRCI12.
Source
-
Enum definition:
pricefx-client/src/main/java/net/pricefx/integration/api/ObjectType.java -
Type code mapping:
pricefx-client/src/main/java/net/pricefx/integration/api/TypeCode.java -
Utility methods:
pricefx-client/src/main/java/net/pricefx/integration/api/client/ObjectTypeUtils.java -
API actions:
pricefx-client/src/main/java/net/pricefx/integration/api/client/actions/ApiActions.java