Filter and sort
Query Language
Endpoints that allow querying follow these format guidelines.
Fields That Allow Filtering
| Field | Operators | Sorting Allowed |
|---|---|---|
| id | $eq,$ne,$hasSome,$contains,$startsWith | Allowed |
| dateCreated | $eq,$ne,$hasSome,$lt,$lte,$gt,$gte | Allowed |
| expired | $eq,$ne | |
| specification.active | $eq,$ne | |
| specification.name | $eq,$ne,$hasSome,$contains,$startsWith | Allowed |
| specification.code | $eq,$ne,$hasSome,$contains,$startsWith | Allowed |
| specification.usageLimit | $eq,$ne,$hasSome,$contains,$startsWith | Allowed |
| specification.limitedToOneItem | $eq,$ne | |
| scope.namespace | $eq,$ne,$hasSome,$contains,$startsWith | Allowed |
| scope.group.name | $eq,$ne,$hasSome,$contains,$startsWith | Allowed |
| scope.group.entityId | $eq,$ne,$hasSome,$contains,$startsWith | Allowed |
** Note that "HasSome" is same as the operator "IN" in SQL
Examples
Query valid (i.e., non-expired) coupons
Copy
1
Get all coupons, sorted by creation date
Copy
1
Get coupons by IDs
Copy
1
Was this helpful?
Yes
No