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
Returns true if the Submit action of the specified Rebate Record Group should be performed asynchronmously.
If the number of Rebate Records within the given Rebate Record Group exceeds a defined threshold the group should be submitted in the asynchronous way. The threshold number can be set in the Advanced Configuration Option key asyncSubmitRRGThreshold. The default value is 10. Set to 0 to always submit a Rebate Record Group asynchronously.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebaterecordgroup.shouldsubmitasynchronously/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebaterecordgroup.shouldsubmitasynchronously/{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/rebaterecordgroup.shouldsubmitasynchronously/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend", "data": [ … ], "status": 0 } }
Request
Peforms the Mass Submit action of the Rebate Record Groups specified by the filter in the request body.
The Mass Submit action is always performed asynchronously - returns Job Status Tracker (JST).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebaterecordgroup.masssubmit
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebaterecordgroup.masssubmit
- 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/rebaterecordgroup.masssubmit \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"fieldName": "uniqueName",
"operator": "inSet",
"value": [
"RRG-1",
"RRG-2"
],
"_constructor": "AdvancedCriteria"
}
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-df49586c8-nkzxh", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/rebaterecordgroup.undorevoke/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/rebaterecordgroup.undorevoke/{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/rebaterecordgroup.undorevoke/{typedId}'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