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
Writes the changes made by the user in the Import Manager to the database. The changes are subject to validation against the data in the database. All the changes must pass the validation for the submit to be successful.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/importmanager.submit/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/importmanager.submit/{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/importmanager.submit/123.I \
-H 'Content-Type: application/json' \
-d '{
"data": {
"importOptions": {
"includeNewRows": true,
"includeUpdatedRows": true,
"includeDeletedRows": true
}
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-7b79967489-zfwj4", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/importmanager.massedit/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/importmanager.massedit/{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/importmanager.massedit/{typedId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "id",
"operator": "inSet",
"value": [
2147484135,
2147484190,
2147484205,
2147484225,
2147484226
],
"_constructor": "AdvancedCriteria"
}
]
},
"massEditRecords": [
{
"fieldName": "attribute18",
"massEditOperator": "=",
"fieldValue": "A",
"precision": 1
}
]
}
}'- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/importmanager.massdelete/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/importmanager.massdelete/{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/importmanager.massdelete/{typedId}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {}
}
}'Response
application/json
{ "response": { "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