POST

Query Gift Card Products


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 up to 1,000 gift card products, given the provided paging, filtering, and sorting.

Query Gift Card Products runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • paging.limit is 50
  • paging.offset is 0

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

PropertyFiltersSort
id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
presetVariants.id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
createdDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
updatedDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
name$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
fixedExpirationDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
presetVariants.price$existsSort: ASC, DESC
Permissions
Manage eCommerce - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/gift-cards/v1/gift-card-products/query

Errors

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

Did this help?