---
title: "Get Coupon Sets"
method: GET
path: "/commerce/catalog/admin/couponsets"
tags: ["CouponSets"]
---

# Get Coupon Sets

`GET /commerce/catalog/admin/couponsets`

Returns a paged collection of CouponSets

## Query parameters

- `startIndex` integer
- `pageSize` integer
- `sortBy` string
- `filter` string
- `includeCounts` boolean
- `responseGroups` string
- `responseFields` string

## Response `200`

OK

- CouponSetCollection — Paged collection of Mozu.ProductAdmin.Contracts.CouponSet
  - `items` CouponSet[], nullable
    - `assignedDiscountCount` integer, nullable — ReadOnly sum of all redemptions for this coupon. Use "counts" response group.
    - `auditInfo` AdminUserAuditInfo
      - `createBy` string, nullable
      - `createDate` string, date-time, nullable
      - `updateBy` string, nullable
      - `updateDate` string, date-time, nullable
    - `canBeDeleted` boolean — Signifies that the coupon has not been exported and can be updated ReadOnly
    - `couponCodeCount` integer, nullable — Count of associated couponCodes. Must use "counts" response group to get this value ReadOnly
    - `couponCodeType` string, nullable — Determines if the coupon is a persisted list of codes (static) or a list based on generated specification (dynamic).
    - `couponSetCode` string, nullable — Unique tenant supplied identifier. Used as the prefix for generated sets. Required System generated if left null.
    - `endDate` string, date-time, nullable — Date and time that the coupon codes becomes expired
    - `id` integer, nullable — Internal unique identifier of the couponset. System-supplied and read-only.
    - `maxRedemptionsPerCouponCode` integer, nullable — Maximum number of times any code can de used. Must be null or >= 1 (0 is invalid). Defaults to 1 on creation if null.
    - `maxRedemptionsPerUser` integer, nullable — Maximum number of times any single user can redeem any code. Must be null or >= 1 (0 is invalid). Defaults to 1 on creation only when legacy tenant behavior is enabled; otherwise null is preserved.
    - `name` string, required — CouponSet Name
    - `redemptionCount` integer, nullable — ReadOnly count of all redemptions for this coupon set.
    - `setSize` integer, nullable — Sets the number of codes to generate for dynamic coupons Required when CouponCodeType is "Dynamic"
    - `startDate` string, date-time, nullable — Date and time that the coupon codes becomes active
    - `status` string, nullable — CouponSet status which can be: Active, Expired, Inactive System-supplied and read-only.
  - `pageCount` integer
  - `pageSize` integer
  - `startIndex` integer
  - `totalCount` integer

---

[API](https://skmtc.net/kibocommerce/apis/customer.md) · [All operations](https://skmtc.net/kibocommerce/apis/customer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kibocommerce/customer/versions/47c0cf7b75ab/schema)