Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Send an Email

The Pricefx Backend API

Pricefx REST API Reference

Download OpenAPI description
pricefx-server_openapi.json
pricefx-server_openapi.yaml
Overview
URL
https://www.pricefx.com
Pricefx
documentation@pricefx.com
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}

General

Operations

Products

Operations

Product Extensions

Operations

Product Image

Operations

Customers

Operations

Customer Extensions

Operations

Sellers

Operations

Seller Extensions

Operations

Condition Records

Operations

Competition Data

Operations

Imports

Operations

Data Change Requests

Operations

Lookup Tables / Company Parameters

Operations

User Admin

Operations

Authentication

Operations

Admin Tools

Operations

Logics

Operations

Logs

Operations

Custom Forms

Operations

Calculated Field Sets

Operations

Jobs & Tasks

Operations

Data Manager

Operations

Actions

Operations

Action Types

Operations

Price Lists

Operations

Manual Price Lists

Operations

Live Price Grids

Operations

Calculation Grids

Operations

Visual Configuration

Operations

Quotes

Operations

Contracts (Agreements & Promotions)

Operations

Visual Configuration

Operations

Rebate Agreements

Operations

Rebate Calculations

Operations

Rebate Record Group

Operations

Sales Compensations

Operations

Claim Types

Operations

Claims

Operations

Optimization

Operations

Workflow

Operations

Workflow Delegation

Operations

Attachments

To upload a file you need to perform the following actions using endpoints in this category:

  1. Create an Upload Slot
  2. Upload a File
  3. Delete an Upload Slot
Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

Clicmanager

Clicmanager (CLIC = "Calculable Line Item Collection") endpoints are used in the REACT version to manipulate Quote/Agreements & Promotions (Contract)/Rebate Agreement/Compensation Plan objects.

Operations

Mark an Offer as Lost (with reason)

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
Path
typedIdstringrequired

typedId of the Quote you want set as lost.

Example: 2147493285.Q
Bodyapplication/json
dataobjectrequired
data.​lostReasonstringrequired

The name of the lost reason. The name of the reason must be set in Administration > Configuration > Quoting > Quote Reasons.

data.​lostReasonCommentstring

An additional comment.

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"
    }
  }'

Responses

OK

Bodyapplication/json
responseobject(markOfferLostWithReasonResponse)
Response
application/json
{
  "response": {
    "node": "pricefx-cluster-app-frontend-689d96f98d-hnkt9",
    "data": [ … ],
    "status": 0
  }
}

Send an Email

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.

Email Sending Rate Limits and Restrictions

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.sendemail endpoint, 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
Bodyapplication/json
dataobjectrequired
data.​typedIdstringrequired

typedId of the Quote you want to send as an email attachament.

data.​templateNamestringrequired

A name of the existing template. See the Publishing Templates documentation.

data.​attachmentTypestringrequired

Select the type of the attachment template.

Enum"WORD""PDF""EXCEL"
data.​subjectstringrequired
data.​emailTextstring
data.​attachedFilesstring

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"
data.​recipientsArray of objectsrequired
data.​recipients[].​emailstringrequired
data.​recipients[].​namestring
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"
        }
      ]
    }
  }'

Responses

A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null.

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "data": null,
    "status": 0,
    "startRow": 0,
    "endRow": 0
  }
}

Update CLIC Line Items

Request

Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

typedId of the CLIC object (e.g., a Quote) you want to update line items for.

Example: 2147489828.Q
Bodyapplication/json
dataobjectrequired
data.​lineItemsArray of objectsrequired
data.​lineItems[].​versionintegerrequired
data.​lineItems[].​typedIdstringrequired

typedId of the line item you want to update.

Example: "2147526106.QLI"
data.​lineItems[].​inputsArray of objects
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.updatelineitems/2147489828.Q \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "lineItems": [
        {
          "version": 1,
          "typedId": "2147506890.QLI",
          "inputs": [
            {
              "name": "Quantity",
              "value": 2
            },
            {
              "name": "Quantity",
              "value": 5
            }
          ]
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "pricefx-cluster-app-frontend-5db9bf487f-58sbn",
    "data": [ … ],
    "status": 0
  }
}

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

See the Key-Value Database Storage Knowledge Base article for more details.

Operations

Entities

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.

otherSchemas

Schemas