Pricefx REST API Reference
Pricefx REST API
/Sales Compensations
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
Manual Price Lists
Live Price Grids
Calculation Grids
Visual Configuration
Quotes
Contracts (Agreements & Promotions)
Visual Configuration
Rebate Agreements
Rebate Calculations
Rebate Record Group
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
Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.
This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.
Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchheader/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchheader/{typedId}
- 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/clicmanager.fetchheader/127.CTResponse
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/add/COHT
- URL:https://companynode.pricefx.com/pricefx/companypartition/add/COHT
- 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/COHT \
-H 'Content-Type: application/json' \
-d '{
"data": {
"uniqueName": "The Test Compensation Type",
"headerFormulaName": "SC_CompensationHeader",
"workflowFormulaName": "SC_SalesCompensationAgreement",
"configuration": null,
"scRecordWorkflowFormulaName": "SC_AgreementRecord"
},
"operation": "add"
}'Response
application/json
{ "response": { "node": "node", "data": [ … ], "status": 0 } }
Request
Retrieves Compensation Types from the Compensation Header Types table. A filter can be applied.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/COHT
- URL:https://companynode.pricefx.com/pricefx/companypartition/fetch/COHT
- 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/COHT \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "uniqueName",
"operator": "iEquals",
"value": "The Test Compensation Type"
}
]
}
}'Response
application/json
{ "response": { "node": "node1", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "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