Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- 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 Item
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
List Price Lists
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}
Bodyapplication/json
The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.
Default 300
The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/PL
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/PL
- 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/fetch/PL \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "createDate",
"operator": "greaterThan",
"value": "2021-10-01T12:03:52"
}
]
}
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/PL/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/PL/{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/fetch/PL/{id}'Response
application/json
{ "response": { "node": "<node>", "csrfToken": "<token>", "data": [ … ], "status": 0 } }
Request
Retrieves a list of Price List Items. A filter can be applied.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICELIST_FETCH | Administer Price Lists (PB_PRICELISTS), Manage Price Lists (PB_PRICELISTSEDITOR), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), View Price Lists (PB_PRICELISTS_RO) |
Security
basic or X-PriceFx-jwt
The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.
Default 300
The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricelistmanager.fetch/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricelistmanager.fetch/{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.fetch/{id}' \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "unitOfMeasure",
"operator": "iEquals",
"value": "EA"
}
]
}
}'Response
application/json
{ "response": { "node": "<node>", "startRow": 0, "data": [ … ], "endRow": 4, "totalRows": 4, "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