Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Insert Bulk Data to Looku...

The Pricefx Backend API

Pricefx REST API Reference

Download OpenAPI description
pricefx-server_openapi.json
pricefx-server_openapi.yaml
Overview
URL
https://www.pricefx.com
Pricefx
documentation@pricefx.com
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}

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

Delete Column Values (Matrix only)

Request

Resets column data of a given lookup table. Currently MatrixLookupTable tables.

Required PermissionRoles with the Required Permission
LOOKUPTABLE_REMOVEAdminister 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.

columnNamestringrequired

Enter the name of the column you want to delete values from.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.resetcolumn/{tableId}/{columnName}'

Responses

OK

Insert Bulk Data to Lookup Table

Request

Inserts multiple records to the specified Lookup Table.

The /loaddata operation is a very efficient and quick way to insert bulk data. The main advantage is its greater speed when loading thousands of records (compared to e.g. /integrate).

Security
basic or X-PriceFx-jwt
Path
TypeCodestringrequired

Enter the type code of the Lookup Table entity you want to insert a data to.

Enum"JLTV""JLTVM""LT""LTT""LTV""MLTV""MLTV2""MLTV3""MLTV4""MLTV5"
Example: MLTV
Bodyapplication/json

We used /lookuptablemanager.loaddata/MLTV in the request example to insert bulk data to Matrix Lookup Table. Notice that the lookupTable is used in the header section and then ID of the Lookup Table in the data section

dataobjectrequired
data.​headerArray of anyrequired

Specify fields (columns) where you want to insert the data to.

data.​dataArray of anyrequired

Enter values you want to add to the fields (columns).

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.loaddata/MLTV \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "header": [
        "attribute1",
        "lookupTable"
      ],
      "data": [
        [
          "att1-1",
          "2147484051"
        ],
        [
          "att1-2",
          "2147484051"
        ],
        [
          "att1-3",
          "2147484051"
        ]
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobjectrequired
response.​nodestringnon-emptyrequired
response.​csrfTokenstringnon-emptyrequired
response.​dataArray of objectsrequired
response.​statusnumberrequired
Response
application/json
{
  "response": {
    "node": "string",
    "csrfToken": "string",
    "data": [ … ],
    "status": 0
  }
}

Copy a Lookup Table

Request

Creates a copy of the specified Lookup Table, including LookupTableValue/MatrixLookupTableValue values and preferences.

Required PermissionRoles with the Required Permission
LOOKUPTABLE_COPYAdminister Price Parameters (PB_PARAMETERS), Administer Plasma (PLASMA)
Security
basic or X-PriceFx-jwt
Path
tableIdstringrequired

Enter the ID of the table you want to copy.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/lookuptablemanager.copy/{tableId}'

Responses

OK

Bodyapplication/json
responseobjectrequired
response.​nodestringnon-emptyrequired
response.​csrfTokenstringnon-emptyrequired
response.​dataArray of objectsnon-emptyuniquerequired
response.​data[].​versionnumberrequired
response.​data[].​typedIdstringnon-emptyrequired
response.​data[].​uniqueNamestringnon-emptyrequired
response.​data[].​labelany
response.​data[].​validAfterstringnon-emptyrequired
response.​data[].​statusstringnon-emptyrequired
response.​data[].​simulationSetany
response.​data[].​typestringnon-emptyrequired
response.​data[].​valueTypestringnon-emptyrequired
response.​data[].​nodeIdany
response.​data[].​userGroupEditany
response.​data[].​userGroupViewDetailsany
response.​data[].​hideWarningsbooleanrequired
response.​data[].​formatTypeany
response.​data[].​lastUpdateByNamestringnon-emptyrequired
response.​data[].​createdByNamestringnon-emptyrequired
response.​data[].​numberOfKeyFieldsnumberrequired
response.​data[].​createDatestringnon-emptyrequired
response.​data[].​createdBynumberrequired
response.​data[].​lastUpdateDatestringnon-emptyrequired
response.​data[].​lastUpdateBynumberrequired
response.​data[].​idnumberrequired
response.​data[].​isPlasmabooleanrequired
response.​statusnumberrequired
Response
application/json
{
  "response": {
    "node": "string",
    "csrfToken": "string",
    "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:

  1. Create an Upload Slot
  2. Upload a File
  3. 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