Skip to content

VolumeBasedRule

Type: schema

TypeScript Definition

typescript
VolumeBasedRule: {{
            products: {
                product_id: string | null;
                variant_id: string | null;
                slabs: {
                    quantity: number;
                    /** @enum {unknown} */
                    condition: "less-or-equal" | "greater";
                    discount_percent: number;
                }[];
            }[];
            maximum_discount_amount: number | null;
        };
        /** WalletPayment */
}

OpenAPI Schema

json
{
  "title": "VolumeBasedRule",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/VolumeBasedRule",
    "description": "API reference for the VolumeBasedRule schema"
  },
  "required": [
    "products",
    "maximum_discount_amount"
  ],
  "properties": {
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product_id",
          "variant_id",
          "slabs"
        ],
        "properties": {
          "product_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "variant_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "slabs": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "quantity",
                "condition",
                "discount_percent"
              ],
              "properties": {
                "quantity": {
                  "type": "integer"
                },
                "condition": {
                  "enum": [
                    "less-or-equal",
                    "greater"
                  ]
                },
                "discount_percent": {
                  "type": "number"
                }
              }
            }
          }
        }
      }
    },
    "maximum_discount_amount": {
      "type": [
        "number",
        "null"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: