Filtering entities

You can perform extensive searches on supported entities by applying filters based on their static properties or custom attributes. A filter consists of three parts: an identifier, an operator, and a value.

Supported entities

The following entities and their searchable properties are currently supported.

Entity	Static properties
Customers	Email (text), ExternalCode (text), Currency (text), Name (text)
Items	FamilyCode (text), Stock (number), UomCode (text)

Operators

We support a range of operators to perform different types of comparisons. The expected value format depends on the operator you choose.

Operator	Description	Expected value type
Equal	Matches values that are exactly the same.	Non-array value
NotEqual	Matches values that are not the same.	Non-array value
GreaterThan	Matches numeric values that are greater than the specified value.	Numeric value
GreaterThanOrEqual	Matches numeric values that are greater than or equal to the specified value.	Numeric value
LessThan	Matches numeric values that are less than the specified value.	Numeric value
LessThanOrEqual	Matches numeric values that are less than or equal to the specified value.	Numeric value
In	Matches any value found within a list.	Array value
NotIn	Matches any value not found within a list.	Array value
IsNull	Matches properties that have no value.	No value needed
IsNotNull	Matches properties that contain any value.	No value needed

---

Examples

A filter is structured as a JSON object with the keys Identifier, Operator, and Value.

Example 1: Filtering by exact value

To find a customer with a specific email address, you would use the Equal operator.

{
  "Identifier": "Email",
  "Operator": "Equal",
  "Value": "info@core-suite.com"
}

Example 2: Checking for a value's existence

To find all items that have a value for the FamilyCode property, use the IsNotNull operator. Note that no Value must be provided for this operator.

{
  "Identifier": "FamilyCode",
  "Operator": "IsNotNull"
}

Example 3: Filtering by a list of values

You can check if a property's value is present within a list using the In operator. This example finds items where the custom attribute OLB-Brand is either 'Nike', 'Puma', or 'Adidas'.

{
  "Identifier": "OLB-Brand",
  "Operator": "In",
  "Value": ["Nike", "Puma", "Adidas"]
}