Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- List Quotes
Upsert a Quote
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)
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
List Quotes
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
Creates or updates a quote. To update a quote, specify an existing uniqueName.
This endpoint is not allowed to modify the document status and workflow status.
| Required Permission | Roles with the Required Permission |
|---|---|
| QUOTE_UPDATE | Edit Quoting (PRICESHOP_EDIT), Administer Quoting (PRICESHOP_QUOTEADMIN), Manage Quoting (PRICESHOP) |
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.save
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.save
- 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.save \
-H 'Content-Type: application/json' \
-d '{
"data": {
"quote": {
"version": 5,
"typedId": "2147491342.Q",
"uniqueName": "P-2147491340-REV-2",
"label": "Quote01",
"targetDate": "2021-11-01",
"workflowStatus": "DRAFT",
"headerText": "<p>Quote message.</p>",
"inputs": [
{
"name": "Customer",
"label": "Customer",
"lookupTableId": null,
"url": "/fetch/C/",
"type": "CUSTOMER",
"value": "00003",
"valueHint": "Kate Smith",
"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": [
"0pnOfOZ0RNyO8LA",
"n0MnhY2gThX7adD",
"IZpgAGs8pCAxG2p"
]
},
"outputs": [],
"lastUpdateByName": "root",
"createdByName": "admin",
"submittedByName": "admin",
"calculationStatus": 0,
"dirty": false,
"refreshInputs": false,
"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": 3,
"typedId": "2147515659.QLI",
"clicId": 2147491342,
"inputs": [],
"outputs": [
{
"resultName": "price",
"resultLabel": "Price",
"result": 666,
"excludeFromExport": false,
"warnings": null,
"alertMessage": null,
"alertType": null,
"displayOptions": 2,
"formatType": "INTEGER",
"suffix": null,
"resultType": "SIMPLE",
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": true,
"labelTranslations": null,
"overridable": false,
"overridden": false,
"resultDescription": null
}
],
"dirty": false,
"lineId": "0pnOfOZ0RNyO8LA",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "Label One",
"sku": "11111",
"priceRecordId": null,
"folder": false,
"treeLabel": "Label One",
"createDate": "2021-11-02T09:12:58",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T09:12:58",
"lastUpdateBy": 1
},
{
"version": 3,
"typedId": "2147515660.QLI",
"clicId": 2147491342,
"inputs": [],
"outputs": [
{
"resultName": "price",
"resultLabel": "Price",
"result": 666,
"excludeFromExport": false,
"warnings": null,
"alertMessage": null,
"alertType": null,
"displayOptions": 2,
"formatType": "INTEGER",
"suffix": null,
"resultType": "SIMPLE",
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": true,
"labelTranslations": null,
"overridable": false,
"overridden": false,
"resultDescription": null
}
],
"dirty": false,
"lineId": "n0MnhY2gThX7adD",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "Label Two",
"sku": "22222",
"priceRecordId": null,
"folder": false,
"treeLabel": "Label Two",
"createDate": "2021-11-02T09:12:58",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T09:12:58",
"lastUpdateBy": 1
},
{
"version": 3,
"typedId": "2147515661.QLI",
"clicId": 2147491342,
"inputs": [],
"outputs": [
{
"resultName": "price",
"resultLabel": "Price",
"result": 666,
"excludeFromExport": false,
"warnings": null,
"alertMessage": null,
"alertType": null,
"displayOptions": 2,
"formatType": "INTEGER",
"suffix": null,
"resultType": "SIMPLE",
"cssProperties": null,
"userGroup": null,
"resultGroup": null,
"overrideValueOptions": null,
"overrideAllowEmpty": true,
"labelTranslations": null,
"overridable": false,
"overridden": false,
"resultDescription": null
}
],
"dirty": false,
"lineId": "IZpgAGs8pCAxG2p",
"parentId": null,
"calculationStatus": 0,
"editabilityStatus": 0,
"label": "Label Three",
"sku": "33333",
"priceRecordId": null,
"folder": false,
"treeLabel": "Label Three",
"createDate": "2021-11-02T09:12:58",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T09:12:58",
"lastUpdateBy": 1
}
],
"expiryDate": "2021-11-01",
"externalRef": null,
"customerId": "00003",
"customerName": null,
"customerGroup": null,
"quoteStatus": "DRAFT",
"renderInfo": null,
"serverMessagesExtended": null,
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"approvedByName": null,
"deniedByName": null,
"createDate": "2021-11-01T17:20:17",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T09:12:58",
"lastUpdateBy": 1,
"supersededBy": null,
"prevRev": "P-2147491340",
"rootUniqueName": "P-2147491340",
"quoteType": null,
"status": "DRAFT"
}
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
Request
Retrieves all quotes. You can also filter the returned data.
Filter example:
Returns only first 10 quotes with workflowStatus = APPROVED and quoteStatus = OFFER.
{
"endRow":10,
"oldValues": null,
"operationType":"fetch",
"startRow":0,
"textMatchStyle":"exact",
"data":{
"_constructor":"AdvancedCriteria",
"operator":"and",
"criteria":[
{
"fieldName":"workflowStatus",
"operator":"equals",
"value":"APPROVED"
},
{
"fieldName":"quoteStatus",
"operator":"equals",
"value":"OFFER"
}
]
}
}| Required Permission | Roles with the Required Permission |
|---|---|
| QUOTE_FETCHFILTERED | Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Data Integration (DATAINTEGRATION), View Competition Data (PB_COMPETITION_RO), View Products (PB_PRODUCTS_RO), Administer Price Lists (PB_PRICELISTS), Manage Products (PB_PRODUCTEDITOR), Manage Price Lists (PB_PRICELISTSEDITOR), Administer LPG (PB_PRICEGRIDS), Manage BoM Data (PB_BOM), Administer Products (PB_PRODUCTS), View QuoteConfigurator (PRICESHOP_RO) Manage Product Master (PB_PRODUCTS_ONLY), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Manage PromotionManager (CM_CONTRACTMANAGER), Edit Quoting (PRICESHOP_EDIT) Administer Rebates (RM_REBATEMANAGER), Administer Quoting (PRICESHOP_QUOTEADMIN), View Product Details (PB_PDETAILSVIEW), Manage Product Details Only (PB_PDETAILSEDITOR), Manage Claims (CLM_CLAIMMANAGER), Manage Product Master Extensions (PB_PXEDITOR), View BoM Data (PB_BOM_RO), Manage Products & Use EC (PB_PRODUCTEDITOR_EC), Manage Competition Data (PB_COMPETITION), Manage QuoteConfigurator (PRICESHOP), View Price Lists (PB_PRICELISTS_RO) |
Security
basic or X-PriceFx-jwt
The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.
Default 300
The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.fetchlist
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.fetchlist
- 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.fetchlist \
-H 'Content-Type: application/json' \
-d '{
"endRow": 300,
"oldValues": null,
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"data": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "quoteStatus",
"operator": "equals",
"value": "DEAL"
}
]
}
}'Response
application/json
{ "response": { "node": "<node>", "startRow": 0, "data": [ … ], "endRow": 1, "totalRows": 1, "status": 0 } }
Request
Retrieves quote details.
| 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.fetch/{typedID}
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.fetch/{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/quotemanager.fetch/{typedID}'Response
application/json
{ "response": { "node": "e2e-templates-node", "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