Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Cancel a Calculation

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

Calculate a Price Grid

Request

Starts a calculation of the entire Live Price Grid.

Required PermissionRoles with the Required Permission
PRICEGRID_CALCULATEEdit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS)
Security
basic or X-PriceFx-jwt
Path
idstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.calculate/{id}'

Responses

OK

Bodyapplication/json
responseobjectrequired
response.​nodestringnon-emptyrequired
response.​csrfTokenstringrequired
response.​dataArray of objectsnon-emptyuniquerequired
response.​data[].​versionnumberrequired
response.​data[].​typedIdstringnon-emptyrequired
response.​data[].​processingNodeany
response.​data[].​threadIdany
response.​data[].​threadUUIDany
response.​data[].​statusstringnon-emptyrequired
response.​data[].​trackerTypestringnon-emptyrequired
response.​data[].​targetObjectstringnon-emptyrequired
response.​data[].​jobNamestringnon-emptyrequired
response.​data[].​concurrencyKeystringnon-emptyrequired
response.​data[].​calculationContextany
response.​data[].​progressany
response.​data[].​cancelRequestedbooleanrequired
response.​data[].​runNumbernumberrequired
response.​data[].​prioritynumberrequired
response.​data[].​messagesany
response.​data[].​jobSettingsobject
response.​data[].​createDatestringnon-emptyrequired
response.​data[].​createdBynumberrequired
response.​data[].​lastUpdateDatestringnon-emptyrequired
response.​data[].​lastUpdateBynumberrequired
response.​data[].​calculationResultsany
response.​data[].​processingStartany
response.​data[].​processingEndany
response.​data[].​idnumberrequired
response.​statusnumberrequired
Response
application/json
{
  "response": {
    "node": "string",
    "csrfToken": "string",
    "data": [ … ],
    "status": 0
  }
}

Cancel a Calculation

Request

Cancels a Price Grid calculation background job.

Required PermissionRoles with the Required Permission
PRICEGRID_CALCULATEEdit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS)
Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Live Price Grid whose running calculation should be cancelled.

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

Responses

OK

Bodyapplication/json
responseobjectrequired
response.​nodestringnon-emptyrequired
response.​csrfTokenstringrequired
response.​dataany
response.​statusnumberrequired
Response
application/json
{
  "response": {
    "node": "string",
    "csrfToken": "string",
    "data": null,
    "status": 0
  }
}

Perform a Mass Action

Request

Performs a mass workflow action on specified Price Grid Items based on filter settings.

Example:

Approves only products where activePrice = 250.

{
   "data":{
      "_constructor":"AdvancedCriteria",
      "operator":"and",
      "criteria":[
         {
            "fieldName":"activePrice",
            "operator":"equals",
            "value":250
         }
      ],
      "workflowAction":"APPROVED",
      "comment":"Approved."
   }
}
Required PermissionRoles with the Required Permission
PRICEGRID_UPDATEEdit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS)
Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Price Grid that contains items you want to apply workflow actions to.

Bodyapplication/json
dataobjectrequired
data.​_constructorstringnon-emptyrequired
data.​operatorstringnon-emptyrequired
data.​criteriaArray of objectsnon-emptyuniquerequired

Specify the criteria for which you want to filter the data.

data.​criteria[].​fieldNamestringnon-emptyrequired

Specify columns (fields) you want to apply the workflow action to.

data.​criteria[].​operatorstringnon-emptyrequired

Specify an operator of the filter criteria.

Enum"equals""iEquals""notEqual""iNotEqual""isNull""notNull""contains""iContains""containsPattern""iContainsPattern"
data.​criteria[].​valuenumberrequired

Specify the value of the field.

data.​workflowActionstringnon-empty

Specify the workflow action you want to perform.

Enum"SUBMITTED""WITHDRAWN""APPROVED""DENIED"
Example: "APPROVED"
data.​commentstring>= 0 charactersrequired

Enter the comment. Only for Approve and Deny actions.

data.​itemActionstring

Specify the item action you want to perform.

Enum"recalculate""edit"
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.massaction/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "activePrice",
          "operator": "equals",
          "value": 11
        }
      ],
      "workflowAction": "SUBMITTED",
      "comment": ""
    }
  }'

Responses

OK

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

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

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