CouponPromotionCommonDetail

Type: schema

TypeScript Definition

CouponPromotionCommonDetail: {{
            readonly id: string;
            name: string;
            description: string | null;
            tags: string[] | null;
            redemption_limits: {
                total_redemptions: number | null;
                per_customer_redemptions: number | null;
                per_coupon_code_redemptions: number | null;
            } | null;
            readonly redemption_count: number;
            /** @default 0 */
            minimum_order_total: number | null;
            /** Format: date-time */
            starts_at: string;
            /** Format: date-time */
            expires_at: string | null;
        };
        /** @enum {unknown} */
}

OpenAPI Schema

{
  "title": "CouponPromotionCommonDetail",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CouponPromotionCommonDetail",
    "description": "API reference for the CouponPromotionCommonDetail schema"
  },
  "required": [
    "id",
    "name",
    "description",
    "tags",
    "redemption_limits",
    "redemption_count",
    "minimum_order_total",
    "starts_at",
    "expires_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "tags": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "redemption_limits": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "total_redemptions": {
          "type": [
            "integer",
            "null"
          ]
        },
        "per_customer_redemptions": {
          "type": [
            "integer",
            "null"
          ]
        },
        "per_coupon_code_redemptions": {
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "total_redemptions",
        "per_customer_redemptions",
        "per_coupon_code_redemptions"
      ]
    },
    "redemption_count": {
      "type": "integer",
      "readOnly": true
    },
    "minimum_order_total": {
      "type": [
        "integer",
        "null"
      ],
      "default": 0
    },
    "starts_at": {
      "type": "string",
      "format": "date-time"
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions