Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Update a Calculation Grid
Add a Calculation Grid
List Calculation Grids
Get a Calculation Grid
Delete a Calculation Grid
Calculate a Calculation Grid
Add a Calculation Grid Item
List Calculation Grid Items
Get a Calculation Grid Item
Update a Calculation Grid Item
Submit a Calculation Grid Item
Deny a Calculation Grid Item
Delete a Calculation Grid Item
Update a Calculation Grid
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/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 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/update/CG
- URL:https://companynode.pricefx.com/pricefx/companypartition/update/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/update/CG \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2.CG",
"label": "New Label2"
},
"oldValues": {
"version": 1,
"typedId": "2.CG",
"targetDate": "2022-11-30",
"label": "CG",
"numberOfItems": 0,
"keepManualOverrides": false,
"writeOnlyChangedItems": false,
"configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"SampleFlexibleCalculationGridKeyLogic\",\"keyLogicElement\":\"Skus\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\",\"SwitchSKUContext\",\"EURMoneyResult\",\"Timestamp\",\"NumericResult\",\"Keys\",\"BatchInfo\",\"CPSearch\",\"StringResult\",\"RandomException\",\"Alerts\",\"LinkResult\",\"DefaultAttributedResult\",\"IntegerResult\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}",
"numberOfApprovedItems": 0,
"numberOfOpenItems": 0,
"numberOfDeniedItems": 0,
"numberOfSubmittedItems": 0,
"numberOfAutoApprovedItems": 0,
"keySize": 0,
"createdByName": "ondrej.tesar",
"keyGenerationType": "LOGIC_DRIVEN",
"updatedBy": 2147490187,
"updateDate": "2022-11-30",
"createDate": "2022-11-30T09:44:37",
"createdBy": 2147490187,
"lastUpdateDate": "2022-11-30T09:44:37",
"lastUpdateBy": 2147490187,
"status": "DRAFT",
"id": 2
},
"operationType": "update",
"textMatchStyle": "exact"
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5c8bbcc5b8-8fjcc", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/delete/CG
- URL:https://companynode.pricefx.com/pricefx/companypartition/delete/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/delete/CG \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "23.CG"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-68f6478894-sl8ts", "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