List Products

post/quotemanager.fetchproducts

Retrieves product records. Additionally to the /productmanager.fetchproducts endpoint, this command supports filtering by a custom formula set for the configured and evaluated quote.

Required Permission Roles with the Required Permission
QUOTE_FETCHFILTERED Edit LPG & Add Products (PB_PRICEGRIDEDITOR_ADD_SKU), Edit LPG (PB_PRICEGRIDEDITOR), Data Integration (DATAINTEGRATION), View Competition Data (PB_COMPETITION_RO), View Products (PB_PRODUCTS_RO), Administer Price Lists (PB_PRICELISTS), Manage Products (PB_PRODUCTEDITOR), Manage Price Lists (PB_PRICELISTSEDITOR), Administer LPG (PB_PRICEGRIDS), Manage BoM Data (PB_BOM), Administer Products (PB_PRODUCTS), View QuoteConfigurator (PRICESHOP_RO) Manage Product Master (PB_PRODUCTS_ONLY), Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Manage PromotionManager (CM_CONTRACTMANAGER), Edit Quoting (PRICESHOP_EDIT) Administer Rebates (RM_REBATEMANAGER), Administer Quoting (PRICESHOP_QUOTEADMIN), View Product Details (PB_PDETAILSVIEW), Manage Product Details Only (PB_PDETAILSEDITOR), Manage Claims (CLM_CLAIMMANAGER), Manage Product Master Extensions (PB_PXEDITOR), View BoM Data (PB_BOM_RO), Manage Products & Use EC (PB_PRODUCTEDITOR_EC), Manage Competition Data (PB_COMPETITION), Manage QuoteConfigurator (PRICESHOP), View Price Lists (PB_PRICELISTS_RO)
Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
operationType
string non-empty
startRow
number
textMatchStyle
string non-empty
oldValues
any
distinctResults
boolean
required
object
required
object
label
required
string non-empty
targetDate
required
string non-empty
headerText
required
string non-empty
required
Array of objects non-empty unique
Array (non-empty)
name
required
string non-empty
label
required
string non-empty
lookupTableId
any
url
required
string non-empty
type
required
string non-empty
value
required
string non-empty
valueHint
required
string non-empty
readOnly
any
filter
any
parameterGroup
any
required
any
labelTranslations
any
addUnknownValues
any
typedId
any
alwaysEditable
any
inputs
Array of objects
parameterConfig
object
formattingOptions
object
valueOptions
any
outputs
required
Array of objects
nodeId
any
userGroupEdit
any
userGroupViewDetails
any
expiryDate
required
string non-empty
externalRef
any
quoteType
any
required
object
_constructor
required
string non-empty
operator
required
string non-empty
criteria
required
Array of objects
endRow
required
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.

sortBy
required
Array of any
Responses
200

OK

Request samples
application/json
{
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "oldValues": null,
  • "distinctResults": false,
  • "data": {
    • "quote": {
      • "label": "Quote01",
      • "targetDate": "2021-11-01",
      • "headerText": "<p>Quote message.</p>",
      • "inputs": [
        • {
          }
        ],
      • "outputs": [ ],
      • "nodeId": null,
      • "userGroupEdit": null,
      • "userGroupViewDetails": null,
      • "expiryDate": "2021-11-01",
      • "externalRef": null,
      • "quoteType": null
      },
    • "filterCriteria": {
      • "_constructor": "AdvancedCriteria",
      • "operator": "and",
      • "criteria": [
        • {
          }
        ]
      }
    },
  • "endRow": 50,
  • "sortBy": [
    • "sku"
    ]
}