POST

Search Promotions


Developer Preview

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

Searches promotions using WQL - Wix Query Language with support for free-text search and aggregations.

Use this method for complex queries that include free-text search, aggregations, or when you need faceted search results. For simple filtering, use Query Promotions instead.

Learn more about the differences between Query and Search methods.

PropertyCapabilitiesFilters
tags.privateTags.tagIdsSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
tags.publicTags.tagIdsSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
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
enabledSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
nameSearch:
Aggregate: ✗
Sort: ✗
Permissions
Read v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/promotions/search

Errors

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

Did this help?