Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Get a Default Pricing Logic Name
Get a Logic
Set a Default Pricing Logic
Update a Logic
Update a Logic (Partial)
Update a Logic (No syntax check)
List Elements
Execute an Assigned Logic
Execute a Logic
Delete a Logic
List Logics
Generate Parameters
Syntax Check
List Logic Parameters (Input Fields)
List Libraries
Execute a Logic (Without a Context)
Execute a Logic Without a Context in a Service
Execute a Logic (Read-Only)
Execute a Logic Without a Context in a Service (Read-Only)
Copy a Logic
List Functions
Test a Logic
Execute Library Function
Get a Default Pricing Log...
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
Returns full details of the logic, including all sub-elements.
Information: The
idis thetypedIdwithout the F suffix. For example, theidattribute of the logic withtypedId= 2147484823.F is 2147484823.
| Required Permission | Roles with the Required Permission |
|---|---|
| PRICINGFORMULA_FETCH | Administer Policy Records (PO_MODELRECORDS_ADMIN), Manage PA Calculation Logics (PA_FORMULAS), Manage Contracts Calculation Logics (CM_FORMULAS), Manage Rebate Agreement Templates (RM_RAT), Administer PriceOptimizer (PO_MANAGER), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Manage PromotionManager (CM_CONTRACTMANAGER), Administer RebateManager (RM_REBATEMANAGER), Administer QuoteConfigurator (PRICESHOP_QUOTEADMIN), Manage Calculation Logics (PB_FORMULAS), Manage Claims (CLM_CLAIMMANAGER), Manage Rebate Calculation Logics (RM_FORMULAS) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.fetch/{id}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.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/formulamanager.fetch/{id}'Response
application/json
{ "response": { "node": "<node>", "csrfToken": "<token>", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.getdefault
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.getdefault
- 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/formulamanager.getdefaultResponse
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.setdefault/{uniqueName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.setdefault/{uniqueName}
- 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/formulamanager.setdefault/{uniqueName}'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