Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Fetch Activities
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
Import Line Items (w/o Input Types)
Get Folder Statistics
Fetch Activities
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
Returns a list of parent IDs with the count of nested items. An example can be a list of Quote folders (their IDs) with the count of line items inside them.
Security
basic or X-PriceFx-jwt
- 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 } }
Request
Fetches activities for a CLIC module activity log in a concise format, e.g., when multiple 'add item' actions are performed consecutively, they are consolidated into a single activity log entry containing all details.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/activitylog.fetch
- URL:https://companynode.pricefx.com/pricefx/companypartition/activitylog.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/activitylog.fetch \
-H 'Content-Type: application/json' \
-d '{
"endRow": 0,
"oldValues": "string",
"operationType": "string",
"startRow": 0,
"textMatchStyle": "string",
"data": {
"_constructor": "string",
"operator": "string",
"criteria": [
{
"_constructor": "string",
"operator": "string",
"criteria": [
{
"fieldName": "string",
"operator": "string",
"value": "string",
"_constructor": "string"
}
]
}
]
},
"sortBy": [
"string"
]
}'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