Perform a Mass Action

post/pricegridmanager.massaction/{id}

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 Permission Roles with the Required Permission
PRICEGRID_UPDATE Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Administer LPG (PB_PRICEGRIDS)
Securitybasic or X-PriceFx-jwt
Request
path Parameters
id
required
string

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

Request Body schema: application/json
required
object
_constructor
required
string non-empty
operator
required
string non-empty
required
Array of objects non-empty unique

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

Array (non-empty)
fieldName
required
string non-empty

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

operator
required
string non-empty

Specify an operator of the filter criteria.

Possible values: "equals" "iEquals" "notEqual" "iNotEqual" "isNull" "notNull" "contains" "iContains" "containsPattern" "iContainsPattern" "notContains" "iNotContains" "startsWith" "iStartsWith" "notStartsWith" "iNotStartsWith" "endsWith" "iEndsWith" "notEndsWith" "iNotEndsWith" … 4 more
value
required
number

Specify the value of the field.

workflowAction
string non-empty

Specify the workflow action you want to perform.

Possible values: "SUBMITTED" "WITHDRAWN" "APPROVED" "DENIED"
comment
required
string >= 0 characters

Enter the comment. Only for Approve and Deny actions.

itemAction
string

Specify the item action you want to perform.

Possible values: "recalculate" "edit"
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
data
any
status
number
Request samples
application/json
{
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "activePrice",
        • "operator": "equals",
        • "value": 11
        }
      ],
    • "workflowAction": "SUBMITTED",
    • "comment": ""
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": null,
    • "status": 0
    }
}