Pricefx Object Types

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

P

Product

Core product master data

loaddata, fetch, integrate, delete, massedit, update

PAM

ProductAttributeMeta

Product attribute metadata definitions

fetch

PBOME

ProductBoMEntry

Product Bill of Materials entry

loaddata, fetch

PCOMP

ProductCompetition

Product competition data

loaddata, fetch

PDESC

ProductDescription

Product description / localization

loaddata, fetch

PX

ProductExtension

Product extension table (custom attributes)

loaddata, fetch, integrate, delete, massedit, update

PXAM

ProductExtensionAttributeMeta

Product extension attribute metadata

fetch

PXREF

ProductXReference

Product cross-reference mappings

loaddata, fetch

PX3

PX3

Product extension with 3-key lookup

loaddata, fetch

PX6

PX6

Product extension with 6-key lookup

loaddata, fetch

PX8

PX8

Product extension with 8-key lookup

loaddata, fetch

PX10

PX10

Product extension with 10-key lookup

loaddata, fetch

PX20

PX20

Product extension with 20-key lookup

loaddata, fetch

PX30

PX30

Product extension with 30-key lookup

loaddata, fetch

PX50

PX50

Product extension with 50-key lookup

loaddata, fetch

Customers

Enum Value

API Type Code

Description

Used In

C

Customer

Core customer master data

loaddata, fetch, integrate, delete, massedit, update

CA

CustomerAssignment

Customer-to-seller assignment

loaddata, fetch

CAM

CustomerAttributeMeta

Customer attribute metadata definitions

fetch

CDESC

CustomerDescription

Customer description / localization

loaddata, fetch

CX

CustomerExtension

Customer extension table (custom attributes)

loaddata, fetch, integrate, delete, massedit, update

CXAM

CustomerExtensionAttributeMeta

Customer extension attribute metadata

fetch

CX3

CX3

Customer extension with 3-key lookup

loaddata, fetch

CX6

CX6

Customer extension with 6-key lookup

loaddata, fetch

CX8

CX8

Customer extension with 8-key lookup

loaddata, fetch

CX10

CX10

Customer extension with 10-key lookup

loaddata, fetch

CX20

CX20

Customer extension with 20-key lookup

loaddata, fetch

CX30

CX30

Customer extension with 30-key lookup

loaddata, fetch

CX50

CX50

Customer extension with 50-key lookup

loaddata, fetch

Sellers

Enum Value

API Type Code

Description

Used In

SL

SELLER

Seller master data

loaddata, fetch

SX

SellerExtension

Seller extension table (custom attributes)

loaddata, fetch, integrate, update

SXAM

SellerExtensionAttributeMeta

Seller extension attribute metadata

fetch

Company Parameters (Lookup Tables)

Enum Value

API Type Code

Description

Used In

LT

LookupTable

Lookup table definition/header

fetch, delete

LTV

LookupTableValue

Simple (single-key) lookup table values

loaddata, fetch, integrate, delete, massedit

MLTVM

MatrixLookupTableAttributeMeta

Matrix lookup table attribute metadata

fetch

MLTV

MatrixLookupTableValue

Matrix lookup table values (1 key)

loaddata, fetch, integrate, delete, massedit

MLTV2

MatrixLookupTableValue2Key

Matrix lookup table values (2 keys)

loaddata, fetch, integrate, delete, massedit

MLTV3

MatrixLookupTableValue3Key

Matrix lookup table values (3 keys)

loaddata, fetch, integrate, delete

MLTV4

MatrixLookupTableValue4Key

Matrix lookup table values (4 keys)

loaddata, fetch, integrate, delete

MLTV5

MatrixLookupTableValue5Key

Matrix lookup table values (5 keys)

loaddata, fetch, integrate, delete

MLTV6

MatrixLookupTableValue6Key

Matrix lookup table values (6 keys)

loaddata, fetch, integrate, delete

JLTV

JsonLookupTableValue

JSON-type lookup table values

