Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Get a Live Price Grid

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

List Live Price Grids

Request

Retrieves all Price Grids based on filter settings.

Filter example:

Returns only Price Grids where status = CANCELLED.

{
   "data":{
      "_constructor":"AdvancedCriteria",
      "operator":"and",
      "criteria":[
         {
            "fieldName":"status",
            "operator":"equals",
            "value":"CANCELLED"
         }
      ]
   }
}
Security
basic or X-PriceFx-jwt
Bodyapplication/json
endRownumber

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

Default 300
oldValuesany
operationTypestringnon-empty
startRownumber

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

textMatchStylestringnon-empty
dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/fetch/PG \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "status",
          "operator": "equals",
          "value": "READY"
        }
      ]
    }
  }'

Responses

OK

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

Get a Live Price Grid

Request

Retrieves details of the specified Live Price Grid.

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The id of the Live Price Grid you want to retrieve details for. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint.

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

Responses

OK

Bodyapplication/json
responseobjectrequired
response.​nodestringnon-emptyrequired
response.​csrfTokenstringnon-emptyrequired
response.​dataArray of objectsnon-emptyuniquerequired
response.​data[].​versionnumber
response.​data[].​typedIdstringnon-empty
response.​data[].​labelstringnon-empty
response.​data[].​calculationMessagesstringnon-empty
response.​data[].​numberOfItemsnumber
response.​data[].​keepManualOverridesboolean
response.​data[].​writeOnlyChangedItemsboolean
response.​data[].​configurationstringnon-empty
response.​data[].​numberOfApprovedItemsnumber
response.​data[].​numberOfOpenItemsnumber
response.​data[].​numberOfDeniedItemsnumber
response.​data[].​numberOfSubmittedItemsnumber
response.​data[].​numberOfAutoApprovedItemsnumber
response.​data[].​priceGridTypestringnon-empty
response.​data[].​createdByNamestringnon-empty
response.​data[].​lastUpdateByNamestringnon-empty
response.​data[].​updateDatestringnon-empty
response.​data[].​updatedBynumber
response.​data[].​createDatestringnon-empty
response.​data[].​createdBynumber
response.​data[].​lastUpdateDatestringnon-empty
response.​data[].​lastUpdateBynumber
response.​data[].​statusstringnon-empty
response.​data[].​calculationStartDatestringnon-empty
response.​data[].​calculationDatestringnon-empty
response.​data[].​partialCalculationDatestringnon-empty
response.​data[].​idnumber
response.​statusnumberrequired
Response
application/json
{
  "response": {
    "node": "string",
    "csrfToken": "string",
    "data": [ … ],
    "status": 0
  }
}

List Live Price Grid Items

Request

Retrieves Live Price Grid Items.

A filter can be applied.

Filter example:

Returns the item where id = 644.

Please note:

Filtering by typedId is not accepted by this enpoint.

{
   "endRow":300,
   "oldValues":null,
   "operationType":"fetch",
   "startRow":0,
   "textMatchStyle":"exact",
   "data":{
      "_constructor":"AdvancedCriteria",
      "operator":"and",
      "criteria":[
         {
            "fieldName":"id",
            "operator":"equals",
            "value":644
         }
      ]
   }
}

Required PermissionRoles with the Required Permission
PRICEGRID_FETCHEdit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Manage Workflow Logics (WF_BUILDER)

Security
basic or X-PriceFx-jwt
Path
idstringrequired

The id of the Live Price Grid you want to retrieve items for. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint.

Bodyapplication/json
endRownumber

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

Default 300
oldValuesany
operationTypestringnon-empty

Enter fetch, null, or omit the param.

startRownumber

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

textMatchStylestringnon-empty
dataobject
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.fetch/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "endRow": 300,
    "oldValues": null,
    "operationType": "fetch",
    "startRow": 0,
    "textMatchStyle": "exact",
    "data": {
      "_constructor": "AdvancedCriteria",
      "operator": "and",
      "criteria": [
        {
          "fieldName": "currency",
          "operator": "equals",
          "value": "USD"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
responseobject
Response
application/json
{
  "response": {
    "node": "string",
    "csrfToken": "string",
    "startRow": 0,
    "data": [ … ],
    "endRow": 300,
    "totalRows": 0,
    "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