Pricefx REST API Reference
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
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 } }
Request
Deletes a specified notification.
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.delete
- URL:https://companynode.pricefx.com/pricefx/companypartition/notification.delete
- 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.delete \
-H 'Content-Type: application/json' \
-d '{
"data": {
"id": [
"954",
"955"
]
}
}'Response
application/json
{ "response": { "node": "string", "data": {}, "totalRows": 0, "status": 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