Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Manual Price Lists
Create a Manual Price List
Add Products to a Manual Pricelist
Add Products to a Manual Price List (No Recalculation)
List Products From a Manual Price List
Mass Edit a Manual Price List Items
Update a Manual Price List Item
Upsert a Product in a Manual Price List
Delete Products from a Manual Price List
Delete a Product from a Manual Price List
Delete a Manual Price List
Copy a Manual Price List
Calculate a Manual Price List
Assign Customers
List Customer Assignments
List Manual 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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.fetch/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/manualpricelistmanager.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/manualpricelistmanager.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": "currency",
"operator": "iEquals",
"value": "USD"
}
]
}
}'Response
application/json
{ "response": { "status": 0, "startRow": 0, "node": "string", "csrfToken": "string", "data": [ … ], "endRow": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/MPL
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/MPL
- 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/MPL \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "status",
"operator": "equals",
"value": "ACTIVE"
}
]
}
}'Response
application/json
{ "response": { "node": "node", "csrfToken": "token", "data": [ … ], "status": 0 } }
Security
basic or X-PriceFx-jwt
Specify ids of the items you want to update.
Can be either one of these valid operators: + - * If omitted, the provided value is set (= operator). Otherwise the specified operation is applied.
The new value of the field. If omitted, the field is set to null.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.massedit/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/manualpricelistmanager.massedit/{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/manualpricelistmanager.massedit/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "id",
"operator": "inSet",
"value": [
"94",
"95"
],
"_constructor": "AdvancedCriteria"
}
]
},
"massEditRecords": [
{
"fieldName": "currency",
"massEditOperator": "=",
"fieldValue": "USD",
"precision": null
}
]
}
}'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