Skip to content

Paged Store Coupons

GET
/admin/coupon/paged

Returns a paged list of coupons for a store

page
number
perPage
number
filter
string
sortBy
string
sortOrder
string
Allowed values: ASC DESC NONE RAND
status
string
Allowed values: ACTIVE INACTIVE SCHEDULED EXPIRED

Returns a paged list of coupons for a store

Array<object>
object
id
required
number
code
required
string
type
required
value
required
string
minimumPurchase
required
string | null
startDate
required
string | null
endDate
required
string | null
usageLimit
required
number | null
usageCount
required
number
isActive
required
boolean
createdOn
required
string
maxUsagePerCustomer
required
number | null
currencyId
required
number | null
status
required
string
Allowed values: ACTIVE INACTIVE SCHEDULED EXPIRED