---
title: "Voucher codes report"
method: GET
path: "/shop/reports/voucher-codes"
tags: ["Reports"]
---

# Voucher codes report

`GET /shop/reports/voucher-codes`

A paginated list of voucher codes issued at the given site, with filtering by status,
code, face amount, balance, expiry date and creation date. Money values are integers in
minor units. For large exports, use
[`/shop/reports/voucher-codes/queue`](/endpoints/Reports#queueVoucherCodesExport).

## Query parameters

- `site_id` string, uuid, required
- `page` integer
- `per_page` integer
- `code` string
- `status` string[]
- `amount` string
- `balance` string
- `voucher_type_id` string[]
- `fulfillment_status` string
- `created_since` string, date-time
- `expired_range_from` string, date
- `expired_range_to` string, date

## Response `200`

The voucher codes were successfully retrieved.

- VoucherCodesResponse
  - `data` VoucherCodeListItem[], required
    - `id` string, object-id, required
    - `code` string, required
    - `status` string, required
    - `valid_from_date` string, date-time, nullable
    - `valid_to_date` string, date-time, nullable
    - `amount_type` string, required — How the voucher's face value should be interpreted (e.g. `currency` or `monetary`).
    - `amount` integer, required — The face value of the voucher in minor units.
    - `balance` integer, required — The remaining balance on the voucher in minor units.
    - `currency` string, required
    - `value` integer — Alias of `amount` retained for backwards compatibility.
    - `partially_redeemable` boolean
    - `imported` boolean — Whether the voucher was bulk-imported rather than purchased through Trybe.
    - `fulfillment_status` string, nullable
    - `voucher_type` object, required
      - `id` string, object-id, required
      - `name` string, required
    - `recipient` object — Recipient information collected at purchase.
    - `delivery` object — Delivery method, option, and target date for the voucher.
    - `order` object — A short summary of the order this voucher was purchased on.
    - `redemptions` object[] — When requested with `?include=redemptions`, an array of payments that have been settled against this code.
      - `payment_id` string, object-id, required
      - `amount` integer
      - `refunded_amount` integer
      - `paid_at` string, date-time, nullable
      - `payable_id` string, object-id
      - `order_ref` string
    - `created_at` string, date-time
    - `issued_at` string, date-time, nullable
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `400` — The request failed.

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)