Skip to main content
GET
Search coupons

Filterable Fields

This endpoint supports filtering and sorting. See the Filtering & Sorting Guide for syntax details. Example:

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

The ID of the store to get the coupons in

query
string
required

The query to search by

Query Parameters

UsesFrom
integer<int32>

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

UsesTo
integer<int32>

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

MaximumUsesFrom
integer<int32>

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

MaximumUsesTo
integer<int32>

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

PercentageFrom
number<double>

Gets or sets the minimum percentage decrease to filter by.

PercentageTo
number<double>

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

AmountFrom
number<double>

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

AmountTo
number<double>

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

IsEnabled
boolean

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

Filters
string
Sorts
string
Page
integer<int32>
Required range: 1 <= x <= 2147483647
PageSize
integer<int32>
Required range: 1 <= x <= 2147483647

Response

The object was successfully returned.

Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.

success
boolean
required
read-only

Indicates whether the operation was successful

pages
integer<int32>
required

The total number of pages available in the paginated response.

data
object[]
required

Represents the collection of items within a paginated response

Last modified on August 2, 2026