Skip to content
Pricefx REST API
/
/User Admin

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

List Users

Request

Retrieves a list of users.

Information: If the authenticated user does not have the explicit USER_FETCH permission, the fields are reduced to a minimum.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
endRownumber

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

Default 300
oldValuesany
operationTypestringnon-empty
startRownumber

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

textMatchStylestringnon-empty
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.fetchusers \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "workflowEmailingActivated",
          "operator": "notEqual",
          "value": true
        }
      ]
    }
  }'

Responses

OK

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

Change a User Password

Request

Changes a specified user's password.

The authenticated user needs the ADMIN (including USERADMIN) permissions to perform this action. To change your own password, use the /accountmanager.changepassword endpoint instead.

Security
basic or X-PriceFx-jwt
Path
userIdstringrequired

Enter the ID of the user whose password you want to change. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806.

Example: 2147490806
Bodyapplication/json
dataobjectrequired
data.​newPasswordstringnon-emptyrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.changepassword/2147490806 \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "newPassword": "eqweqweqwQW112131FF*"
    }
  }'

Responses

OK

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

Change a Current User Password

Request

Changes an authenticated user's password.

Security
basic or X-PriceFx-jwt
Bodyapplication/json
dataobjectrequired
data.​newPasswordstring[ 1 .. 255 ] charactersrequired

The new password.

data.​oldPasswordstring[ 1 .. 255 ] charactersrequired

The current password. Necessary when changing own password.

curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.changepassword \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "newPassword": "eqweqweqwQW112131FF*",
      "oldPassword": "12345678pwdd9876543"
    }
  }'

Responses

OK

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

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

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