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

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

Add a Calculation

Request

Adds a Calculation (CompensationRecordSetCalculation) for the specified Compensation Record Set.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobject
operationTypestring
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/CORSC \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "label": "SC_records",
      "compensationRecordSetId": 1
    },
    "operationType": "add"
  }'

Responses

OK

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

List Calculations

Request

Retrieves Calculation (CompensationRecordSetCalculation) objects. A filter can be applied.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
endRowinteger
oldValuesobject or null
operationTypestring
startRowinteger
textMatchStylestring
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CORSC \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "status",
          "operator": "equals",
          "value": "READY"
        }
      ]
    }
  }'

Responses

OK

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

Save Calculation

Request

Updates Calculation details.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobject(CompensationRecordSetCalculation)

The CompensationRecordSetCalculation object. The type code is CORSC.

operationTypestring
textMatchStylestring
oldValuesobject or null
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/calculationrecord.savecalc \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "version": 617,
      "typedId": "3.CORSC",
      "label": "Sales Compensations",
      "calculationMessages": "[\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\"]",
      "compensationRecordSetId": 1,
      "compensationRecordSetLabel": "Sales Compensations",
      "dtoFilter": {
        "_constructor": "AdvancedCriteria",
        "criteria": [
          {
            "fieldName": "sourceId",
            "operator": "equals",
            "value": "CO-157"
          }
        ],
        "operator": "and"
      },
      "calculationType": "RECORD",
      "calculationConfig": {
        "formulaName": "SC_Compensation",
        "feederInputParams": [],
        "inputParams": [],
        "mappingParams": [],
        "outputElements": []
      },
      "createDate": "2022-06-09T08:21:13",
      "createdBy": 290,
      "lastUpdateDate": "2022-06-24T10:44:59",
      "lastUpdateBy": 290,
      "status": "READY",
      "calculationStartDate": "2022-06-24T10:26:20",
      "calculationDate": "2022-06-24T10:44:59",
      "isDefault": true,
      "incremental": false,
      "incCalculationDate": "2022-06-24T10:26:20",
      "shouldSubmit": false,
      "valid": true
    },
    "operationType": "update",
    "textMatchStyle": "exact",
    "oldValues": null
  }'

Responses

OK

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

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