Pricefx REST API Reference
Pricefx REST API
/Calculation Grids
Master
General
Products
Product Extensions
Product Image
Customers
Customer Extensions
Sellers
Seller Extensions
Condition Records
Competition Data
Imports
Data Change Requests
Lookup Tables / Company Parameters
User Admin
Authentication
Admin Tools
Logics
Logs
Custom Forms
Calculated Field Sets
Jobs & Tasks
Data Manager
Actions
Action Types
Price Lists
Manual Price Lists
Live Price Grids
Visual Configuration
Quotes
Contracts (Agreements & Promotions)
Visual Configuration
Rebate Agreements
Rebate Calculations
Rebate Record Group
Sales Compensations
Claim Types
Claims
Optimization
Workflow
Workflow Delegation
Attachments
Product Image
Configuration
Internationalization
Metadata
Clicmanager
Comments
Notifications
Heartbeat
Key-Value Store
Entities
otherSchemas
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/calculationgridmanager.addgrid
- URL:https://companynode.pricefx.com/pricefx/companypartition/calculationgridmanager.addgrid
- 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/calculationgridmanager.addgrid \
-H 'Content-Type: application/json' \
-d '{
"data": {
"label": "CGtest",
"targetDate": "2022-11-23",
"keyGenerationType": "LOGIC_DRIVEN",
"configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"KeyLogic_CalculationGrid\",\"keyLogicElement\":\"KeyList_1Keys\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CG
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CG
- 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/CG \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "status",
"operator": "equals",
"value": "SCHEDULED"
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "startRow": 0, "data": [ … ], "endRow": 2, "totalRows": 2, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/CG/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/CG/{id}
- 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/CG/9 \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "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