Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Get a Temporary Data
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
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
Delete All Line Items
Import Line Items (w/o Input Types)
Get Folder Statistics
Undo Quote Revocation
Get a Temporary Data
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/clicmanager.save/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.save/{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.save/123.QTMP \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Request
Retrieves the existing temporary data (QTMP) for the specified Quote. Creates a new QTMP object for the Quote, if the temporary data does not exist.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchtmpheader/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchtmpheader/{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.fetchtmpheader/2147494304.Q \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-bdcdc86b4-c5npl", "data": [ … ], "status": 0 } }
Request
Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.
This action can be performed only on doucments in the DRAFT status.
If 'Recalculate after line item modification' option is set then the document is recalculated.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.removeallitems/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.removeallitems/{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.removeallitems/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-657c8dd448-5w72q", "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