PercentageDiscountRule

Type: schema

TypeScript Definition

PercentageDiscountRule: {{
            /** @constant */
            discount_type: "percentage";
            discount_percent: number;
            maximum_discount_amount: number | null;
            products: {
                product_id: string | null;
                variant_id: string | null;
                minimum_quantity: number | null;
                maximum_quantity: number | null;
                minimum_value: number | null;
                maximum_value: number | null;
            }[];
            /** @description Array of category ids */
            category_id: string[];
        };
        /**
         * Pincode
         * @description Pincode model
         */
}

OpenAPI Schema

{
  "title": "PercentageDiscountRule",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PercentageDiscountRule",
    "description": "API reference for the PercentageDiscountRule schema"
  },
  "required": [
    "discount_type",
    "discount_percent",
    "maximum_discount_amount",
    "products",
    "category_id"
  ],
  "properties": {
    "discount_type": {
      "type": "string",
      "const": "percentage"
    },
    "discount_percent": {
      "type": "number"
    },
    "maximum_discount_amount": {
      "type": [
        "number",
        "null"
      ]
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product_id",
          "variant_id",
          "minimum_quantity",
          "maximum_quantity",
          "minimum_value",
          "maximum_value"
        ],
        "properties": {
          "product_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "variant_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "minimum_quantity": {
            "type": [
              "integer",
              "null"
            ]
          },
          "maximum_quantity": {
            "type": [
              "integer",
              "null"
            ]
          },
          "minimum_value": {
            "type": [
              "number",
              "null"
            ]
          },
          "maximum_value": {
            "type": [
              "number",
              "null"
            ]
          }
        }
      }
    },
    "category_id": {
      "description": "Array of category ids",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions