Skip to main content
GET
List Discounts

List Discounts

Returns a paginated list of discount codes in the store.

Request

Parameters

integer
default:"1"
Page number for pagination
integer
default:"50"
Number of items per page
string
Filter by status: active, expired, scheduled, disabled
string
Search by discount code (partial, case-insensitive match)

Response

Returns the standard response envelope. The data object contains the discount rows plus flat pagination counters.
integer
HTTP status code (e.g. 200)
string
Response state: success or error
string
Human-readable message (null on success)
array
Array of discount objects
integer
Total number of matching discounts
integer
Current page number
integer
Page size used for this request

Example Response

Error Response

Errors return the same envelope with an error state and the message under message: