POST

Search Gift Cards


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of gift cards that match the provided search options, paging, and filtering.

Learn about working with Search, Query and List Methods.

PropertyCapabilitiesFilters
createdDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
idSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
updatedDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
balanceSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
codeSearch:
Aggregate: ✗
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
codeSuffixSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
expirationDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
initialValueSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/gift-cards/v1/gift-cards/search

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?