POST

Query 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.

Retrieves a list of up to 100 promotions, given the provided paging, filtering, and sorting.

Query Promotions runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 100

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, $startsWithSort: ASC, DESC
createdDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
updatedDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
enabled$eq, $ne, $in, $existsSort: ASC, DESC
tags.publicTags.tagIds$hasSome, $hasAll, $exists, $isEmptySort: ASC, DESC
tags.privateTags.tagIds$hasSome, $hasAll, $exists, $isEmptySort: ASC, DESC
Permissions
Read v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/promotions/query

Errors

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

Did this help?