loaddata, fetch

JLTV2

JsonLookupTableValue2

JSON-type lookup table values (2 keys)

loaddata, fetch

LTT

LOOKUPTABLETREE

Lookup table tree/hierarchy

fetch

Note: Lookup table value types (LTV, MLTV, MLTV2..MLTV6, JLTV, JLTV2) require a pricingParameterName parameter. Matrix types (MLTV..MLTV6) also require a lookup table ID for metadata fetch operations (see requiresLookupTableIdOnMetadataFetch).

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

SIMPLE

LTV

name

Single key, single value. Exchange rates, discount codes, status lookups.

RANGE

LTV

name + bounds

Range-based lookup. Tax brackets, volume discounts.

MATRIX

MLTV2

name

1-key matrix with multiple value attributes. Price by product.

MATRIX2

MLTV2

key1, key2

2-key matrix. Price by region + product type.

MATRIX3

MLTV2

key1key3

3-key matrix.

MATRIX4

MLTV2

key1key4

4-key matrix.

MATRIX5

MLTV2

key1key5

5-key matrix.

SIMPLE (LTV — single key/value):

Field

Description

name

The lookup key (required)

value

The lookup value (required)

RANGE (LTV — range lookup):

Field

Description

name

The lookup key (required)

lowerBound

Range lower bound

upperBound

Range upper bound

value

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

name

The lookup key (required)

attribute1attributeN

Value fields

MATRIX2–MATRIX5 (MLTV2 — multi-key matrix):

MATRIX2 and above use key1keyN instead of name:

Field

MATRIX2

MATRIX3

MATRIX4

MATRIX5

key1

yes

yes

yes

yes

key2

yes

yes

yes

yes

key3

yes

yes

yes

key4

yes

yes

key5

yes

attribute1attributeN

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

DS

(empty)

Generic data source (resolved at runtime)

loaddata, fetch

DF

(empty)

Generic data feed (resolved at runtime)

loaddata, fetch

DM

DMDatamart

Datamart data

loaddata, fetch, import, truncate, flush, refresh, export, calculate

DMDS

DMDataSource

Datamart data source definition

import, fetch

DMS

DMSchema

Datamart schema

fetch

DMSIM

DMSimDatamart

Simulation datamart

fetch

DMSSIM

DMSimSchema

Simulation datamart schema

fetch

DMDC

DMDATACHUNK

Datamart data chunk

internal

DMDL

DMDATALOAD

Datamart data load tracking

internal

DMF

DMDATAFEED

Datamart data feed

fetch

DMM

DMMODEL

Datamart model

fetch

DMQC

DMQUERYCACHE

Datamart query cache

internal

DMSSCALC

DMSALESSIMDATAMARTCALCULATION

Sales simulation datamart calculation

internal

DMV

DMVIEW

Datamart view

fetch

DMT

Model

Datamart model (alias)

fetch

DWT

DWTABLE

Data warehouse table

fetch

Price Lists

Enum Value

API Type Code

Description

Used In

PL

Pricelist

Price list header

fetch

PLI

PricelistItem

Price list line items

fetch, update, loaddata

PLIM

PricelistItemAttributeMeta

Price list item attribute metadata

fetch

PLT

PRICELISTTREE

Price list tree/hierarchy

fetch

PLPGTT

PRICELISTPRICEGRIDTYPE

Price list / price grid type mapping

fetch

MPL

ManualPricelist

Manual price list header

fetch, calculate

MPLI

ManualPricelistItem

Manual price list line items

fetch, integrate, loaddata

MPLAM

ManualPricelistItemAttributeMeta

Manual price list item attribute metadata

fetch

MPLT

MANUALPRICELISTTREE

Manual price list tree

fetch

MPLIT

MANUALPRICELISTINTEGRATIONTAG

Manual price list integration tag

fetch

Price Grids

Enum Value

API Type Code

Description

Used In

PG

PriceGrid

Price grid header

fetch, calculate

