Skip to main content
POST
/
commerce
/
orders
/
orderrouting
/
api
/
v1
/
filter
/
criteriaSet
Error
A valid request URL is required to generate request examples
{
  "booleanOperator": "filter.logic.equal",
  "created": "2023-11-07T05:31:56Z",
  "creatorUsername": "<string>",
  "customAttributeName": "<string>",
  "dataPointExtensibleAttributeFQN": "<string>",
  "dataPointExtensibleAttributeName": "<string>",
  "dataPointExtensibleAttributeType": "<string>",
  "dataPointExtensibleFilter": true,
  "dotDelimitedPropertyName": "<string>",
  "environmentID": 123,
  "extensibleAttributeFQN": "<string>",
  "extensibleAttributeName": "<string>",
  "extensibleAttributeType": "<string>",
  "extensibleFilter": true,
  "filterID": 123,
  "filterUnit": {
    "dimension": {},
    "standardUnit": {}
  },
  "name": "<string>",
  "pathString": "<string>",
  "persisted": true,
  "siteID": 123,
  "tenantID": 123,
  "updated": "2023-11-07T05:31:56Z",
  "updaterUsername": "<string>",
  "userContext": {
    "environmentID": 123,
    "loaded": true,
    "pathString": "<string>",
    "siteID": 123,
    "siteService": {},
    "tenantID": 123,
    "tenantService": {
      "tenantClient": {}
    }
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Headers

​
x-vol-tenant
integer<int32>
required

Tenant

​
x-vol-site
integer<int32>
required

Site

Body

application/json
​
acceptNulls
boolean
​
booleanOperator
enum<string>
Available options:
filter.logic.equal,
filter.logic.not.equal,
filter.logic.greater.than,
filter.logic.less.than,
filter.logic.greater.or.equal,
filter.logic.less.or.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.between,
filter.logic.starts.with,
filter.logic.ends.with,
filter.logic.contains,
filter.logic.equal,
filter.logic.not.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.subset
​
created
string<date-time>
​
creatorUsername
string
​
customAttributeName
string
​
dataPointExtensibleAttributeFQN
string
​
dataPointExtensibleAttributeName
string
​
dataPointExtensibleAttributeType
string
​
dataPointExtensibleFilter
boolean
​
definitions
object[]
​
dotDelimitedPropertyName
string
​
environmentID
integer<int32>
​
extensibleAttributeFQN
string
​
extensibleAttributeName
string
​
extensibleAttributeType
string
​
extensibleFilter
boolean
​
filterID
integer<int32>
​
filterUnit
UnitOfobject · object
​
locationCriteriaSet
object
​
name
string
​
pathString
string
​
persisted
boolean
​
siteID
integer<int32>
​
tenantID
integer<int32>
​
updated
string<date-time>
​
updaterUsername
string
​
userContext
object

Response

OK

​
booleanOperator
enum<string>
Available options:
filter.logic.equal,
filter.logic.not.equal,
filter.logic.greater.than,
filter.logic.less.than,
filter.logic.greater.or.equal,
filter.logic.less.or.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.between,
filter.logic.starts.with,
filter.logic.ends.with,
filter.logic.contains,
filter.logic.equal,
filter.logic.not.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.subset
​
created
string<date-time>
​
creatorUsername
string
​
customAttributeName
string
​
dataPointExtensibleAttributeFQN
string
​
dataPointExtensibleAttributeName
string
​
dataPointExtensibleAttributeType
string
​
dataPointExtensibleFilter
boolean
​
dotDelimitedPropertyName
string
​
environmentID
integer<int32>
​
extensibleAttributeFQN
string
​
extensibleAttributeName
string
​
extensibleAttributeType
string
​
extensibleFilter
boolean
​
filterID
integer<int32>
​
filterUnit
UnitOfobject · object
​
name
string
​
pathString
string
​
persisted
boolean
​
siteID
integer<int32>
​
tenantID
integer<int32>
​
updated
string<date-time>
​
updaterUsername
string
​
userContext
object