Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Libraries
Get a Logic
Get a Default Pricing Logic Name
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)
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
List Libraries
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}
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.params/{uniqueName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.params/{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.params/{uniqueName}'Response
application/json
{ "response": { "node": "string", "data": {}, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.libraries
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.libraries
- 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.librariesResponse
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Executes a logic and returns results.
Use the output=rawjson parameter in the URL, for example /formulamanager.executeformula/QuoteLogic?output=rawjson in order to return the result in the simple JSON format as "resultName":result.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.executeformula/{uniqueName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/formulamanager.executeformula/{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.executeformula/{uniqueName}?output=xls&templateName=string&fileName=string' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"priority": "high",
"quantity": 14,
"map": {
"key": "value"
}
}
}'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