Add Price Grid Items to a Price Grid

post/pricegridmanager.add/{id}

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

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.

Request Body schema: application/json
required
object
required
object
operator
required
string non-empty
required
Array of objects non-empty unique
Array (non-empty)
fieldName
required
string non-empty
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
string non-empty
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
data
any
status
number
Request samples
application/json
{
  • "data": {
    • "filterCriteria": {
      • "operator": "and",
      • "criteria": [
        • {
          }
        ]
      }
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": null,
    • "status": 0
    }
}