Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Save a Rebate Calculation
Add a Rebate Calculation
List Rebate Calculations
Run a Rebate Calculation
Delete a Rebate Calculation
Save a Rebate Calculation
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/RRSC
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/RRSC
- 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/RRSC \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "rebateRecordSetId",
"operator": "equals",
"value": 1
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7d65f9b656-qdj9n", "startRow": 0, "data": [ … ], "endRow": 2, "totalRows": 2, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebaterecord.savecalc
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebaterecord.savecalc
- 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/rebaterecord.savecalc \
-H 'Content-Type: application/json' \
-d '{
"data": {
"version": 0,
"typedId": "5.RRSC",
"label": "Test Calculation",
"rebateRecordSetId": 1,
"rebateRecordSetLabel": "Default",
"createDate": "2023-03-08T12:18:11",
"createdBy": 2147490187,
"lastUpdateDate": "2023-03-08T12:18:11",
"lastUpdateBy": 2147490187,
"status": "DRAFT",
"isDefault": false,
"incremental": true,
"shouldSubmit": false,
"valid": true
},
"operationType": "update",
"textMatchStyle": "exact",
"oldValues": null
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7d65f9b656-qdj9n", "data": [ … ], "status": 0 } }
Request
Starts the calculation job (JST) of the calculation set. Returns the JobStatusTracker object.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebaterecord.calculateset
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebaterecord.calculateset
- 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/rebaterecord.calculateset \
-H 'Content-Type: application/json' \
-d '{
"data": {
"version": 0,
"typedId": "5.RRSC",
"targetDate": null,
"label": "Test Calculation",
"locale": null,
"calculationMessages": null,
"rebateRecordSetId": 1,
"rebateRecordSetLabel": "Default",
"rebateRecordSet": {
"version": 0,
"typedId": "1.RRS",
"targetDate": null,
"label": "Default",
"locale": null,
"calculationMessages": null,
"numberOfItems": 0,
"keepManualOverrides": false,
"writeOnlyChangedItems": false,
"userGroupEdit": null,
"userGroupViewDetails": null,
"updatedBy": 2147483649,
"updateDate": "2019-05-14",
"recordSetId": 1,
"createDate": "2019-05-14T08:18:54",
"createdBy": 2147483649,
"lastUpdateDate": "2019-05-14T08:18:54",
"lastUpdateBy": 2147483649,
"status": "DRAFT",
"calculationStartDate": null,
"calculationDate": null,
"id": 1
},
"dtoFilter": null,
"sortBy": null,
"adhocCalculation": null,
"calculationConfig": null,
"calculationType": null,
"createDate": "2023-03-08T12:18:11",
"createdBy": 2147490187,
"lastUpdateDate": "2023-03-08T12:40:28",
"lastUpdateBy": 2147490187,
"status": "DRAFT",
"calculationStartDate": null,
"calculationDate": null,
"isDefault": false,
"incremental": true,
"incCalculationDate": null,
"shouldSubmit": false,
"valid": true
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7d65f9b656-6t5xd", "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