Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Perform a Mass Action
Submit Products
List Live Price Grids
Get a Live Price Grid
List Live Price Grid Items
Copy a Price Grid
Mass Edit Price Grid Items
Update a Live Price Grid Item
Update a Live Price Grid Item (No Recalculation)
Delete a Price Grid Item
Deny a Live Price Grid Item
Delete a Price Grid Item (Filter)
Add Price Grid Items to a Price Grid
Calculate a Price Grid
Cancel a Calculation
Count Mass Action Items
Convert to Price List
Delete a Live Price Grid
Assign Customers
List Customer Assignments
List Live Price Grid Types
Delete a Live Price Grid Type
Add a Live Price Grid Type
Update a Live Price Grid Type
Download a Live Price Grid Excel File
Perform a Mass Action
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/pricegridmanager.cancel/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.cancel/{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/pricegridmanager.cancel/{id}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": null, "status": 0 } }
Request
Performs a mass workflow action on specified Price Grid Items based on filter settings.
Example:
Approves only products where activePrice = 250.
{
"data":{
"_constructor":"AdvancedCriteria",
"operator":"and",
"criteria":[
{
"fieldName":"activePrice",
"operator":"equals",
"value":250
}
],
"workflowAction":"APPROVED",
"comment":"Approved."
}
}| Required Permission | Roles with the Required Permission |
|---|---|
| PRICEGRID_UPDATE | Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS) |
Security
basic or X-PriceFx-jwt
Specify the criteria for which you want to filter the data.
Specify columns (fields) you want to apply the workflow action to.
Specify an operator of the filter criteria.
Enum"equals""iEquals""notEqual""iNotEqual""isNull""notNull""contains""iContains""containsPattern""iContainsPattern"
Specify the workflow action you want to perform.
Enum"SUBMITTED""WITHDRAWN""APPROVED""DENIED"
Example: "APPROVED"
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.massaction/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.massaction/{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/pricegridmanager.massaction/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "activePrice",
"operator": "equals",
"value": 11
}
],
"workflowAction": "SUBMITTED",
"comment": ""
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0 } }
Request
Returns a number of Price Grid Items that would be affected by the mass action operation.
totalRows value = number of affected items.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICEGRID_UPDATE | Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS) |
Security
basic or X-PriceFx-jwt
Specify an operator of the filter criteria.
Enum"equals""iEquals""notEqual""iNotEqual""isNull""notNull""contains""iContains""containsPattern""iContainsPattern"
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.massactioncount/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.massactioncount/{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/pricegridmanager.massactioncount/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "currency",
"operator": "iEquals",
"value": "USD"
}
],
"workflowAction": "SUBMITTED"
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "totalRows": 0, "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