Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
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
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
Get a Quote/Contract/Reba...
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
Adds specified product items to the quote. The quote is recalculated after the items are added.
| 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.addproducts
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.addproducts
- 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.addproducts \
-H 'Content-Type: application/json' \
-d '{
"data": {
"quote": {
"version": 3,
"typedId": "2147491354.Q",
"uniqueName": "P-2147491354",
"label": "New Quote 2021",
"targetDate": "2021-11-02",
"workflowStatus": "DRAFT",
"headerText": "<p>Quote 2021</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": null
},
"outputs": [],
"lastUpdateByName": "admin",
"createdByName": "admin",
"submittedByName": null,
"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": [],
"expiryDate": "2021-11-30",
"externalRef": null,
"customerId": "00003",
"customerName": "Kate Smith",
"customerGroup": null,
"quoteStatus": "DRAFT",
"renderInfo": null,
"serverMessagesExtended": null,
"approvalRequiredEmailAttachmentsJson": null,
"hasWorkflowHistory": false,
"approvedByName": null,
"deniedByName": null,
"createDate": "2021-11-02T16:41:33",
"createdBy": 2147490696,
"lastUpdateDate": "2021-11-02T16:41:33",
"lastUpdateBy": 2147490696,
"supersededBy": null,
"prevRev": null,
"rootUniqueName": "P-2147491354",
"quoteType": "default",
"status": "DRAFT"
},
"parent": null,
"skus": [
"11111",
"22222",
"33333"
]
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
Request
Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - without line items.
This endpoint is used in the REACT version only. It is not advisable to mix REACT endpoints together with Ember endpoints.
Use the clicmanager.fetch/{typedId} endpoint to return line items of the specified entity.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchheader/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchheader/{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.fetchheader/127.CTResponse
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).
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
Query
Bodyapplication/jsonSet to true to exclude large results (e.g., charts, matrix table, etc.) from response. Use the /clicmanager.fetchoutput/{typedId}/{resultName} (e.g., /clicmanager.fetchoutput/2147490386.Q/FlexChart) to download the result separately.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetch/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.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/clicmanager.fetch/{typedId}?noComplexResults=true&getMyItemsForReview=true' \
-H 'Content-Type: application/json' \
-d '{
"endRow": 0,
"oldValues": {},
"operationType": "string",
"startRow": 0,
"textMatchStyle": "string",
"data": {
"operator": "string",
"_constructor": "string",
"criteria": [
{
"fieldName": "string",
"operator": "string"
}
]
}
}'Response
application/json
{ "response": { "node": "string", "startRow": 0, "data": [ … ], "endRow": 0, "totalRows": 0, "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