Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Recalculate a Quote
Upsert a Quote
List Quotes
Get a Quote
Submit a Quote
Export an Excel File
Export a DOCX File
Export a PDF File
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
Recalculate a Quote
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
Downloads the PDF file of the specified quote. CloudConvert must be enabled (Administration > Configuration > External Systems > CloudConvert).
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.fetchpdf/{uniqueName}
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.fetchpdf/{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.fetchpdf/P-2147491340-REV-3?output=xls&dataLocale=en&templateName=string'Request
Recalculates the price of the entire quote.
| Required Permission | Roles with the Required Permission |
|---|---|
| QUOTE_PRICE | 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.price
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.price
- 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.price \
-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
Retrieves product records. Additionally to the /productmanager.fetchproducts endpoint, this command supports filtering by a custom formula set for the configured and evaluated quote.
| 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
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.fetchproducts
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.fetchproducts
- 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.fetchproducts \
-H 'Content-Type: application/json' \
-d '{
"operationType": "fetch",
"startRow": 0,
"textMatchStyle": "exact",
"oldValues": null,
"distinctResults": false,
"data": {
"quote": {
"label": "Quote01",
"targetDate": "2021-11-01",
"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
}
],
"outputs": [],
"nodeId": null,
"userGroupEdit": null,
"userGroupViewDetails": null,
"expiryDate": "2021-11-01",
"externalRef": null,
"quoteType": null
},
"filterCriteria": {
"_constructor": "AdvancedCriteria",
"operator": "and",
"criteria": [
{
"fieldName": "unitOfMeasure",
"operator": "iContains",
"value": "EA"
}
]
}
},
"endRow": 50,
"sortBy": [
"sku"
]
}'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