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
Retrieves email tasks that are pending or have already been sent. The response contains a list with all (or filtered out) email task objects (type code: ET).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/admin.fetchemailtasks
- URL:https://companynode.pricefx.com/pricefx/companypartition/admin.fetchemailtasks
- 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/admin.fetchemailtasks \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "sourceObject",
"operator": "iEquals",
"value": "2147494428.Q"
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-b6c678dff-58hnc", "startRow": 0, "data": [ … ], "endRow": 2, "totalRows": 2, "status": 0 } }
Security
basic or X-PriceFx-jwt
Path
Bodyapplication/jsonSpecify whether you want to retrieve a report based on user roles (R), user groups (UG), or business roles (BR).
Enum"R""UG""BR"
Example: R
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.audit/{TypeCode}/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.audit/{TypeCode}/{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/accountmanager.audit/R/2 \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "status": 0 } }
Request
Retrieves a stream of the Loki log.
Required roles:
- General Admin (without User Management) (
ADMIN_WO_USER_MGMT) - Investigate for Support (
SUPPORT)
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/streamlokilog
- URL:https://companynode.pricefx.com/pricefx/companypartition/streamlokilog
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/streamlokilog?start=string&direction=forward&limit=string'Response
application/json
{ "status": "string", "data": { "resultType": "string", "result": [ … ], "stats": { … } } }
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