PGI

PriceGridItem

Price grid line items

fetch, update, loaddata

PGIM

PriceGridItemAttributeMeta

Price grid item attribute metadata

fetch

PGT

PRICEGRIDTREE

Price grid tree/hierarchy

fetch

LPG

LIVEPRICEGRID

Live price grid

fetch, update

XPLI

MatrixPricelistItem

Matrix price list item

fetch, loaddata

XPGI

MATRIXPRICEGRIDITEM

Matrix price grid item

fetch, loaddata

XLPG

MATRIXLIVEPRICEGRID

Matrix live price grid

fetch, update

XSIMI

MatrixSimulationItem

Matrix simulation item

fetch

Price Records

Enum Value

API Type Code

Description

Used In

PR

PriceRecord

Price record data

loaddata, fetch, integrate

PRAM

PriceRecordAttributeMeta

Price record attribute metadata

fetch

Quotes

Enum Value

API Type Code

Description

Used In

Q

Quote

Quote header

fetch, save, price, addProducts, createNewRevision

QLI

QuoteLineItem

Quote line items

fetch

QAM

QUOTEATTRIBUTEMETA

Quote attribute metadata

fetch

QT

QUOTETREE

Quote tree/hierarchy

fetch

QTT

QUOTETYPE

Quote type definition

fetch

QTTAM

QUOTETYPEATTRIBUTEMETA

Quote type attribute metadata

fetch

Contracts

Enum Value

API Type Code

Description

Used In

CT

Contract

Contract header

fetch, loaddata

CTLI

ContractLineItem

Contract line items

fetch

CTT

ContractTermType

Contract term type definition

fetch

CTTAM

ContractTermTypeAttributeMeta

Contract term type attribute metadata

fetch

CTAM

CONTRACTATTRIBUTEMETA

Contract attribute metadata

fetch

CTTREE

CONTRACTTREE

Contract tree/hierarchy

fetch

Rebates

Enum Value

API Type Code

Description

Used In

RBA

RebateAgreement

Rebate agreement header

fetch, loaddata

RBALI

RebateAgreementLineItem

Rebate agreement line items

fetch

RBAAM

REBATEAGREEMENTATTRIBUTEMETA

Rebate agreement attribute metadata

fetch

RBAT

REBATEAGREEMENTTREE

Rebate agreement tree

fetch

RAT

REBATEAGREEMENTTEMPLATE

Rebate agreement template

fetch

RATM

REBATEAGREEMENTTEMPLATEATTRIBUTEMETA

Rebate agreement template attribute metadata

fetch

RR

RebateRecord

Rebate record data

loaddata, fetch, integrate

RRAM

RebateRecordAttributeMeta

Rebate record attribute metadata

fetch

RRS

REBATERECORDSET

Rebate record set

fetch

RRSC

REBATERECORDSETCALCULATION

Rebate record set calculation

fetch

RBT

RebateType

Rebate type definition

fetch

RBTAM

RebateTypeAttributeMeta

Rebate type attribute metadata

fetch

PYR

PAYOUTRECORD

Payout record (rebate payout)

loaddata, fetch

PYRAM

PAYOUTRECORDATTRIBUTEMETA

Payout record attribute metadata

fetch

Claims

Enum Value

API Type Code

Description

Used In

CL

CLAIM

Claim header

fetch, loaddata

CLLI

CLAIMLINEITEM

Claim line items

fetch

CLLIAM

CLAIMLINEITEMATTRIBUTEMETA

Claim line item attribute metadata

fetch

CLR

CLAIMRECORD

Claim record data

loaddata, fetch

CLT

CLAIMTYPE

Claim type definition

fetch

Custom Forms

Enum Value

API Type Code

Description

Used In

CFO

CustomForm

Custom form instance

fetch, add, update, delete, duplicate, changeStatus, createNewRevision

CFOT

CustomFormType

Custom form type definition

fetch

Simulations

Enum Value

API Type Code

Description

