VolumeBasedPromotion

Type: schema

TypeScript Definition

VolumeBasedPromotion: {{
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            promotion_type: "volume-based";
            slabs: {
                /** @description The minimum quantity required to qualify for the discount. */
                quantity_limit: number;
                /** @description The percentage discount applied when the quantity limit is reached. */
                readonly discount_percent: number;
            }[];
        };
        /** VolumeBasedRule */
}

OpenAPI Schema

{
  "title": "VolumeBasedPromotion",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/VolumeBasedPromotion",
    "description": "API reference for the VolumeBasedPromotion schema"
  },
  "required": [
    "promotion_type",
    "slabs"
  ],
  "properties": {
    "promotion_type": {
      "type": "string",
      "enum": [
        "discount",
        "volume-based",
        "fixed-price",
        "free-goods"
      ],
      "const": "volume-based",
      "readOnly": true
    },
    "slabs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "quantity_limit": {
            "description": "The minimum quantity required to qualify for the discount.",
            "type": "integer"
          },
          "discount_percent": {
            "description": "The percentage discount applied when the quantity limit is reached.",
            "type": "number",
            "readOnly": true
          }
        },
        "required": [
          "quantity_limit",
          "discount_percent"
        ]
      }
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions