---
title: "GET /api/v1.0/{appId}/vouchers/summaries"
method: GET
path: "/api/v1.0/{appId}/vouchers/summaries"
tags: ["Vouchers"]
---

# GET /api/v1.0/{appId}/vouchers/summaries

`GET /api/v1.0/{appId}/vouchers/summaries`

## Path parameters

- `appId` string, required

## Query parameters

- `pageIndex` integer
- `pageSize` integer
- `searchCodes` string[]
- `statusSearch` string[]
- `typeSearch` string[]
- `subTypeSearch` string[]
- `storeIds` integer[]
- `channelRestrictions` string[]

## Response `200`

OK

- RestApiPaginationResultVoucherSummary — Rest api pagination result
  - `Page` integer, required — Current page index
  - `Limit` integer, required — Current page size
  - `TotalRecordCount` integer, required — Total record count
  - `Data` VoucherSummary[], required — Generic data object.
    - `VoucherId` integer — Voucher Id
    - `Code` string — Voucher Code
    - `Status` 'Valid' | 'NotYetValid' | 'Expired' | 'Used' | 'Disabled' — Voucher Status
    - `VoucherType` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher Type
    - `VoucherSubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher Sub Type
    - `Description` string — Voucher Description (Visible on printout)
    - `IsEnabled` boolean — Is voucher enabled
    - `StoreNames` string[] — Store names associated with this voucher
    - `IsAvailableOnAllStores` boolean — True if the voucher is available on all active stores in the app

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Successful authentication, but authorization has been denied for this request.

---

[API](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/revisions/a72c0465da74/schema)