Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Import Line Items (w/o Input Types)
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
List Unique CLIC Items
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
Get Folder Statistics
Fetch Activities
Add Line Items
Import Line Items (w/o In...
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
Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.
This action can be performed only on doucments in the DRAFT status.
If 'Recalculate after line item modification' option is set then the document is recalculated.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.removeallitems/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.removeallitems/{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.removeallitems/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-657c8dd448-5w72q", "data": [ … ], "status": 0 } }
Request
Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.
The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.importlineitems/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.importlineitems/{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.importlineitems/{typedId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"parent": "ROOT",
"skus": [
{
"inputs": [
{
"name": "Integer Input",
"value": "123"
}
],
"label": "TEST",
"sku": "B-0006",
"folder": false
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-79df676dd9-lr6pk", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.folderstats/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.folderstats/{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.folderstats/2147494.Q?withLineIds=true'Response
application/json
{ "response": { "node": "pricefx-cluster", "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