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

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

Fetch Activities

Request

Fetches activities for a CLIC module activity log in a concise format, e.g., when multiple 'add item' actions are performed consecutively, they are consolidated into a single activity log entry containing all details.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
endRowinteger
oldValuesstring
operationTypestring
startRowinteger
textMatchStylestring
dataobject
sortByArray of strings
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/activitylog.fetch \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 0,
    "oldValues": "string",
    "operationType": "string",
    "startRow": 0,
    "textMatchStyle": "string",
    "data": {
      "_constructor": "string",
      "operator": "string",
      "criteria": [
        {
          "_constructor": "string",
          "operator": "string",
          "criteria": [
            {
              "fieldName": "string",
              "operator": "string",
              "value": "string",
              "_constructor": "string"
            }
          ]
        }
      ]
    },
    "sortBy": [
      "string"
    ]
  }'

Responses

OK

Bodyapplication/json
object
Response
application/json
{}

Add Line Items

Request

Adds new line items, with optional inputs and label, to a CLIC document (Quote, Agreement/Promotion, Rebate Agreement or Compensation Plan) identified by its typedId.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

typed ID of the target CLIC document

Bodyapplication/json
dataobject
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.additems/{typedId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "contractTermTypes": [
        {
          "contractTermType": "SimplePromotion",
          "dirty": true,
          "label": "Simple Promotion",
          "folder": true,
          "inputs": [
            {
              "name": "Promotion €",
              "value": "string"
            }
          ],
          "outputs": [
            {}
          ]
        }
      ]
    }
  }'

Responses

OK

Body
object
Response
No response example

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas