Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Unique CLIC Items
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
Submit a Quote/Contract/Rebate Agreement
List CLIC Objects
Update a Quote/Contract/Rebate Agreement/Compensation Plan
Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan
Mark an Offer as Lost (with reason)
Send an Email
Update CLIC Line Items
Create a Quote
Save a Temporary Data
Get a Temporary Data
Delete All Line Items
Import Line Items (w/o Input Types)
Get Folder Statistics
Fetch Activities
List Unique CLIC Items
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}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.calculate/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.calculate/{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.calculate/{typedId}?validationType=string'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend", "data": [ … ], "status": 0 } }
Request
Returns all SKUs for the given Calculable Line Item Collection (CLIC).
This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchitemuniquetypes/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchitemuniquetypes/{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.fetchitemuniquetypes/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-96569b957-fmkxp", "data": [ … ], "status": 0 } }
Request
Sets the specified Quote as LOST and sets the loss reason (lostReason). Optionally, an additional comment (lostReasonComment) can be added.
Returns the updated Quote object.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.setlostreason/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.setlostreason/{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.setlostreason/2147493285.Q \
-H 'Content-Type: application/json' \
-d '{
"data": {
"lostReason": "string",
"lostReasonComment": "string"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-689d96f98d-hnkt9", "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