List Quotes

post/quotemanager.fetchlist

Retrieves all quotes. You can also filter the returned data.

Filter example:

Returns only first 10 quotes with workflowStatus = APPROVED and quoteStatus = OFFER.

{
   "endRow":10,
   "oldValues": null,
   "operationType":"fetch",
   "startRow":0,
   "textMatchStyle":"exact",
   "data":{
      "_constructor":"AdvancedCriteria",
      "operator":"and",
      "criteria":[
         {
            "fieldName":"workflowStatus",
            "operator":"equals",
            "value":"APPROVED"
         },
         {
            "fieldName":"quoteStatus",
            "operator":"equals",
            "value":"OFFER"
         }
      ]
   }
}
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
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
string non-empty
operator
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
string non-empty
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
startRow
number
required
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
uniqueName
string non-empty
label
string non-empty
targetDate
string non-empty
workflowStatus
string non-empty
lastUpdateByName
string non-empty
createdByName
string non-empty
submittedByName
string non-empty
calculationStatus
number
dirty
boolean
refreshInputs
boolean
numberOfAttachments
number
expiryDate
string non-empty
quoteStatus
string non-empty
hasWorkflowHistory
boolean
approvedByName
string non-empty
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
prevRev
string non-empty
rootUniqueName
string non-empty
quoteType
string non-empty
status
string non-empty
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": "quoteStatus",
        • "operator": "equals",
        • "value": "DEAL"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "<node>",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 10,
        • "typedId": "2147491331.Q",
        • "uniqueName": "P-2147491330-REV-1",
        • "label": "New QuoteWF",
        • "targetDate": "2021-10-26",
        • "workflowStatus": "APPROVED",
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "submittedByName": "admin",
        • "calculationStatus": 0,
        • "dirty": false,
        • "refreshInputs": false,
        • "numberOfAttachments": 0,
        • "expiryDate": "2021-10-26",
        • "quoteStatus": "OFFER",
        • "hasWorkflowHistory": true,
        • "approvedByName": "admin",
        • "createDate": "2021-10-27T12:52:58",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-10-27T16:07:06",
        • "lastUpdateBy": 2147490696,
        • "prevRev": "P-2147491330",
        • "rootUniqueName": "P-2147491330",
        • "quoteType": "default",
        • "status": "DRAFT"
        }
      ],
    • "endRow": 1,
    • "totalRows": 1,
    • "status": 0
    }
}