Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Export an Excel File
Upsert a Quote
List Quotes
Get a Quote
Submit a Quote
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)
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
Undo Quote Revocation
Export an Excel File
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/quotemanager.submit
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.submit
- 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/quotemanager.submit \
-H 'Content-Type: application/json' \
-d '{
"data": {
"quote": {
"version": 0,
"typedId": "string",
"uniqueName": "string",
"label": "string",
"targetDate": "string",
"workflowStatus": "string",
"headerText": "string",
"inputs": [
{
"name": "string",
"label": "string",
"lookupTableId": null,
"url": "string",
"type": "string",
"value": "string",
"valueHint": "string",
"readOnly": null,
"filter": null,
"parameterGroup": null,
"required": null,
"labelTranslations": null,
"addUnknownValues": null,
"typedId": null,
"alwaysEditable": null,
"inputs": [
{}
],
"parameterConfig": {},
"formattingOptions": {},
"valueOptions": null
}
],
"viewState": {
"gridViewState": null,
"openFolders": null,
"selectedNodes": [
{}
]
},
"outputs": [
{}
],
"lastUpdateByName": "string",
"createdByName": "string",
"submittedByName": "string",
"calculationStatus": 0,
"dirty": true,
"refreshInputs": true,
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"serverMessages": null,
"additionalInfo1": null,
"additionalInfo2": null,
"additionalInfo3": null,
"additionalInfo4": null,
"numberOfAttachments": 0,
"creationWorkflowStatus": null,
"creationWorkflowCurrentStep": null,
"creationWorkflowStepCount": null,
"creationWorkflowStepLabel": null,
"signature": null,
"lineItems": [
{
"version": 0,
"typedId": "string",
"clicId": 0,
"inputs": [
{}
],
"outputs": [
{
"resultName": "string",
"resultLabel": "string",
"result": 0,
"excludeFromExport": true,
"warnings": null,
"alertMessage": null,
"alertType": null,
"displayOptions": 0,
"formatType": "string",
"suffix": null,
"resultType": "string",
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": true,
"labelTranslations": null,
"overridable": true,
"overridden": true,
"resultDescription": null
}
],
"dirty": true,
"lineId": "string",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "string",
"sku": "string",
"priceRecordId": null,
"folder": true,
"treeLabel": "string",
"createDate": "string",
"createdBy": 0,
"lastUpdateDate": "string",
"lastUpdateBy": 0
}
],
"expiryDate": "string",
"externalRef": null,
"customerId": "string",
"customerName": "string",
"customerGroup": null,
"quoteStatus": "string",
"renderInfo": null,
"serverMessagesExtended": null,
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": true,
"approvedByName": null,
"deniedByName": null,
"createDate": "string",
"createdBy": 0,
"lastUpdateDate": "string",
"lastUpdateBy": 0,
"supersededBy": null,
"prevRev": "string",
"rootUniqueName": "string",
"quoteType": null,
"status": "string"
}
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
Request
Downloads the XLSX file of the specified quote.
| Required Permission | Roles with the Required Permission |
|---|---|
| QUOTE_FETCHFILTERED | View Quoting (PRICESHOP_RO), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Edit Quoting (PRICESHOP_EDIT), Administer Quoting (PRICESHOP_QUOTEADMIN), Manage Quoting (PRICESHOP), Manage Workflow Logics (WF_BUILDER) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.fetchxls/{uniqueName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.fetchxls/{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/quotemanager.fetchxls/P-2147491340-REV-3?templateName=string&output=xls'Request
Downloads the DOCX file of the specified quote.
| Required Permission | Roles with the Required Permission |
|---|---|
| QUOTE_FETCHFILTERED | View Quoting (PRICESHOP_RO), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Edit Quoting (PRICESHOP_EDIT), Administer Quoting (PRICESHOP_QUOTEADMIN), Manage Quoting (PRICESHOP), Manage Workflow Logics (WF_BUILDER) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.fetchdocx/{uniqueName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.fetchdocx/{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/quotemanager.fetchdocx/P-2147491340-REV-3?templateName=string&output=xls'
CommentsCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code