Filter Criteria Input

Input representation of the criteria to filter records based on supported properties.

JSON Example 

1"criteria":
2 [{
3   "attributeType": "ProductStandard",
4   "property": "name",
5   "operator": "eq",
6   "value": "iPhone"
7 }]

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
attributeTypeStringSearch attribute type of the facet for a faceted search.Optional63.0
operatorStringOperator used for the filter criteria.Required60.0
propertyStringProperty name to use in the filter, which must be the same as the object field. The supported property is name.Required60.0
valueObjectValue for the filter criteria.Required60.0

Valid values are:

  • ProductStandard
  • ProductCustom
  • ProductDynamicAttribute
  • ProductAttributeStandard
  • ProductAttributeCustom

The supported operators are:

  • eq
  • in
  • contains
  • gt—Specifies a greater than criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only.
  • lt—Specifies a less than criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only.
  • gte—Specifies a greater than or equal to criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only.
  • lte—Specifies a less than or equal to criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only.