List Customers

post/customermanager.fetchformulafilteredcustomers

Retrieves a list of Customers. A filter can be applied (see the request sample).

You can choose fields to be returned in the response by employing the resultFields or valueFields filter:
resultFields: returns key-value pairs as objects. This is the more friendly response compared to valueFields but the server fetches all fields from the database in the backend which might result in a slower performance. See the listCustomersResponseExample_resultFields response example.

valueFields: returns just an array of values. Use this option if a better performance is required. See the listCustomersResponseExample_valueFields response example.

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 or null
_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

Returns customer record details.

Response Schema: application/json
object or object
Any of:
node
string non-empty
Array of objects (Customer) non-empty unique

The Customer object. The Type code is C.

Array (non-empty)
createDate
string <date-time>
createdBy
integer
customerId
string <= 255 characters
isParent
boolean or null
lastUpdateBy
integer
lastUpdateDate
string <date-time>
name
string <= 255 characters
nodeId
integer
parentId
integer
typedId
string
userGroupEdit
string <= 255 characters
userGroupViewDetails
string <= 255 characters
version
integer
attribute1
string <= 255 characters
attribute2
string <= 255 characters
attribute3
string <= 255 characters
attribute4
string <= 255 characters
attribute5
string <= 255 characters
attribute6
string <= 255 characters
attribute7
string <= 255 characters
attribute8
string <= 255 characters
attribute9
string <= 255 characters
attribute10
string <= 255 characters
attribute11
string <= 255 characters
attribute12
string <= 255 characters
attribute13
string <= 255 characters
attribute14
string <= 255 characters
attribute15
string <= 255 characters
attribute16
string <= 255 characters
attribute17
string <= 255 characters
attribute18
string <= 255 characters
attribute19
string <= 255 characters
attribute20
string <= 255 characters
attribute21
string <= 255 characters
attribute22
string <= 255 characters
attribute23
string <= 255 characters
attribute24
string <= 255 characters
attribute25
string <= 255 characters
attribute26
string <= 255 characters
attribute27
string <= 255 characters
attribute28
string <= 255 characters
attribute29
string <= 255 characters
attribute30
string <= 255 characters
status
number
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "attribute2",
        • "operator": "iEquals",
        • "value": "123456789"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "createDate": "2019-08-24T14:15:22Z",
        • "createdBy": 0,
        • "customerId": "string",
        • "isParent": true,
        • "lastUpdateBy": 0,
        • "lastUpdateDate": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "nodeId": 0,
        • "parentId": 0,
        • "typedId": "string",
        • "userGroupEdit": "string",
        • "userGroupViewDetails": "string",
        • "version": 0,
        • "attribute1": "string",
        • "attribute2": "string",
        • "attribute3": "string",
        • "attribute4": "string",
        • "attribute5": "string",
        • "attribute6": "string",
        • "attribute7": "string",
        • "attribute8": "string",
        • "attribute9": "string",
        • "attribute10": "string",
        • "attribute11": "string",
        • "attribute12": "string",
        • "attribute13": "string",
        • "attribute14": "string",
        • "attribute15": "string",
        • "attribute16": "string",
        • "attribute17": "string",
        • "attribute18": "string",
        • "attribute19": "string",
        • "attribute20": "string",
        • "attribute21": "string",
        • "attribute22": "string",
        • "attribute23": "string",
        • "attribute24": "string",
        • "attribute25": "string",
        • "attribute26": "string",
        • "attribute27": "string",
        • "attribute28": "string",
        • "attribute29": "string",
        • "attribute30": "string"
        }
      ],
    • "status": 0
    }
}