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

Copy a Manual Price List

Request

Creates a copy of the specified Manual Price List.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Manual Price List you want to copy.

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

Responses

Example response

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

Calculate a Manual Price List

Request

Starts a calculation of the entire Manual Price List.

Please note: The calculated Manual Price List must contain a value in the linkedCFStypedId (CFS Link) field to perform the calculation action.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Manual Price List you want to start the calculation for.

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

Responses

OK

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

Assign Customers

Request

Assigns multiple customers to the specified entity (e.g., Price List, Live Price Grid, etc.).

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobjectrequired
data.​customerGroupobject
data.​prioritynumberrequired
data.​assignmentstringnon-emptyrequired

The typedId of the entity you want to assign customers to.

Example: "211.PG"
operationstringnon-emptyrequired
Default "add"
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/customermanager.assign \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "customerGroup": {
        "customerFilterCriteria": {
          "_constructor": "AdvancedCriteria",
          "operator": "and",
          "criteria": [
            {
              "fieldName": "customerId",
              "operator": "inSet",
              "value": [
                "00002",
                "00003"
              ]
            }
          ]
        },
        "label": "00002,00003"
      },
      "priority": 1,
      "assignment": "211.PG"
    },
    "operation": "add"
  }'

Responses

Example response

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

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

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas