Lookup Tables / Company Parameters

General

Operations

Products

Operations

Product Extensions

Operations

Product Image

Operations

Customers

Operations

Customer Extensions

Operations

Sellers

Operations

Seller Extensions

Operations

Condition Records

Operations

Competition Data

Operations

Imports

Operations

Data Change Requests

Operations

Lookup Tables / Company Parameters

Operations

Upsert a Lookup Table Value

Request

Creates a new Company Parameter record (LookupTableValue or MatrixLookupTableValue) or updates an existing record (if the specified name of the record already exists).

Required Permission	Roles with the Required Permission
LOOKUPTABLEVALUES_INTEGRATE	Data Integration (`DATAINTEGRATION`)

Security

basic or X-PriceFx-jwt

Path

tableIdstringrequired

Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method.

Bodyapplication/json

dataobjectrequired

data.namestringnon-emptyrequired

data.valuestringnon-emptyrequired

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.integrate/{tableId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "name": "tofu",
      "value": "0.05"
    }
  }'

Responses

OK

Bodyapplication/json

responseobjectrequired

response.nodestringnon-emptyrequired

response.dataArray of objectsnon-emptyuniquerequired

response.data[].versionnumberrequired

response.data[].typedIdstringnon-emptyrequired

response.data[].namestringnon-emptyrequired

response.data[].valuestringnon-emptyrequired

response.data[].lowerBoundany

response.data[].upperBoundany

response.data[].lastUpdateByNamestringnon-emptyrequired

response.data[].createdByNamestringnon-emptyrequired

response.data[].tableIdnumberrequired

response.data[].typestringnon-emptyrequired

response.data[].valueTypestringnon-emptyrequired

response.data[].rawValuestringnon-emptyrequired

response.data[].createDatestringnon-emptyrequired

response.data[].createdBynumberrequired

response.data[].lastUpdateDatestringnon-emptyrequired

response.data[].lastUpdateBynumberrequired

response.statusnumberrequired

Response

application/json

{
  "response": {
    "node": "<node>",
    "data": [ … ],
    "status": 0
  }
}

Update a Lookup Table Value

Request

Updates LookupTableValue. Returns a list of updated LookupTableValue/MatrixLookupTableValue objects.

Required Permission	Roles with the Required Permission
LOOKUPTABLE_UPDATE	Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)

Security

basic or X-PriceFx-jwt

Path

tableIdstringrequired

Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method.

Bodyapplication/json

dataobjectrequired

data.typedIdstringnon-emptyrequired

data.attribute1stringnon-emptyrequired

oldValuesobjectrequired

oldValues.versionnumberrequired

oldValues.typedIdstringnon-emptyrequired

oldValues.lastUpdateByNamestringnon-emptyrequired

oldValues.createdByNamestringnon-emptyrequired

oldValues.tableIdany

oldValues.typestringnon-emptyrequired

oldValues.valueTypestringnon-emptyrequired

oldValues.lookupTableTypedIdstringnon-emptyrequired

oldValues.createDatestringnon-empty

oldValues.createdBynumber

oldValues.lastUpdateDatestringnon-empty

oldValues.lastUpdateBynumber

oldValues.attribute1any

oldValues.attribute2any

oldValues.attribute3any

oldValues.attribute4any

oldValues.attribute5any

oldValues.attribute6any

oldValues.attribute7any

oldValues.attribute8any

oldValues.attribute9any

oldValues.attribute10any

oldValues.attribute11any

oldValues.attribute12any

oldValues.attribute13any

oldValues.attribute14any

oldValues.attribute15any

oldValues.attribute16any

oldValues.attribute17any

oldValues.attribute18any

oldValues.attribute19any

oldValues.attribute20any

oldValues.attribute21any

oldValues.attribute22any

oldValues.attribute23any

oldValues.attribute24any

oldValues.attribute25any

oldValues.attribute26any

oldValues.attribute27any

oldValues.attribute28any

oldValues.attribute29any

oldValues.attribute30any

oldValues.namestringnon-emptyrequired

operationTypestringnon-emptyrequired

