Skip to content

FixedPriceRuleBasedAmount

Type: schema

TypeScript Definition

typescript
FixedPriceRuleBasedAmount: {{
            /** @constant */
            spending_criteria_type: "minimum-purchase-amount";
            products: {
                product_id: string | null;
                variant_id: string | null;
                minimum_purchase_amount: number;
                /** @description null means there is no limit. */
                maximum_purchase_amount: number | null;
                offer_price: number;
            }[];
        };
        /** FixedPriceRuleBasedQuantity */
}

OpenAPI Schema

json
{
  "title": "FixedPriceRuleBasedAmount",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/FixedPriceRuleBasedAmount",
    "description": "API reference for the FixedPriceRuleBasedAmount schema"
  },
  "required": [
    "spending_criteria_type",
    "products"
  ],
  "properties": {
    "spending_criteria_type": {
      "type": "string",
      "const": "minimum-purchase-amount"
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product_id",
          "variant_id",
          "minimum_purchase_amount",
          "maximum_purchase_amount",
          "offer_price"
        ],
        "properties": {
          "product_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "variant_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "minimum_purchase_amount": {
            "type": "number"
          },
          "maximum_purchase_amount": {
            "description": "null means there is no limit.",
            "type": [
              "number",
              "null"
            ]
          },
          "offer_price": {
            "type": "number"
          }
        }
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: