github-actions[bot]
2d127a4c67
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>
80 lines
2.1 KiB
Plaintext
80 lines
2.1 KiB
Plaintext
---
|
|
displayed_sidebar: homepage
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# AdminGetDiscountsDiscountRuleParams
|
|
|
|
Filters to apply on discounts' rules.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "allocation",
|
|
"type": "[AllocationType](../../entities/enums/entities.AllocationType.mdx)",
|
|
"description": "Allocation to filter discount rules by.",
|
|
"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": "type",
|
|
"type": "[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)",
|
|
"description": "Type to filter discount rules by.",
|
|
"optional": true,
|
|
"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": []
|
|
}
|
|
]
|
|
}
|
|
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
|