textMatchStylestringnon-emptyrequired

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.update/{tableId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "typedId": "2147497641.MLTV",
      "attribute1": "250"
    },
    "oldValues": {
      "version": 10,
      "typedId": "2147497641.MLTV",
      "lastUpdateByName": "admin",
      "createdByName": "admin",
      "tableId": null,
      "type": "MATRIX",
      "valueType": "MATRIX",
      "lookupTableTypedId": "2147484036.LT",
      "createDate": "2021-10-06T10:53:52",
      "createdBy": 2147490696,
      "lastUpdateDate": "2021-10-06T13:20:24",
      "lastUpdateBy": 2147490696,
      "attribute1": null,
      "attribute2": null,
      "attribute3": null,
      "attribute4": null,
      "attribute5": null,
      "attribute6": null,
      "attribute7": null,
      "attribute8": null,
      "attribute9": null,
      "attribute10": null,
      "attribute11": null,
      "attribute12": null,
      "attribute13": null,
      "attribute14": null,
      "attribute15": null,
      "attribute16": null,
      "attribute17": null,
      "attribute18": null,
      "attribute19": null,
      "attribute20": null,
      "attribute21": null,
      "attribute22": null,
      "attribute23": null,
      "attribute24": null,
      "attribute25": null,
      "attribute26": null,
      "attribute27": null,
      "attribute28": null,
      "attribute29": null,
      "attribute30": null,
      "name": "matrixValue"
    },
    "operationType": "update",
    "textMatchStyle": "exact"
  }'

Responses

OK

Bodyapplication/json

responseobjectrequired

response.nodestringnon-emptyrequired

response.dataArray of objectsnon-emptyuniquerequired

response.data[].versionnumberrequired

response.data[].typedIdstringnon-emptyrequired

response.data[].lastUpdateByNamestringnon-emptyrequired

response.data[].createdByNamestringnon-emptyrequired

response.data[].tableIdnumberrequired

response.data[].typestringnon-emptyrequired

response.data[].valueTypestringnon-emptyrequired

response.data[].lookupTableTypedIdstringnon-emptyrequired

response.data[].createDatestringnon-emptyrequired

response.data[].createdBynumberrequired

response.data[].lastUpdateDatestringnon-emptyrequired

response.data[].lastUpdateBynumberrequired

response.data[].attribute1stringnon-emptyrequired

response.data[].attribute2any

response.data[].attribute3any

response.data[].attribute4any

response.data[].attribute5any

response.data[].attribute6any

response.data[].attribute7any

response.data[].attribute8any

response.data[].attribute9any

response.data[].attribute10any

response.data[].attribute11any

response.data[].attribute12any

response.data[].attribute13any

response.data[].attribute14any

response.data[].attribute15any

response.data[].attribute16any

response.data[].attribute17any

response.data[].attribute18any

response.data[].attribute19any

response.data[].attribute20any

response.data[].attribute21any

response.data[].attribute22any

response.data[].attribute23any

response.data[].attribute24any

response.data[].attribute25any

response.data[].attribute26any

response.data[].attribute27any

response.data[].attribute28any

response.data[].attribute29any

response.data[].attribute30any

response.data[].namestringnon-emptyrequired

response.statusnumberrequired

Response

application/json

{
  "response": {
    "node": "<node>",
    "data": [ … ],
    "status": 0
  }
}

Delete a Lookup Table Value

Request

Deletes a record (LookupTableValue or MatrixLookupTableValue) from the specified Company Parameters table (LookupTable).

Required Permission	Roles with the Required Permission
LOOKUPTABLE_REMOVE	Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)

Security

basic or X-PriceFx-jwt

Path

tableIdstringrequired

Enter the ID of the table. The ID can be retrieved using the /lookuptablemanager.fetch method.

Bodyapplication/json

dataobjectrequired

data.typedIdstringnon-emptyrequired

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.delete/{tableId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "typedId": "2147497641.MLTV"
    }
  }'

Responses

OK

Bodyapplication/json

responseobjectrequired

