Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Get Folder Statistics

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

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

Import Line Items (w/o Input Types)

Request

Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.

The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired
Bodyapplication/json
dataobject
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.importlineitems/{typedId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "parent": "ROOT",
      "skus": [
        {
          "inputs": [
            {
              "name": "Integer Input",
              "value": "123"
            }
          ],
          "label": "TEST",
          "sku": "B-0006",
          "folder": false
        }
      ]
    }
  }'

Responses

OK - ServerMessageExtended property contains information about what was imported

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "pricefx-cluster-app-frontend-79df676dd9-lr6pk",
    "data": [ … ],
    "status": 0
  }
}

Get Folder Statistics

Request

Returns a list of parent IDs with the count of nested items. An example can be a list of Quote folders (their IDs) with the count of line items inside them.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

typedId of the document whose folder statistics you want to fetch.

Example: 2147494.Q
Query
withLineIdsboolean

If set to true, returns a list of line item IDs inside the folders instead of their count.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.folderstats/2147494.Q?withLineIds=true'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "pricefx-cluster",
    "data": [ … ],
    "status": 0
  }
}

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
{}

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