Skip to content

The Pricefx Backend API

Pricefx REST API Reference

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

User Admin

Operations

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Advanced Configuration Options

Operations

Data Manager

Operations

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Calculate a Calculation Grid

Request

Start the calculation job of the specified Calculation Grid. Returns the JobStatusTracker object (JST).

Security
basic or X-PriceFx-jwt
Path
idstringrequired

id of the Calculation Grid you want to calculate.

Example: 99
Bodyapplication/json
priorityinteger

A user-defined priority.

Enum0123456789
Example: 0
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationgridmanager.calculate/99 \
  -H 'Content-Type: application/json' \
  -d '{
    "priority": 0
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{ "response": { "node": "e2e-tabasco-node", "data": [], "status": 0 } }

Add a Calculation Grid Item

Request

Adds a new record (CGI) to the Calculation Grid.

Security
basic or X-PriceFx-jwt
Path
keyNumberstringrequired

Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys.

Enum"1""2""3""4""5""6"
Example: 6
Bodyapplication/json
dataCalculationGridItem1Key (object) or CalculationGridItem2Key (object) or CalculationGridItem3Key (object) or CalculationGridItem4Key (object) or CalculationGridItem5Key (object) or CalculationGridItem6Key (object)
Any of:

The type code is CGI1.

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/CGI6 \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "key1": "1",
      "key2": "q",
      "key3": "2",
      "key4": "aa",
      "key5": "q",
      "key6": "u",
      "calculationGridId": 7
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{ "response": { "node": "e2e-tabasco-node", "data": [], "status": 0 } }

List Calculation Grid Items

Request

Retrieves all Calculation Grid Items for the specified Calculation Grid.

Security
basic or X-PriceFx-jwt
Path
keyNumberstringrequired

Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys.

Enum"1""2""3""4""5""6"
Bodyapplication/json
endRowinteger
oldValuesobject or null
operationTypestring
startRowinteger
textMatchStylestring
dataobjectrequired
data.​calculationGridIdstringrequired

id of the Calculation Grid you want to retrieve Calculation Grid Items for.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CGI{keyNumber}' \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "calculationGridId": "7"
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [], "endRow": 0, "totalRows": 0, "status": 0 } }

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

Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

MCP

Operations

Clicmanager

Operations

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas