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 a list of all authenticated user's approvals.
Available for the following roles:
ADMIN_WO_USER_MGMT(General Admin (without User Management))SUPPORT(Investigate for Support)PRICESHOP_RO(View Quoting)PRICESHOP_EDIT(Edit Quoting)PB_PRICEGRIDS_RO(View LPG)WF_BUILDER(Manage Workflow Logics)RM_RAT(Manage Rebate Templates)RM_REBATEAGREEMENTS_RO(View Rebate Agreements)RM_REBATEAGREEMENTS(Manage Rebate Agreements)WF_BUILDER(Manage Workflow Logics)CONTRACTS_RO(View A&P)CM_CONTRACTMANAGER(Manage A&P module)CONTRACTS_RO(View A&P)WF_ADMIN(Manage Workflows)SC_COMPENSATIONS_RO(View Compensation Plans)SC_ADMIN(Administer Sales Compensations module)
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.fetch/active
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.fetch/active
- 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/workflowsmanager.fetch/activeResponse
application/json
{ "response": { "status": 0, "startRow": 0, "node": "<node>", "data": [ … ], "endRow": 1 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.fetchfilteredbyapprovable/active/{loginName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.fetchfilteredbyapprovable/active/{loginName}
- 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/workflowsmanager.fetchfilteredbyapprovable/active/john.priceResponse
application/json
{ "response": { "status": 0, "startRow": 0, "node": "<node>", "data": [ … ], "endRow": 1 } }
Request
Retrieves a list of workflows (based on filter settings) where the authenticated user participates. The request can be sent also with an empty body (without filters or paging) in order to retrieve all workflows. Returns all workflows if the authenticated user is the workflow admin.
Filter example:
Returns only workflows where document type = Quote and workflow status = Approved.
{
"data":{
"_constructor":"AdvancedCriteria",
"operator":"and",
"criteria":[
{
"fieldName":"code",
"operator":"equals",
"value":"Q"
},
{
"fieldName":"workflowStatus",
"operator":"equals",
"value":"APPROVED"
}
]
}
}Available for the following roles:
ADMIN_WO_USER_MGMT(General Admin (without User Management))SUPPORT(Investigate for Support)PRICESHOP_RO(View Quoting)PRICESHOP_EDIT(Edit Quoting)PB_PRICEGRIDS_RO(View LPG)WF_BUILDER(Manage Workflow Logics)RM_RAT(Manage Rebate Templates)RM_REBATEAGREEMENTS_RO(View Rebate Agreements)RM_REBATEAGREEMENTS(Manage Rebate Agreements)WF_BUILDER(Manage Workflow Logics)CONTRACTS_RO(View A&P)CM_CONTRACTMANAGER(Manage A&P module)CONTRACTS_RO(View A&P)WF_ADMIN(Manage Workflows)SC_COMPENSATIONS_RO(View Compensation Plans)SC_ADMIN(Administer Sales Compensations module)
Security
basic or X-PriceFx-jwt
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
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.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.fetch
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.fetch
- 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/workflowsmanager.fetch \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "workflowStatus",
"operator": "equals",
"value": "SUBMITTED"
}
]
}
}'Response
application/json
{ "response": { "status": 0, "startRow": 0, "node": "<node>", "csrfToken": "<token>", "data": [ … ], "endRow": 1 } }
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