Used In

SIM

Simulation

Simulation header

fetch

SIMI

SimulationItem

Simulation line items

fetch

SIAM

SimulationItemAttributeMeta

Simulation item attribute metadata

fetch

Calculated Field Sets

Enum Value

API Type Code

Description

Used In

CFS

CalculatedFieldSet

Calculated field set

fetch, calculate, cancel

Condition Records

Enum Value

API Type Code

Description

Used In

CRCP

ConditionRecordProcessing

Condition record processing/load trigger

loaddata

CRCI1..CRCI12

ConditionRecordItem1Key..ConditionRecordItem12Key

Condition record items (1-12 key variants)

fetch, loaddata

CRCIH1..CRCIH12

ConditionRecordItemHistory1Key..ConditionRecordItemHistory12Key

Condition record item history (1-12 key variants)

fetch

CRCIALL1..CRCIALL12

ConditionRecordItemAll1Key..ConditionRecordItemAll12Key

Condition record items - all records (1-12 key variants)

fetch

CRCS

ConditionRecordSet

Condition record set definition

fetch

Formulas & Logic

Enum Value

API Type Code

Description

Used In

F

Formula

Pricing formula (logic element)

fetch, execute

FE

PRICINGFORMULAELEMENT

Pricing formula element

fetch

FI

FORMULAINVARIANT

Formula invariant

fetch

FIE

FORMULAINVARIANTELEMENT

Formula invariant element

fetch

FIER

FORMULAINVARIANTENGINERUN

Formula invariant engine run

fetch

CF

CALCULATIONFLOW

Calculation flow

fetch

CFT

CALCULATIONFLOWTRAIT

Calculation flow trait

fetch

WF

WORKFLOWFORMULA

Workflow formula

fetch

WFE

WORKFLOWFORMULAELEMENT

Workflow formula element

fetch

Users, Roles & Security

Enum Value

API Type Code

Description

Used In

U

User

User account

fetch, save

UG

UserGroup

User group

fetch

R

Role

Security role

fetch

BR

BusinessRole

Business role

fetch

APIK

APIKEY

API key

fetch

LAT

LOGINAUDITTRAIL

Login audit trail

fetch

SAT

SECURITYAUDITTRAIL

Security audit trail

fetch

PWH

PASSWORDHISTORY

Password history

internal

TFA

TFATOKEN

Two-factor authentication token

internal

RT

REFRESHTOKEN

Refresh token

internal

Workflows & Events

Enum Value

API Type Code

Description

Used In

W

Workflow

Workflow definition

fetch

EVT

Event

Event/task

fetch

TODO

ToDoItem

To-do / action item

fetch

IE

INTERNALEVENT

Internal system event

internal

ET

EMAILTASK

Email task

internal

Data Change Requests

Enum Value

API Type Code

Description

Used In

DCR

DataChangeRequest

Data change request header

fetch

DCRI

DataChangeRequestItem

Data change request line item

fetch

DCRAM

DataChangeRequestItemAM

Data change request item attribute metadata

fetch

DCRT

DataChangeRequestType

Data change request type

fetch

DCRL

DATACHANGEREQUESTLOG

Data change request log

fetch

DCRMC

DATACHANGEREQUESTMASSCHANGE

Data change request mass change

fetch

System & Administration

Enum Value

API Type Code

Description

Used In

AP

ApplicationProperties

Application/partition properties

fetch

BPT

BoundPartition

Bound partition configuration

fetch

PT

Partition

Partition definition

fetch

PH

PARTITIONHELP

Partition help content

fetch

DB

Dashboard

Dashboard definition

fetch

SC

SAVEDCHART

Saved chart

fetch

SCT

SAVEDCHARTTREE

Saved chart tree

fetch

FN

FILTERNODE

Filter node definition

fetch

CN

CLUSTERNODE

Cluster node info

fetch

CS

CALCULATIONSCHEDULE

Calculation schedule

fetch

PREF

PREFERENCES

