Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Mark an Offer as Lost
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
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
Mark an Offer as Lost
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/quotemanager.copy/{identifier}
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.copy/{identifier}
- 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.copy/{identifier}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
Request
Changes quoteStatus from OFFER to LOST.
| 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.changestatus/{identifier}
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.changestatus/{identifier}
- 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.changestatus/{identifier}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"targetStatus": "LOST"
}
}'Response
application/json
{ "response": { "node": "e2e-templates-node", "data": [ … ], "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/quotemanager.revoke/{identifier}
- URL:https://companynode.pricefx.com/pricefx/companypartition/quotemanager.revoke/{identifier}
- 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.revoke/{identifier}'Response
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": null, "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