Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Submit a Model
Calculate a Model Object Step
Recalculate a Calculation of a Step
Recalculate Items of a Parallel Calculation
Save a Model
Get a Calculation Status
Get a Step Calculation Status
Cancel a Calculation Step
List Model Logic Parameters
Execute a Model Logic
List Parallel Calculation Items
Get a Parallel Calculation Item
Revoke a Model
Duplicate a Model
Import Models
Export Models
Load Data Into FieldCollection
Update Job Status Tracker Entry
Submit a Model
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}
Bodyapplication/json
The data property can only contain the state field, all the rest fields will be ignored (and cannot be updated even with update/MO endpoint).
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelsave/{typedId}/{stepName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelsave/{typedId}/{stepName}
- 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/optimization.modelsave/123.MO/definition \
-H 'Content-Type: application/json' \
-d '{
"oldValues": {
"version": 11
},
"data": {
"state": {
"configuration": {
"advanced": {
"Advanced": {
"MaxSteps": 500,
"MaxDurationMinutes": 0,
"AutoStop": true,
"Profiling": false
}
},
"boundaries": {
"Boundaries": {
"SpecificAdjustmentMinPercent": -10,
"SpecificAdjustmentMaxPercent": 10,
"OnInvoiceDiscountMinPercent": 0,
"OnInvoiceDiscountMaxPercent": 30,
"OffInvoiceDiscountMinPercent": 0,
"OffInvoiceDiscountMaxPercent": 30,
"InvoicePriceMaxDecreasePercent": 16,
"InvoicePriceMaxIncreasePercent": 15
}
},
"objectives": {
"Objectives": {
"RevenueMarginMixCoeff": 1,
"CustomerGroupRevenueTarget": [],
"ProductGroupVolumeTarget": []
}
}
}
}
}
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelsubmit/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelsubmit/{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/optimization.modelsubmit/123.MO \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7d7d8875d-7jn6c", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/optimization.modelcalcstatus/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/optimization.modelcalcstatus/{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/optimization.modelcalcstatus/123.MResponse
application/json
{ "response": { "node": "e2e-staging-node", "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