User/system preferences

fetch

IDC

INLINEDETAILSCONFIGURATION

Inline details UI configuration

fetch

IFP

INFORMATIONFLOWPROCESSOR

Information flow processor

fetch

BD

BINARYDATA

Binary data (file attachments)

bdManagerUpload, fetch

DA

DATAARCHIVE

Data archive

fetch

DE

DATAEXPORT

Data export job

fetch

DI

DATAIMPORT

Data import job

fetch

DREG

DEVICEREGISTRATION

Device registration

fetch

ISH

INTEGRATIONSTATUSHISTORY

Integration status history

fetch

JST

JOBSTATUSTRACKER

Job status tracker

fetch

US

UPLOADSTATUS

Upload status

fetch

PAPIJ

PRICEAPIJOB

Price API job

fetch

CH

COMMENTHISTORY

Comment history

fetch

MO

MODEL

Model definition

fetch

MR

MODELRECORD

Model record

fetch, loaddata

MRAM

MODELRECORDATTRIBUTEMETA

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:

XML
<to uri="pfx-api:loaddata?objectType=P&amp;mapper=productMapper&amp;businessKeys=sku"/>

Load customer master data:

XML
<to uri="pfx-api:loaddata?objectType=C&amp;mapper=customerMapper&amp;businessKeys=customerId"/>

Load company parameter (lookup table) values:

XML
<to uri="pfx-api:loaddata?objectType=LTV&amp;mapper=currencyMapper&amp;pricingParameterName=currency"/>

Load matrix company parameter values (2-key):

XML
<to uri="pfx-api:loaddata?objectType=MLTV2&amp;mapper=discountMapper&amp;pricingParameterName=discount"/>

Load product extension data:

XML
<to uri="pfx-api:loaddata?objectType=PX&amp;mapper=carsMapper&amp;businessKeys=sku,name,attribute1"/>

Load condition records:

XML
<to uri="pfx-api:loaddata?objectType=CRCP&amp;mapper=conditionRecordsMapper"/>

Load seller extension data:

XML
<to uri="pfx-api:loaddata?objectType=SX&amp;mapper=sellerExtensionMapper"/>

Fetching Data (fetch)

Fetch product extensions with SQL-like filtering:

XML
<to uri="pfx-api:fetch?objectType=PX&amp;sql=select sku,attribute1 where name='Cars'"/>

Fetch with batched mode for large datasets:

XML
<toD uri="pfx-api:fetch?objectType=DM&amp;dsUniqueName=DMDS.PriceAdjustments&amp;filter=myFilter&amp;batchedMode=true&amp;batchSize=50000"/>

Fetch condition record items:

XML
<to uri="pfx-api:fetch?objectType=CRCI1&amp;filter=conditionRecordsFilter"/>

Fetch with a named filter bean:

XML
<to uri="pfx-api:fetch?objectType=P&amp;filter=filterProductsBySku&amp;countOnly=true"/>

Integrating Data (integrate)

Upsert company parameter values:

XML
<to uri="pfx-api:integrate?objectType=LTV&amp;mapper=exchangeRateMapper&amp;pricingParameterName=ExchangeRate"/>

Importing into Datamarts (import)

Import data directly into a datamart data source:

XML
<to uri="pfx-api:import?objectType=DMDS&amp;dsUniqueName=Transaction&amp;mapper=myMapper"/>

Mass Edit (massedit)

Mass-edit product extension attributes:

XML
<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) -- Returns true for LTV, MLTV, MLTV2..MLTV6 (lookup table value types that need a table ID when fetching metadata).

  • ObjectTypeUtils.isExtensionType(type) -- Returns true for PX, CX, SX (extension entity types).

  • ObjectTypeUtils.isLookupTableValueType(type) -- Returns true for LTV, MLTV, MLTV2..MLTV6, JLTV, JLTV2.

  • ObjectTypeUtils.isConditionalRecordType(type) -- Returns true for CRCI1..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