Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete Products from a Manual Price List
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
List Manual Price Lists
Mass Edit a Manual Price List Items
Update a Manual Price List Item
Upsert a Product in 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
Delete Products from a Ma...
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
Adds or updates a product in the specified Manual Price List.
To add a new product that does not exist, specify the sku parameter in the request.
To update an existing product, specify the sku or typedId parameter of the existing product. The /integrate method performs a partial update – it does not delete values from fields that have not been specified in the update request.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.integrate/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/manualpricelistmanager.integrate/{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.integrate/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"sku": "P00110101",
"label": "tofu",
"currency": "USD",
"comments": "The final version."
}
}'Response
application/json
- listProductsResponseExample_resultFields
- listProductsResponseExample_valueFields
- listProductsResponseExample
{ "response": { "node": "node", "startRow": 0, "data": [ … ], "endRow": 8, "totalRows": 8, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.delete/{id}/batch
- URL:https://companynode.pricefx.com/pricefx/companypartition/manualpricelistmanager.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/manualpricelistmanager.delete/{id}/batch' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"filterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "comments",
"operator": "iEquals",
"value": "del"
}
]
}
}
}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.delete/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/manualpricelistmanager.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/manualpricelistmanager.delete/{id}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "96.MPLI"
}
}'Response
application/json
- listProductsResponseExample_resultFields
- listProductsResponseExample_valueFields
- listProductsResponseExample
{ "response": { "node": "node", "startRow": 0, "data": [ … ], "endRow": 8, "totalRows": 8, "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