Pricefx REST API Reference
Pricefx REST API
/Notifications
Master
General
Products
Product Extensions
Product Image
Customers
Customer Extensions
Sellers
Seller Extensions
Condition Records
Competition Data
Imports
Data Change Requests
Lookup Tables / Company Parameters
User Admin
Authentication
Admin Tools
Logics
Logs
Custom Forms
Calculated Field Sets
Jobs & Tasks
Advanced Configuration Options
Data Manager
Actions
Action Types
Price Lists
Manual Price Lists
Live Price Grids
Calculation Grids
Visual Configuration
Quotes
Contracts (Agreements & Promotions)
Visual Configuration
Rebate Agreements
Rebate Calculations
Rebate Record Group
Sales Compensations
Claim Types
Claims
Optimization
Workflow
Workflow Delegation
Attachments
Product Image
Configuration
Internationalization
Metadata
MCP
Clicmanager
Comments
Heartbeat
Key-Value Store
Entities
otherSchemas
The Pricefx Backend API
Download OpenAPI description
Overview
URL
Pricefx
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}
Request
Sends a validation message (e.g., api.throwException, api.redAlert, etc.) from the validation of calculation logics in CLIC documents (Quotes, Agreements & Promotions (Contracts), Rebate Agreements, Compensation Plans) to the Notification Center (Notification API).
See the App Notifications article for more details.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/notification.send
- URL:https://companynode.pricefx.com/pricefx/companypartition/notification.send
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/notification.send \
-H 'Content-Type: application/json' \
-d '{
"data": {
"notification": {
"title": "My Title",
"message": "Description of banner",
"source": "notificationBanner",
"status": "INFO",
"topic": "SYSTEM_NOTIFICATION",
"actionType": "INFO_MESSAGE",
"validFrom": "2025-06-02T23:00:00.016Z",
"validUntil": "2025-06-03T21:59:59.016Z",
"dueDate": "2025-06-03T21:59:59.016Z",
"dismissible": true
}
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } }
Request
Retrieves all notifications. A filter can be applied.
See the App Notifications article for more details.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/notification.list
- URL:https://companynode.pricefx.com/pricefx/companypartition/notification.list
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/notification.list \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "topic",
"operator": "equals",
"value": "GROOVY"
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-f75d74cdc-pg5qh", "startRow": 0, "data": [ … ], "endRow": 300, "totalRows": 2, "status": 0 } }
Request
Sets the specifed notification as as read.
See the App Notifications article for more details.
Security
basic or X-PriceFx-jwt
- application/json
- application/xml
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/notification.setread
- URL:https://companynode.pricefx.com/pricefx/companypartition/notification.setread
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/notification.setread \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } }
CommentsCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code