Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete a Price List Item
List Price Lists
Get a Price List
List Price List Items
Create a Revision
Calculate a Pricelist
Update a Pricelist Detail
Create a Price List
Submit a Price List
Revoke a Price List
Delete a Price List
Assign Customers
List Customer Assignments
List Price List Types
Delete a Price List Type
Add a Price List Type
Update a Price List Type
Delete a Price List 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}
Request
Revokes an approved Price List.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICELIST_REVOKE | Administer Price Lists (PB_PRICELISTS) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricelistmanager.revoke/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricelistmanager.revoke/{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/pricelistmanager.revoke/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"actionComment": "a comment"
}
}'Response
application/json
{ "response": { "node": "<node>", "startRow": 0, "data": [ … ], "endRow": 4, "totalRows": 4, "status": 0 } }
Request
Deletes a Price List Item based on filter settings.
Filter example:
Deletes only Price List Items where comments = "denied".
{
"data": {
"filterCriteria": {
"operator": "and",
"criteria": [
{
"fieldName": "comments",
"operator": "iEquals",
"value": "denied"
}
]
}
}
}| Required Permission | Roles with the Required Permission |
|---|---|
| PRICELIST_REMOVE | Administer Price Lists (PB_PRICELISTS), Manage Price Lists (PB_PRICELISTSEDITOR) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricelistmanager.delete/PL/{id}/batch
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricelistmanager.delete/PL/{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/pricelistmanager.delete/PL/{id}/batch' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"operator": "and",
"criteria": [
{
"fieldName": "comments",
"operator": "iEquals",
"value": "denied"
}
]
}
}
}'Response
application/json
{ "response": { "node": "node", "csrfToken": "token", "data": [ … ], "status": 0 } }
Request
Deletes a Price List specified by typedId.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICELIST_REMOVE | Administer Price Lists (PB_PRICELISTS), Manage Price Lists (PB_PRICELISTSEDITOR) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricelistmanager.delete
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricelistmanager.delete
- 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/pricelistmanager.delete \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147490403.PL"
}
}'Response
application/json
{ "response": { "node": "string", "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