Skip to content
Pricefx REST API
/Pricefx API Reference/
/
List Elements

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

Update a Logic (No syntax check)

Request

Updates the given logic. Skips the syntax check. Groovy compilation errors will still surface, but regular syntax errors could go unnoticed. Use with care!

Information: Skipping the syntax check is useful for better performance when the logic does not contain any inputs. If the logic contains inputs, the syntax check is needed.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the logic. The id is the typedId without the F suffix. For example, the id attribute of the item with typedId = 2147484837.F is 2147484837.

Example: 2147484837
Bodyapplication/json
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.update/2147484837/compileOnly \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "version": 6,
      "typedId": "2147484837.F",
      "uniqueName": "PriceList",
      "label": "Price List",
      "validAfter": "2021-07-12",
      "status": "ACTIVE",
      "simulationSet": null,
      "userGroupEdit": null,
      "userGroupViewDetails": null,
      "formulaNature": null,
      "lastUpdateByName": "admin",
      "elements": [
        {
          "version": 9,
          "typedId": "2147494038.FE",
          "elementName": "BasePrice",
          "elementLabel": "Base Price",
          "elementDescription": null,
          "elementGroups": [],
          "conditionElementName": null,
          "hideWarnings": false,
          "excludeFromExport": false,
          "protectedExpression": false,
          "elementTimeout": 0,
          "displayOptions": 21,
          "formatType": "MONEY_EUR",
          "elementSuffix": null,
          "allowOverride": false,
          "summarize": false,
          "hideOnNull": false,
          "userGroup": null,
          "cssProperties": null,
          "resultGroup": null,
          "combinationType": "FUNCTION",
          "criticalAlert": null,
          "redAlert": null,
          "yellowAlert": null,
          "labelTranslations": null,
          "createDate": "2021-11-04T14:56:11",
          "createdBy": 2147490696,
          "lastUpdateDate": "2021-11-04T18:16:42",
          "lastUpdateBy": 2147490696,
          "formulaExpression": "def avgCost = api.productExtension(\"pcost\")?.find()?.attribute1\nif(avgCost == null){\n    api.addWarning(\"Could not find Average Cost in PX table ProductCost\")\n}\nreturn avgCost"
        },
        {
          "version": 9,
          "typedId": "2147494043.FE",
          "elementName": "ListPrice",
          "elementLabel": "List Price",
          "elementDescription": null,
          "elementGroups": [],
          "conditionElementName": null,
          "hideWarnings": false,
          "excludeFromExport": false,
          "protectedExpression": false,
          "elementTimeout": 0,
          "displayOptions": 5,
          "formatType": null,
          "elementSuffix": null,
          "allowOverride": false,
          "summarize": false,
          "hideOnNull": false,
          "userGroup": null,
          "cssProperties": null,
          "resultGroup": null,
          "combinationType": "FUNCTION",
          "criticalAlert": null,
          "redAlert": null,
          "yellowAlert": null,
          "labelTranslations": null,
          "createDate": "2021-11-04T14:56:11",
          "createdBy": 2147490696,
          "lastUpdateDate": "2021-11-04T18:16:42",
          "lastUpdateBy": 2147490696,
          "formulaExpression": "def listPrice = out.BasePrice\n\n\nreturn listPrice"
        }
      ],
      "inputDescriptors": [],
      "formulaType": "PRICING",
      "createdByName": null,
      "createDate": "2021-11-04T14:56:11",
      "createdBy": 2147490696,
      "lastUpdateDate": "2021-11-04T18:16:42",
      "lastUpdateBy": 2147490696
    }
  }'

Responses

Example response

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

List Elements

Request

Returns all logic element names and labels, except elements where the Display Mode (displayOptions) is set to Never.

Security
basic or X-PriceFx-jwt
Path
uniqueNamestringrequired

The name (uniqueName) of the logic you want to list elements for.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.getelementnames/{uniqueName}'

Responses

OK

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

Execute an Assigned Logic

Request

Executes a logic that is assigned to the given product (specified by sku or typedId) and calculates the result. The result content is defined partially by the visibility flags that are part of the logic master data.

Security
basic or X-PriceFx-jwt
Path
skustringrequired

The sku or typedId of the product you want to execute the logic for.

Bodyapplication/json
dataobject

Provide inputs for the logic as key-value pairs.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/formulamanager.execute/{sku}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "priority": "high",
      "quantity": 14,
      "map": {
        "key": "value"
      }
    }
  }'

Responses

OK

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

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

Comments

Operations

Notifications

Operations

Heartbeat

Operations

Key-Value Store

Operations

Entities

otherSchemas

Schemas