Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Unique CLIC Items
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
Submit a Quote/Contract/Rebate Agreement
List CLIC Objects
Update a Quote/Contract/Rebate Agreement/Compensation Plan
Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan
Mark an Offer as Lost (with reason)
Send an Email
Update CLIC Line Items
Create a Quote
Save a Temporary Data
Get a Temporary Data
Delete All Line Items
Import Line Items (w/o Input Types)
Get Folder Statistics
Fetch Activities
Add Line Items
Cancel Running Calculation
List Unique CLIC Items
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
Calculates a Quote, Contract, Rebate Agreement, or Compensation Plan.
Triggers a synchronous recalculation of the given CLIC document.
If a header formula calls switchToAsync() during the pre-phase, the synchronous calculation is aborted, all changes are rolled back, and an asynchronous job is created instead. In that case the response contains a JobStatusTracker object instead of the calculated CLIC header.
Use the typedId field in response.data[0] to distinguish the response type:
- CLIC header —
typedIdends with.Q,.C,.RA, or.CO(e.g.42.Q) - JobStatusTracker (async) —
typedIdends with.JST(e.g.107.JST)
This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.calculate/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.calculate/{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/clicmanager.calculate/{typedId}?validationType=string'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchitemuniquetypes/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchitemuniquetypes/{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/clicmanager.fetchitemuniquetypes/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-96569b957-fmkxp", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.setlostreason/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.setlostreason/{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/clicmanager.setlostreason/2147493285.Q \
-H 'Content-Type: application/json' \
-d '{
"data": {
"lostReason": "string",
"lostReasonComment": "string"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-689d96f98d-hnkt9", "data": [ … ], "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