Pricefx REST API Reference
Pricefx REST API
/Manual Price Lists
Master
General
Products
Product Extensions
Product Image
Customers
Customer Extensions
Sellers
Seller Extensions
Condition Records
Competition Data
Imports
Data Change Requests
Lookup Tables / Company Parameters
User Admin
Authentication
Admin Tools
Logics
Logs
Custom Forms
Calculated Field Sets
Jobs & Tasks
Data Manager
Actions
Action Types
Price Lists
Live Price Grids
Calculation Grids
Visual Configuration
Quotes
Contracts (Agreements & Promotions)
Visual Configuration
Rebate Agreements
Rebate Calculations
Rebate Record Group
Sales Compensations
Claim Types
Claims
Optimization
Workflow
Workflow Delegation
Attachments
Product Image
Configuration
Internationalization
Metadata
Clicmanager
Comments
Notifications
Heartbeat
Key-Value Store
Entities
otherSchemas
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 Manual Price List object. The Manual Price List is created without products. Use the /manualpricelistmanager.add/{id} (Add Products to a Manual Price List) endpoint to add products.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/MPL
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/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/add/MPL \
-H 'Content-Type: application/json' \
-d '{
"operationType": "add",
"textMatchStyle": "exact",
"data": {
"uniqueName": "MPL01",
"label": "The Manual Price List 1",
"validAfter": "2021-12-11T14:11:09.060Z",
"status": "ACTIVE",
"nodeId": null
},
"oldValues": null
}'Response
application/json
{ "response": { "node": "node", "csrfToken": "token", "data": [ … ], "status": 0 } }
Request
Adds products to the previously created Manual Price List and recalculates the Manual Price List.
To add items without a recalculation, use the **/manualpricelistmanager.add/{id} ** endpoint.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.add/{id}/recalculate
- URL:https://companynode.pricefx.com/pricefx/companypartition/manualpricelistmanager.add/{id}/recalculate
- 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.add/22/recalculate \
-H 'Content-Type: application/json' \
-d '{
"data": {
"skus": [
"P00001",
"P00002",
"P00003"
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } }
Request
Adds products to the previously created Manual Price List. Use to skip recalculation of comments and manualResultPrice (Manual Override).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/manualpricelistmanager.add/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/manualpricelistmanager.add/{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.add/22 \
-H 'Content-Type: application/json' \
-d '{
"data": {
"skus": [
"P00001",
"P00002",
"P00003"
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "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