Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Export a DOCX File
Upsert a Quote
List Quotes
Get a Quote
Submit a Quote
Export an Excel 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 a DOCX 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}
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'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'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