Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Deny a Live Price Grid Item
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
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
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
Deny a Live Price Grid It...
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
Deletes a Live Price Grid Item object from the specified Live Price Grid.
| 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
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.delete/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricegridmanager.delete/{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.delete/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "649.PGI"
}
}'Response
application/json
{ "response": { "node": "<node>", "data": [ … ], "status": 0 } }
Request
Sets the approvalState field to Denied.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICEGRID_SUBMIT | Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS) |
Security
basic or X-PriceFx-jwt
- 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"
}
]
}
}
}'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