Pricefx REST API Reference
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}
Request
Calculates a Claim (runs the validation logic on all items. Creates a calculation job (JST). It does not read the data from the uploaded Excel file again but works with the (potentially edited) data that are already loaded in the system.
You can also send items within the request body (no Excel file needed) – see the request example (calculateClaimRequestExample) for the request body structure.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/claimmanager.calculate/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/claimmanager.calculate/{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/claimmanager.calculate/24.CL \
-H 'Content-Type: application/json' \
-d '{
"data": {
"columnNames": [
"ProductID",
"EndCustomerID",
"ClaimQuantity",
"TotalClaimAmount",
"QuoteID",
"QuoteValidFrom",
"QuoteValidTo",
"QuoteDiscountPerItemPercent",
"InvoicePricePerItem",
"NetPricePerItem",
"DiscountPerItemAmount"
],
"data": [
{
"ProductID": "CLPRD-3",
"EndCustomerID": "EndCustomer1",
"ClaimQuantity": "2",
"TotalClaimAmount": "23",
"QuoteID": "P-2147483919",
"QuoteValidFrom": "2022-10-13",
"QuoteValidTo": "2023-04-25",
"QuoteDiscountPerItemPercent": "5",
"InvoicePricePerItem": "100",
"NetPricePerItem": "95",
"DiscountPerItemAmount": "5"
}
]
}
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/claimmanager.cancel/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/claimmanager.cancel/{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/claimmanager.cancel/24.CL \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "string", "data": {}, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/claimmanager.fetchitems/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/claimmanager.fetchitems/{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/claimmanager.fetchitems/24.CL \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7d4f6fc499-cxpsb", "startRow": 0, "data": [ … ], "endRow": 16, "totalRows": 16, "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