Get Coupon Sets

Returns a paged collection of CouponSets

GET /commerce/catalog/admin/couponsets

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "name": "<string>",
      "assignedDiscountCount": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "canBeDeleted": true,
      "couponCodeCount": 123,
      "couponCodeType": "<string>",
      "couponSetCode": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "id": 123,
      "maxRedemptionsPerCouponCode": 123,
      "maxRedemptionsPerUser": 123,
      "redemptionCount": 123,
      "setSize": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "status": "<string>"
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

pageSize · integer<int32> · default: 0

sortBy · string

filter · string

includeCounts · boolean · default: false

Include coupon and redemption counts

responseGroups · string

"counts" returns discount and couponCode counts

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

Paged collection of Mozu.ProductAdmin.Contracts.CouponSet

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>