medusa-store/www/apps/docs/content/references/medusa/classes/medusa.AdminPostDiscountsDiscountRule.mdx

---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AdminPostDiscountsDiscountRule

Details of the discount rule to create.

## Properties

<ParameterTypes parameters={[
  {
    "name": "allocation",
    "type": "[AllocationType](../../entities/enums/entities.AllocationType.mdx)",
    "description": "The discount rule's allocation.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "ITEM",
        "type": "`\"item\"`",
        "description": "The discount should be applied to applicable items in the cart.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "TOTAL",
        "type": "`\"total\"`",
        "description": "The discount should be applied to the checkout total.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "conditions",
    "type": "[AdminCreateCondition](medusa.AdminCreateCondition.mdx)[]",
    "description": "The discount rule's conditions.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "customer_groups",
        "type": "`string`[]",
        "description": "The customer groups associated with the discount condition, if the discount condition's type is `customer_groups`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "operator",
        "type": "[DiscountConditionOperator](../../entities/enums/entities.DiscountConditionOperator.mdx)",
        "description": "The operator of the discount condition.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "product_collections",
        "type": "`string`[]",
        "description": "The product collections associated with the discount condition, if the discount condition's type is `product_collections`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "product_tags",
        "type": "`string`[]",
        "description": "The product tags associated with the discount condition, if the discount condition's type is `product_tags`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "product_types",
        "type": "`string`[]",
        "description": "The product types associated with the discount condition, if the discount condition's type is `product_types`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "products",
        "type": "`string`[]",
        "description": "The products associated with the discount condition, if the discount condition's type is `products`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "description",
    "type": "`string`",
    "description": "The discount rule's description.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "type",
    "type": "[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)",
    "description": "The discount rule's type.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "FIXED",
        "type": "`\"fixed\"`",
        "description": "Discounts that reduce the price by a fixed amount.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "FREE_SHIPPING",
        "type": "`\"free_shipping\"`",
        "description": "Discounts that sets the shipping price to `0`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "PERCENTAGE",
        "type": "`\"percentage\"`",
        "description": "Discounts that reduce the price by a percentage reduction.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "value",
    "type": "`number`",
    "description": "The discount rule's value.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>