Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Submit a Price List
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
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
Submit a Price List
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
Creates a new Price List.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICELIST_ADD | Administer Price Lists (PB_PRICELISTS), Manage Price Lists (PB_PRICELISTSEDITOR) |
Security
basic or X-PriceFx-jwt
Specifies parameter names and values used for formula computation.
A flag to indicate if manual overrides should be preserved in the revision.
Specifies whether the original product filter criteria (if still available/applicable) should be used.
A flag to indicate if only items with price changes should be written to the revision.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricelistmanager.add
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricelistmanager.add
- 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.add \
-H 'Content-Type: application/json' \
-d '{
"data": {
"priceListName": "Price List 2021",
"targetDate": "2021-11-10",
"errorMode": "ABORT",
"keepManualOverrides": null,
"useFilter": null,
"writeOnlyChangedItems": null,
"configuration": {
"shotgunModeEnabled": false,
"notifyWhenFinished": "NONE",
"productFilterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "sku",
"operator": "inSet",
"value": [
"11111",
"22222",
"33333"
]
}
]
},
"sortKeys": null,
"resultElementName": "ListPrice",
"matrixFormulaName": null,
"matrixElementName": null,
"uomOverrideElementName": null,
"elementNames": [
"BasePrice"
],
"hiddenElementNames": []
},
"override": null,
"nodeId": null
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Starts an approval process for the Price List.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICELIST_UPDATE | 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.submit/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/pricelistmanager.submit/{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.submit/{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
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 } }
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