List Price List Items

post/pricelistmanager.fetch/{id}

Retrieves a list of Price List Items. A filter can be applied.

Required Permission Roles with the Required Permission
PRICELIST_FETCH Administer Price Lists (PB_PRICELISTS), Manage Price Lists (PB_PRICELISTSEDITOR), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), View Price Lists (PB_PRICELISTS_RO)
Securitybasic or X-PriceFx-jwt
Request
path Parameters
id
required
string

The ID of the Price List you want to retrieve items for. The id is the typedId without the suffix. For example, the id attribute of the item with typedId = 2147484837.PL is 2147484837.

Request Body schema: application/json
endRow
number
Default: 300

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.

oldValues
any
operationType
string non-empty
startRow
number

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.

textMatchStyle
string non-empty
object
_constructor
string non-empty
operator
string non-empty
Array of objects non-empty unique
Array (non-empty)
fieldName
required
string non-empty
operator
required
string non-empty
value
required
string non-empty
Responses
200

Example response

Response Schema: application/json
object
node
string non-empty
startRow
number
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
sku
string non-empty
label
string non-empty
unitOfMeasure
string non-empty
currency
string non-empty
comments
string non-empty
resultPrice
number
allowedOverrides
string
calculatedResultPrice
number
pricelistId
number
createDate
string non-empty
createdBy
number
attribute1
number
completeResultsAvailable
boolean
itemExtensions
object
endRow
number
Default: 300

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.

totalRows
number
status
number
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "unitOfMeasure",
        • "operator": "iEquals",
        • "value": "EA"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "<node>",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "2147563138.PLI",
        • "sku": "11111",
        • "label": "Label One",
        • "unitOfMeasure": "EA",
        • "currency": "USD",
        • "resultPrice": 100,
        • "allowedOverrides": "",
        • "calculatedResultPrice": 100,
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "attribute1": 100,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        },
      • {
        • "version": 0,
        • "typedId": "2147563139.PLI",
        • "sku": "22222",
        • "label": "Label Two",
        • "unitOfMeasure": "EA",
        • "currency": "EUR",
        • "comments": "a comment",
        • "resultPrice": 200,
        • "allowedOverrides": "",
        • "calculatedResultPrice": 200,
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "attribute1": 200,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        },
      • {
        • "version": 0,
        • "typedId": "2147563140.PLI",
        • "sku": "33333",
        • "label": "Label Three",
        • "unitOfMeasure": "EA",
        • "currency": "CZK",
        • "resultPrice": 300,
        • "allowedOverrides": "",
        • "calculatedResultPrice": 300,
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "attribute1": 300,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        },
      • {
        • "version": 0,
        • "typedId": "2147563142.PLI",
        • "sku": "123456789",
        • "label": "The Label24",
        • "unitOfMeasure": "EA",
        • "currency": "USD",
        • "warnings": "{\"MarginPct\":[\"WTF?! Margin!\"],\"ListPrice\":[\"WTF?!\"],\"CompetitivePositioning\":[\"Product attribute BusinessUnit not found\",\"VLookup table CompetitionStrategy not found\"]}",
        • "allowedOverrides": "",
        • "pricelistId": 2147490401,
        • "createDate": "2021-11-10T12:38:30",
        • "createdBy": 2147490696,
        • "completeResultsAvailable": true,
        • "itemExtensions": { }
        }
      ],
    • "endRow": 4,
    • "totalRows": 4,
    • "status": 0
    }
}