Skip to content

TieredDiscountRule ​

Type: schema

TypeScript Definition ​

typescript
TieredDiscountRule: {{
            slabs: components["schemas"]["TieredDiscountSlab"][];
            /** @description Caps the discount across all slabs. Use `null` for no cap. */
            maximum_discount_amount: number | null;
            /** @description Marketplace seller ids the tiered discount applies to. Required (at least one) when `applies_to_product` is `seller`, and accepted only on marketplace stores; empty or omitted otherwise. */
            sellers?: string[];
        };
        /** TieredDiscountSlab */
}

Component References ​

ReferenceResolves To
components["schemas"]["TieredDiscountSlab"]TieredDiscountSlab

OpenAPI Schema ​

json
{
  "title": "TieredDiscountRule",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/TieredDiscountRule",
    "description": "API reference for the TieredDiscountRule schema"
  },
  "required": [
    "slabs",
    "maximum_discount_amount"
  ],
  "properties": {
    "slabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TieredDiscountSlab"
      }
    },
    "maximum_discount_amount": {
      "description": "Caps the discount across all slabs. Use `null` for no cap.",
      "type": [
        "number",
        "null"
      ]
    },
    "sellers": {
      "description": "Marketplace seller ids the tiered discount applies to. Required (at least one) when `applies_to_product` is `seller`, and accepted only on marketplace stores; empty or omitted otherwise.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: