Skip to content

The Pricefx Backend API

Pricefx REST API Reference

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

Advanced Configuration Options

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

Operations

Product Image

Operations

Configuration

Operations

Internationalization

Operations

Metadata

Operations

MCP

Operations

Clicmanager

Operations

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

Create a Quote

Request

Creates a Quote (Q) or a Temporary Quote (QTMP).

Security
basic or X-PriceFx-jwt
Path
TypeCodestringrequired

Enter the type code of the entity you want to create.

Enum"Q""QTMP"
Example: Q
Bodyapplication/json
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/clicmanager.create/Q \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "quote": {
        "inputs": [
          {
            "name": "Customer",
            "label": "Customer",
            "type": "CUSTOMER",
            "url": "/fetch/C/"
          }
        ],
        "outputs": [],
        "lineItems": [],
        "label": "New Quote",
        "quoteType": null,
        "nodeId": 0,
        "userGroupEdit": null,
        "userGroupViewDetails": null,
        "expiryDate": "2024-01-18",
        "targetDate": "2024-01-18",
        "externalRef": null,
        "viewState": {}
      }
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{ "response": { "node": "string", "data": [], "status": 0 } }

Save a Temporary Data

Request

Stores the temporary data from QTMP to the persisted data (Q). Returns the Quote (Q) object.

Security
basic or X-PriceFx-jwt
Path
typedIdstringrequired

typedId of the Temporary Quote you want to save.

Example: 123.QTMP
Bodyapplication/json
object
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 '{}'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{ "response": { "node": "string", "data": [], "status": 0 } }

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas