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

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

Assign a User to a User Group

Request

Assigns a User Group to the specified user.

Security
basic or X-PriceFx-jwt
Path
userIdstringrequired

The ID of the user you want to add to the group. The userId is the typedId without the U suffix. For example, userId of the 2147490806.U is 2147490806.

Bodyapplication/json
dataobjectrequired
data.​assignbooleanrequired

Set to true to add the user to the User Group. Set false to remove the user from the group.

data.​typedIdstringnon-emptyrequired

TypedId of the User Group you want to assign or revoke. Either typedId or uniqeName is required.

data.​uniqueNamestring[ 1 .. 255 ] charactersrequired

uniqeName of the User Group you want to assign or revoke. Either typedId or uniqeName is required.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.assigngroup/{userId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "assign": true,
      "uniqueName": "PricingManagers",
      "typedId": "15666.UG"
    }
  }'

Responses

OK

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

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

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas