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 workflow details of the approvable object.
See the Workflows article to find out which documents types can have approval workflows.
Available for the following roles:
ADMIN_WO_USER_MGMT(General Admin (without User Management))SUPPORT(Investigate for Support)PRICESHOP_RO(View Quoting)PB_PRICELISTS_RO(View Price Lists)PB_PRICEGRIDS_RO(View LPG)RM_REBATEAGREEMENTS_RO(View Rebate Agreements)RM_REBATEAGREEMENTS(Manage Rebate Agreements)RM_REBATERECORDS(Manage Rebate Records)RM_REBATERECORDS_RO(View Rebate Records)CONTRACTS_RO(View A&P)CM_CONTRACTS(Manage A&P)CLM_CLAIM(Use Claims)WF_ADMIN(Manage Workflows)PO_MODELRECORDS_RO(View Policy Records)PO_MODELRECORDS_APPROVAL(Approve Policy Records)MODULECATEGORY_MO_RO(View Model in Module Category)SC_COMPENSATIONS_RO(View Compensation Plans)
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.fetchdetailsviaapprovable/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.fetchdetailsviaapprovable/{typedId}
- 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.fetchdetailsviaapprovable/2147491330.QResponse
application/json
{ "response": { "node": "e2e-staging-node", "data": [ … ], "status": 0 } }
Request
Approves a document specified by the currentStepId. Allows you to add a comment in the request body.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.approve/{currentStepId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.approve/{currentStepId}
- 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.approve/2d721e9d-ac6d-4eda-bd6c-60424f4fdaef \
-H 'Content-Type: application/json' \
-d '{
"data": {
"actionComment": "This version is ok."
}
}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "status": 0 } }
Request
Denies a document specified by the currentStepId. Allows you to add a comment in the request body.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/workflowsmanager.deny/{currentStepId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/workflowsmanager.deny/{currentStepId}
- 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.deny/2d721e9d-ac6d-4eda-bd6c-60424f4fdaef \
-H 'Content-Type: application/json' \
-d '{
"data": {
"actionComment": "Not approved - the margin is too low."
}
}'See the Key-Value Database Storage Knowledge Base article for more details.
Operations
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.
Comments