Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Update CLIC Line Items
Upsert a Quote
List Quotes
Get a Quote
Submit a Quote
Export an Excel File
Export a DOCX File
Export a PDF File
Recalculate a Quote
List Products
Create a New Revision
Convert to a Deal
Copy a Quote
Mark an Offer as Lost
Revoke a Deal
Add Products to a Quote
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
List CLIC Objects
Mark an Offer as Lost (with reason)
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
Undo Quote Revocation
Update CLIC Line 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}
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 } }
Request
Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.updatelineitems/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.updatelineitems/{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.updatelineitems/2147489828.Q \
-H 'Content-Type: application/json' \
-d '{
"data": {
"lineItems": [
{
"version": 1,
"typedId": "2147506890.QLI",
"inputs": [
{
"name": "Quantity",
"value": 2
},
{
"name": "Quantity",
"value": 5
}
]
}
]
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-5db9bf487f-58sbn", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.create/{TypeCode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.create/{TypeCode}
- 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.create/Q \
-H 'Content-Type: application/json' \
-d '{
"data": {
"quote": {
"inputs": [
{
"name": "Customer",
"label": "Customer",
"type": "CUSTOMER",
"url": "/fetch/C/"
}
],
"outputs": [],
"lineItems": [],
"label": "New Quote",
"quoteType": null,
"nodeId": 0,
"userGroupEdit": null,
"userGroupViewDetails": null,
"expiryDate": "2024-01-18",
"targetDate": "2024-01-18",
"externalRef": null,
"viewState": {}
}
}
}'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