Gift Cards API: Supported Filters and Sorting

Query Gift Cards

The following table shows field support for filters and sorting for the Query Gift Cards method:

FieldSupported FiltersSortable
_id$eq, $ne, $exists, $in, $startsWith, $gt, $lt, $le, $geSortable
_createdDate$eq, $ne, $exists, $in, $lt, $le, $gt, $geSortable
_updatedDate$eq, $ne, $exists, $in, $lt, $le, $gt, $geSortable
code$eq, $ne, $exists, $in, $startsWith, $gt, $lt, $le, $geSortable
codeSuffix$eq, $ne, $exists, $in, $startsWith, $gt, $lt, $le, $geSortable
balance$eq, $ne, $exists, $inSortable
expirationDate$eq, $ne, $exists, $in, $lt, $le, $gt, $geSortable
initialValue$eq, $ne, $exists, $inSortable

Search Gift Cards

The following table shows field support for search, aggregation, sorting, and filtering for the Search Gift Cards method:

FieldCapabilitiesFiltersSortable
_idSearch: ✗
Aggregate: ✓
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
_createdDateSearch: ✗
Aggregate: ✓
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSortable
_updatedDateSearch: ✗
Aggregate: ✓
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSortable
codeSearch: ✓
Aggregate: ✗
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
codeSuffixSearch: ✓
Aggregate: ✓
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSortable
balanceSearch: ✗
Aggregate: ✓
$eq, $ne, $exists, $in, $anySortable
expirationDateSearch: ✗
Aggregate: ✓
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSortable
initialValueSearch: ✗
Aggregate: ✓
$eq, $ne, $exists, $in, $anySortable

Related content: API Query Language, Query Gift Cards, Search Gift Cards

Did this help?