Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete a Price Grid Item (Filter)
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
Add Price Grid Items to a Price Grid
Calculate a Price Grid
Cancel a Calculation
Perform a Mass Action
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
Delete a Price Grid Item...
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.reject/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.reject/{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.reject/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"ids": [
"650.PGI"
]
}
}'Response
application/json
{ "response": { "node": "<node>", "data": [ … ], "status": 0 } }
Request
Deletes a Live Price Grid Item based on filter settings.
Filter example:
Deletes only Price Grid Items where comments = "del".
{
"data": {
"filterCriteria": {
"operator": "and",
"criteria": [
{
"fieldName": "comments",
"operator": "iEquals",
"value": "del"
}
]
}
}
}| Required Permission | Roles with the Required Permission |
|---|---|
| PRICEGRID_REMOVE | Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), 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.delete/{id}/batch
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.delete/{id}/batch
- 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.delete/{id}/batch' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"operator": "and",
"criteria": [
{
"fieldName": "comments",
"operator": "iEquals",
"value": "del"
}
]
}
}
}'Request
Adds products to the Live Price Grid.
Information: Only products that are not already in the Price Grid will be added. You can specify products by
skus(see the example 1 below) or by filter settings (see example 2).
Example 1:
Adds only products with specified SKUs.
{
"data":{
"skus":[
"p0001",
"p0002"
]
}
}Example 2:
Adds only products where formulaName = "CompetitionPricing".
{
"data":{
"filterCriteria":{
"operator":"and",
"criteria":[
{
"fieldName":"formulaName",
"operator":"iEquals",
"value":"CompetitionPricing"
}
]
}
}
}To add items without a recalculation, use the /pricegridmanager.add/{id}/norecalc endpoint.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICEGRID_ADD | Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), 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.add/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.add/{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.add/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"operator": "and",
"criteria": [
{
"fieldName": "formulaName",
"operator": "iEquals",
"value": "CompetitionPricing"
}
]
}
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "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