Files
medusa-store/www/apps/docs/content/references/medusa/classes/medusa.AdminUpdateDiscountRule.mdx
github-actions[bot] 2d127a4c67 chore(docs): Generated References (#5881)
Generated the following references:
- `EventBusTypes`
- `IPricingModuleService`
- `ModulesSdkTypes`
- `PriceListWorkflow`
- `fulfillment`
- `js_client`
- `medusa`
- `modules`
- `pricing`
- `services`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-12-14 18:28:23 +00:00

143 lines
4.0 KiB
Plaintext

---
displayed_sidebar: homepage
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminUpdateDiscountRule
The attributes of the discount rule to update.
## Properties
<ParameterTypes parameters={[
{
"name": "allocation",
"type": "[AllocationType](../../entities/enums/entities.AllocationType.mdx)",
"description": "The discount rule's allocation.",
"optional": true,
"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": "[AdminUpsertCondition](medusa.AdminUpsertCondition.mdx)[]",
"description": "The discount rule's discount 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": "id",
"type": "`string`",
"description": "The discount condition's ID.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "operator",
"type": "[DiscountConditionOperator](../../entities/enums/entities.DiscountConditionOperator.mdx)",
"description": "The discount condition's operator.",
"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": "id",
"type": "`string`",
"description": "The discount rule's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`number`",
"description": "The discount rule's value.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>