filter by customerId

The filter parameter allows filtering customers based on specific field values.

Format: field:operator:value (except for isnull and isnotnull, which do not require a value).

Supported operators:

• eq → equals
• ne → not equals
• lt → less than
• gt → greater than
• lte → less than or equals
• gte → greater than or equals
• isnull → field value is null (no value required)
• isnotnull → field value is not null (no value required)

Examples:

• age:gt:18 → Returns all customers where the age field is greater than 18.
• name:eq:John → Returns all customers where the name field equals "John".
• email:isnull → Returns all customers where the email field is null.
• phone:isnotnull → Returns all customers where the phone field is not null.

Multiple filters can be applied by using multiple filter query parameters. The maximum number of filters allowed is 3.

Note: Ensure that URI components are properly encoded. Examples:

• age:gt:18 → age%3Agt%3A18
• birthday:eq:2000-10-29T21:12:48.123Z → birthday%3Aeq%3A2000-10-29T21%3A12%3A48.123Z
• email:isnull → email%3Aisnull
• phone:isnotnull → phone%3Aisnotnull

Date fields must be in ISO 8601 format. Example: 2021-10-22T10:46:23.897Z

The orderBy parameter specifies the sorting criteria for customer fields. Only numeric and date fields can be used for sorting. String fields will be ignored.

Format: field:direction

Directions:

• asc (ascending)
• desc (descending)

Examples:

• age:asc → Sorts customers by the age field in ascending order.
• payment_date:desc → Sorts customers by payment_date in descending order.

Multiple sorting criteria can be applied by using multiple orderBy query parameters. The maximum number of sorting parameters allowed is 3.

Important: The order of orderBy parameters in the query string determines the priority of sorting. Parameters appearing first take precedence over later ones.

Note: Ensure that URI components are properly encoded. Examples:

• age:asc → age%3Aasc
• payment_date:desc → payment_date%3Adesc

Null Handling: For the fields used in the orderBy parameter, if a field contains null values, those customers will always appear at the end of the list, regardless of the sorting direction.

Date fields must be in ISO 8601 format. Example: 2021-10-22T10:46:23.897Z

Condition to apply to the combined fields customers filters (and/or) If there is more than one filter, the default is 'and' unless this parameter is set to 'or'