List merchant vouchers

Merchants

Description

Retrieve a paginated list of merchant vouchers, ordered by most recently added first.

Authentication Required: User must be authenticated and have the 'merchant' feature flag.

Authorization: Merchant users can only view vouchers for their own merchant account. The merchant_id filter is optional.

Parameters

page integer query

Page number for pagination (defaults to 1)

merchant_id integer query

Filter vouchers by merchant ID

Responses

200 Successful response with paginated vouchers

application/json

statusstring

Example: success

dataarray

current_pageinteger

Current page number

Example: 1

total_resultsinteger

Total number of vouchers

Example: 3

total_pagesinteger

Total number of pages

Example: 1

Example:

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "merchant_id": 1,
      "code": "GLOBAL15",
      "valid_from": "2026-05-01",
      "valid_until": "2026-12-31",
      "usage_conditions": "15% off orders above 100 EUR. Cannot be combined with other offers.",
      "created_at": "2026-05-20T10:00:00Z",
      "updated_at": "2026-05-20T10:00:00Z"
    }
  ],
  "current_page": 1,
  "total_results": 3,
  "total_pages": 1
}

401 Authentication required

application/json

Example:

{
  "status": "error",
  "message": "Not authenticated or insufficient permissions"
}

404 Page not found

application/json

Example:

{
  "status": "error",
  "message": "Page not found"
}