Filter and sort

Query Language

Endpoints that allow querying follow these format guidelines.

Fields That Allow Filtering

FieldOperatorsSorting Allowed
id$eq,$ne,$hasSome,$contains,$startsWithAllowed
dateCreated$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
expired$eq,$ne
specification.active$eq,$ne
specification.name$eq,$ne,$hasSome,$contains,$startsWithAllowed
specification.code$eq,$ne,$hasSome,$contains,$startsWithAllowed
specification.usageLimit$eq,$ne,$hasSome,$contains,$startsWithAllowed
specification.limitedToOneItem$eq,$ne
scope.namespace$eq,$ne,$hasSome,$contains,$startsWithAllowed
scope.group.name$eq,$ne,$hasSome,$contains,$startsWithAllowed
scope.group.entityId$eq,$ne,$hasSome,$contains,$startsWithAllowed

** Note that "HasSome" is same as the operator "IN" in SQL

Examples

Query valid (i.e., non-expired) coupons

Copy

Get all coupons, sorted by creation date

Copy

Get coupons by IDs

Copy
Did this help?