v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Coupon

Search coupons

Searches the coupons in the store by the given query. Requires the stores.coupons.view permission.

get/stores/{storeId}/coupons/search/{query}

Path parameters

storeIdstring uuid required

The ID of the store to get the coupons in

querystring required

The query to search by

Query parameters

UsesFrominteger

Gets or sets the lower limit for the number of times a coupon has been used.

UsesTointeger

Gets or sets the upper limit for the number of times a coupon has been used.

MaximumUsesFrominteger

Gets or sets the lower limit for the maximum number of uses allowed for a coupon.

MaximumUsesTointeger

Gets or sets the upper limit for the maximum number of uses allowed for a coupon.

PercentageFromnumber double

Gets or sets the minimum percentage decrease to filter by.

PercentageTonumber double

Gets or sets the upper limit for the percentage decrease applied to the coupon.

AmountFromnumber double

Gets or sets the lower limit for the amount-based discount filtering.

AmountTonumber double

Gets or sets the upper limit for the amount-based discount filter.

IsEnabledboolean

Gets or sets a value indicating whether the coupon is enabled.

Filtersstring
Sortsstring
Pageinteger
PageSizeinteger

Response

The object was successfully returned.

successboolean required

Indicates whether the operation was successful

pagesinteger required

The total number of pages available in the paginated response.