getcoupons

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/getcoupons",
  "title": "getcoupons",
  "description": "List of coupons.",
  "type": "object",
  "properties": {
    "items": {
      "title": "items",
      "description": "Array of objects.",
      "type": "array",
      "items": {
        "description": "Object containing each coupon batch and its configuration information.",
        "type": "object",
        "properties": {
          "grouping": {
            "title": "grouping",
            "description": "Coupon batch.",
            "type": "object",
            "properties": {
              "key": {
                "title": "key",
                "description": "Coupon grouping key, which is the prefix for the coupon batch's generated codes.",
                "type": "string"
              },
              "amount": {
                "title": "amount",
                "description": "Amount of codes in the coupon batch.",
                "type": "number"
              }
            }
          },
          "configuration": {
            "title": "configuration",
            "description": "Object containing the coupon's properties.",
            "type": "object",
            "properties": {
              "lastModifiedUtc": {
                "title": "lastModifiedUtc",
                "description": "Date when the coupon was modified for the last time, in the UTC format.",
                "type": "string"
              },
              "utmSource": {
                "title": "utmSource",
                "description": "UTM source related to the coupon, which indicates the source of the traffic, that is, from which site, advertiser, or publication the user came from.",
                "type": "string"
              },
              "utmCampaign": {
                "title": "utmCampaign",
                "description": "UTM campaign related to the coupon, which indicates the campaign that defines a particular marketing context.",
                "type": "string"
              },
              "couponCode": {
                "title": "couponCode",
                "description": "Single coupon code.",
                "type": "string"
              },
              "isArchived": {
                "title": "isArchived",
                "description": "Determines whether the coupon is archived (`true`) or not (`false`).",
                "type": "boolean"
              },
              "maxItemsPerClient": {
                "title": "maxItemsPerClient",
                "description": "This option is non-editable and visible only for existing coupons configured with this limitation in previous versions of Coupons. When enabled, it determines the maximum amount of products to which the coupon can be applied. The defined quantity is valid for one or more purchases by the same customer.",
                "type": "number"
              },
              "expirationIntervalPerUse": {
                "title": "expirationIntervalPerUse",
                "description": "This option is non-editable and visible only for existing coupons configured with this limitation in previous versions of the Coupons module. When enabled, it determines how many days after purchase the coupon will be available for use again.",
                "type": "string"
              },
              "maxUsage": {
                "title": "maxUsage",
                "description": "The maximum number of times the coupon can be used, if the coupon has limited usage.",
                "type": "number"
              },
              "groupingKey": {
                "title": "groupingKey",
                "description": "Coupon grouping key, which is the prefix for the coupon batch's generated codes.",
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}