Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Mark an Offer as Lost (with reason)
Get a Quote/Contract/Rebate Agreement/Compensation Plan Header
Submit a Quote/Contract/Rebate Agreement
List CLIC Objects
Update a Quote/Contract/Rebate Agreement/Compensation Plan
Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan
List Unique CLIC Items
Send an Email
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
Fetch Activities
Mark an Offer as Lost (wi...
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
Returns all SKUs for the given Calculable Line Item Collection (CLIC).
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
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.fetchitemuniquetypes/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.fetchitemuniquetypes/{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.fetchitemuniquetypes/{typedId}' \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-96569b957-fmkxp", "data": [ … ], "status": 0 } }
Request
Sets the specified Quote as LOST and sets the loss reason (lostReason). Optionally, an additional comment (lostReasonComment) can be added.
Returns the updated Quote object.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.setlostreason/{typedId}
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.setlostreason/{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.setlostreason/2147493285.Q \
-H 'Content-Type: application/json' \
-d '{
"data": {
"lostReason": "string",
"lostReasonComment": "string"
}
}'Response
application/json
{ "response": { "node": "pricefx-cluster-app-frontend-689d96f98d-hnkt9", "data": [ … ], "status": 0 } }
Request
Sends an email with attached document (e.g., a Quote) to the specified recipients using the Publishing Template. You can retrieve available publishing templates calling the configurationmanager.fetchtemplates/{TypeCode} endpoint.
To prevent misuse, such as email flooding or spam, the following rate limits and restrictions are applied:
Rate Limiting on clicmanager.sendemail Endpoint:
- Each user account is restricted to calling this endpoint no more than 5 times (default) within a 5-minute period (default).
- This limit is counted per partition.
Recipient Limitation in Payload:
- The payload for the
clicmanager.sendemailendpoint, which specifies recipients limits the number of recipients. - A default limit of 20 recipients.
To change these limits, adjust values for the following options in Advanced Configuration Options:
- sendEmailMaxRecipients
- sendEmailMinutesCountForThrottling
- sendEmailMaxCountInLastMinutes
Security
basic or X-PriceFx-jwt
A name of the existing template. See the Publishing Templates documentation.
Select the type of the attachment template.
Enum"WORD""PDF""EXCEL"
typedId of the attachment you want to send together with the Quote. This must be an existing attachment. You can upload a file on the Attachments tab of the document.
Example: "1147.BD"
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.sendemail
- URL:https://companynode.pricefx.com/pricefx/companypartition/clicmanager.sendemail
- 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.sendemail \
-H 'Content-Type: application/json' \
-d '{
"data": {
"typedId": "2147491329.Q",
"templateName": "word",
"attachmentType": "WORD",
"subject": "Quote P-2147491329",
"emailText": "You can call me at…",
"attachedFiles": "1147.BD",
"recipients": [
{
"name": "admin",
"email": "ondrej.tesar@pricefx.com"
}
]
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 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