Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Ping (without authentication)
List Email Tasks
Change Terms of Use
Ping (without authenticat...
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/alive
- URL:https://companynode.pricefx.com/pricefx/companypartition/alive
- 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/aliveRequest
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 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/accountmanager.changetermsofuse
- URL:https://companynode.pricefx.com/pricefx/companypartition/accountmanager.changetermsofuse
- 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.changetermsofuse \
-H 'Content-Type: application/json' \
-d '{
"data": [
{
"lastTermsOfUseVersionAgreed": "12.0",
"lastTermsOfUseAgreedDate": "2023-12-28T15:00:00"
}
]
}'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