response.nodestringnon-emptyrequired

response.dataArray of objectsnon-emptyuniquerequired

response.data[].versionnumberrequired

response.data[].typedIdstringnon-emptyrequired

response.data[].lastUpdateByNamestringnon-emptyrequired

response.data[].createdByNamestringnon-emptyrequired

response.data[].tableIdnumberrequired

response.data[].typestringnon-emptyrequired

response.data[].valueTypestringnon-emptyrequired

response.data[].lookupTableTypedIdstringnon-emptyrequired

response.data[].createDatestringnon-emptyrequired

response.data[].createdBynumberrequired

response.data[].lastUpdateDatestringnon-emptyrequired

response.data[].lastUpdateBynumberrequired

response.data[].attribute1stringnon-emptyrequired

response.data[].attribute2any

response.data[].attribute3any

response.data[].attribute4any

response.data[].attribute5any

response.data[].attribute6any

response.data[].attribute7any

response.data[].attribute8any

response.data[].attribute9any

response.data[].attribute10any

response.data[].attribute11any

response.data[].attribute12any

response.data[].attribute13any

response.data[].attribute14any

response.data[].attribute15any

response.data[].attribute16any

response.data[].attribute17any

response.data[].attribute18any

response.data[].attribute19any

response.data[].attribute20any

response.data[].attribute21any

response.data[].attribute22any

response.data[].attribute23any

response.data[].attribute24any

response.data[].attribute25any

response.data[].attribute26any

response.data[].attribute27any

response.data[].attribute28any

response.data[].attribute29any

response.data[].attribute30any

response.data[].namestringnon-emptyrequired

response.statusnumberrequired

Response

application/json

{
  "response": {
    "node": "<node>",
    "data": [ … ],
    "status": 0
  }
}

User Admin

Operations

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Data Manager

Operations

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Visual Configuration

Operations

Quotes

Operations

Contracts (Agreements & Promotions)

Operations

Visual Configuration

Operations

Rebate Agreements

Operations

Rebate Calculations

Operations

Rebate Record Group

Operations

Sales Compensations

Operations

Claim Types

Operations

Claims

Operations

Optimization

Operations

Workflow

Operations

Workflow Delegation

Operations

Attachments

To upload a file you need to perform the following actions using endpoints in this category:

Create an Upload Slot
Upload a File
Delete an Upload Slot

Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

Clicmanager

Clicmanager (CLIC = "Calculable Line Item Collection") endpoints are used in the REACT version to manipulate Quote/Agreements & Promotions (Contract)/Rebate Agreement/Compensation Plan objects.

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

See the Key-Value Database Storage Knowledge Base article for more details.

Operations

Entities

Here you can find all fields of the corresponding entity (represented by the type code).
Use the /metadata.describe endpoint to find out the correct data type of the field that is used in your partition.

otherSchemas

Schemas

The Pricefx Backend APICopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

General

Products

Product Extensions

Product Image

Customers

Customer Extensions

Sellers

Seller Extensions

Condition Records

Competition Data

Imports

Data Change Requests

Lookup Tables / Company Parameters

Upsert a Lookup Table Value

RequestExpand all

Responses

Was this helpful?

Update a Lookup Table Value

RequestExpand all

Responses

Was this helpful?

Delete a Lookup Table Value

RequestExpand all

Responses

Was this helpful?

User Admin

Authentication

Admin Tools

Logics

Logs

Custom Forms

Calculated Field Sets

Jobs & Tasks

Data Manager

Actions

Action Types

Price Lists

Manual Price Lists

Live Price Grids

Calculation Grids

Visual Configuration

Quotes

Contracts (Agreements & Promotions)

Visual Configuration

Rebate Agreements

Rebate Calculations

Rebate Record Group

Sales Compensations

Claim Types

Claims

Optimization

Workflow

Workflow Delegation

Attachments

Product Image

Configuration

Internationalization

Metadata

Clicmanager

Comments

Notifications

Heartbeat

Key-Value Store

Entities

otherSchemas

The Pricefx Backend API
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request

Request

Request