Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Count Mass Action Items
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
Perform a Mass Action
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
Count Mass Action Items
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
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 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.convert2pl/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.convert2pl/{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.convert2pl/{id}'Response
application/json
{ "response": { "node": "<node>", "csrfToken": "<token>", "data": [ … ], "status": 0 } }
CommentsCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code