Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List CLIC Objects
List Rebate Agreements
Upsert a Rebate Agreement
List Rebate Agreement Items
Get a Rebate Agreement
Add Rebate Agreement Items
Delete a Rebate Agreement
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
Update CLIC Line Items
Delete All Line Items
Import Line Items (w/o Input Types)
Undo Rebate Agreement Revocation
Undo Rebate Record Revocation
List CLIC Objects
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 details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.
This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.
Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchheader/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchheader/{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.fetchheader/127.CTResponse
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).
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
Query
Bodyapplication/jsonSet to true to exclude large results (e.g., charts, matrix table, etc.) from response. Use the /clicmanager.fetchoutput/{typedId}/{resultName} (e.g., /clicmanager.fetchoutput/2147490386.Q/FlexChart) to download the result separately.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetch/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetch/{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.fetch/{typedId}?noComplexResults=true&getMyItemsForReview=true' \
-H 'Content-Type: application/json' \
-d '{
"endRow": 0,
"oldValues": {},
"operationType": "string",
"startRow": 0,
"textMatchStyle": "string",
"data": {
"operator": "string",
"_constructor": "string",
"criteria": [
{
"fieldName": "string",
"operator": "string"
}
]
}
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "status": 0 } }
Request
Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.updatelineitems/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.updatelineitems/{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.updatelineitems/2147489828.Q \
-H 'Content-Type: application/json' \
-d '{
"data": {
"lineItems": [
{
"version": 1,
"typedId": "2147506890.QLI",
"inputs": [
{
"name": "Quantity",
"value": 2
},
{
"name": "Quantity",
"value": 5
}
]
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5db9bf487f-58sbn", "data": [ … ], "status": 0 } }
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