Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete a Claim Type
Add a Claim Type
Update a Claim Type
List Claim Types
Delete a Claim Type
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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/CLT
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/CLT
- 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/update/CLT \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "12.CLT",
"configuration": {
"columns": {
"sku": {
"name": null,
"fieldFormatType": null,
"canEdit": true
}
}
}
},
"oldValues": {
"version": 0,
"typedId": "12.CLT",
"uniqueName": "CLT01",
"label": "Claim Type 01",
"formulaName": "claimCalculation",
"allocationFormulaName": "claimAllocation",
"validationStateElementName": "validationState",
"sheetName": "DATA",
"createDate": "2022-10-07T09:13:41",
"createdBy": 2147490187,
"lastUpdateDate": "2022-10-07T09:13:41",
"lastUpdateBy": 2147490187
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/CLT
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/CLT
- 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/delete/CLT \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "13.CLT"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-57c6448bd-62zqf", "data": [ … ], "status": 0 } }
Bodyapplication/json
The example of the request body contains the filter. The call returns Claim Types whose name equals to "claimType".
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CLT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CLT
- 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/fetch/CLT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "uniqueName",
"operator": "iEquals",
"value": "claimType"
}
]
}
}'Response
application/json
{ "response": { "node": "node", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "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