Skip to content
Pricefx REST API
/Pricefx API Reference/
/
Delete a Price Grid Item...

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

Deny a Live Price Grid Item

Request

Sets the approvalState field to Denied.

Required PermissionRoles with the Required Permission
PRICEGRID_SUBMITEdit 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 the Price Grid Item you want to deny.

Bodyapplication/json
dataobjectrequired
data.​idsArray of stringsrequired

Specify typedIds of items you want to deny.

curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.reject/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "ids": [
        "650.PGI"
      ]
    }
  }'

Responses

Example response

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

Delete a Price Grid Item (Filter)

Request

Deletes a Live Price Grid Item based on filter settings.

Filter example:

Deletes only Price Grid Items where comments = "del".

{
  "data": {
    "filterCriteria": {
      "operator": "and",
      "criteria": [
        {
          "fieldName": "comments",
          "operator": "iEquals",
          "value": "del"
        }
      ]
    }
  }
}
Required PermissionRoles with the Required Permission
PRICEGRID_REMOVEEdit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Administer LPG (PB_PRICEGRIDS)
Security
basic or X-PriceFx-jwt
Path
idstringrequired

The ID of the Price Grid that contains Price Grid Items you want to delete.

Bodyapplication/json
dataobjectrequired
data.​filterCriteriaobjectrequired
data.​filterCriteria.​operatorstringnon-emptyrequired
data.​filterCriteria.​criteriaArray of objectsnon-emptyuniquerequired
data.​filterCriteria.​criteria[].​fieldNamestringnon-emptyrequired
data.​filterCriteria.​criteria[].​operatorstringnon-emptyrequired

Specify an operator of the filter criteria.

Enum"equals""iEquals""notEqual""iNotEqual""isNull""notNull""contains""iContains""containsPattern""iContainsPattern"
data.​filterCriteria.​criteria[].​valuestringnon-emptyrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.delete/{id}/batch' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "filterCriteria": {
        "operator": "and",
        "criteria": [
          {
            "fieldName": "comments",
            "operator": "iEquals",
            "value": "del"
          }
        ]
      }
    }
  }'

Responses

OK

Add Price Grid Items to a Price Grid

Request

Adds products to the Live Price Grid.

Information: Only products that are not already in the Price Grid will be added. You can specify products by skus (see the example 1 below) or by filter settings (see example 2).

Example 1:

Adds only products with specified SKUs.

{
   "data":{
      "skus":[
         "p0001",
         "p0002"
      ]
   }
}

Example 2:

Adds only products where formulaName = "CompetitionPricing".

{
   "data":{
      "filterCriteria":{
         "operator":"and",
         "criteria":[
            {
               "fieldName":"formulaName",
               "operator":"iEquals",
               "value":"CompetitionPricing"
            }
         ]
      }
   }
}

To add items without a recalculation, use the /pricegridmanager.add/{id}/norecalc endpoint.

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

The ID of the Live Price Grid where you want to add Price Grid Items to. id is the typedId without PG suffix. For example, the id attribute of the item with typedId = 649.PG is 649. You can retrieve the id of the LPG, for example, by calling the /fetch/PG endpoint.

Bodyapplication/json
dataobjectrequired
data.​filterCriteriaobjectrequired
data.​filterCriteria.​operatorstringnon-emptyrequired
data.​filterCriteria.​criteriaArray of objectsnon-emptyuniquerequired
data.​filterCriteria.​criteria[].​fieldNamestringnon-emptyrequired
data.​filterCriteria.​criteria[].​operatorstringnon-emptyrequired

Specify an operator of the filter criteria.

Enum"equals""iEquals""notEqual""iNotEqual""isNull""notNull""contains""iContains""containsPattern""iContainsPattern"
data.​filterCriteria.​criteria[].​valuestringnon-emptyrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/pricegridmanager.add/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {
      "filterCriteria": {
        "operator": "and",
        "criteria": [
          {
            "fieldName": "formulaName",
            "operator": "iEquals",
            "value": "CompetitionPricing"
          }
        ]
      }
    }
  }'

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