docs: generate references manually for v2.1.2 (#10639)
* docs: manually generate references for v2.1.2 * more changes
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
ee62083c52
commit
0f5d640736
196 files changed
+267336
-200539
No files matched your search
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/ApplicationMethod
|
||||
sidebar_label: ApplicationMethod
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ApplicationMethod - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the ApplicationMethod . This belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_value","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"[Promotion](../promotion_models.Promotion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotions","type":"Collection<[Promotion](../promotion_models.Promotion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `\"budget\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_value","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues](../../.Line truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/Campaign
|
||||
sidebar_label: Campaign
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Campaign - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Campaign . This belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"promotions","type":"Collection<[Promotion](../promotion_models.Promotion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `\"budget\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_limit","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"used","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_used","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection<[Promotion](../promotion_models.Promotion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`Line truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/CampaignBudget
|
||||
sidebar_label: CampaignBudget
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CampaignBudget - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the CampaignBudget . This belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_limit","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"used","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_used","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection<[Promotion](../promotion_models.Promotion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Collection<[PromotionRule](../promotion_models.PromotionRule/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,Line truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/Promotion
|
||||
sidebar_label: Promotion
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Promotion - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Promotion . This belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"budget","type":"`null` \\| [CampaignBudget](../promotion_models.CampaignBudget/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[CampaignBudgetTypeValues](../../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"limit","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"raw_limit","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"used","type":"`number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"raw_used","type":"[BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection<[Promotion](page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Collection<[PromotionRule](../promotion_models.PromotionRule/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"",Line truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/PromotionRule
|
||||
sidebar_label: PromotionRule
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PromotionRule - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PromotionRule . This belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"[PromotionRule](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"Collection<[Promotion](../promotion_models.Promotion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method_target_rules","type":"Collection<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"method_buy_rules","type":"Collection<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `OptionalRelations`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection<[Promotion](../promotion_models.Promotion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"ends_at","type":"`nLine truncated
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/PromotionRuleValue
|
||||
sidebar_label: PromotionRuleValue
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PromotionRuleValue - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PromotionRuleValue . This belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"[PromotionRule](../promotion_models.PromotionRule/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"attribute","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[PromotionRuleOperatorValues](../../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"Collection<[PromotionRuleValue](page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"[PromotionRule](../promotion_models.PromotionRule/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]}]},{"name":"promotions","type":"Collection<[Promotion](../promotion_models.Promotion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"campaign","type":"`null` \\| [Campaign](../promotion_models.Campaign/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"[PromotionTypeValues](../../../promotion/types/promotion.PromotionTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Collection<[PromotionRule](../promotion_models.PromotionRule/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`OptionalFields` \\| `OptionalRelations`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"method_target_rules","type":"Collection<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`null` \\| `number` \\| `BigNumber`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_value","type":"`null` \\| [BigNumberRawValue](../../../types/types/types.BigNumberRawValue/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"type","type":"[ApplicationMethodTypeValues](../../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"[ApplicationMethodTargetTypeValues]Line truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/ApplicationMethod
|
||||
sidebar_label: ApplicationMethod
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ApplicationMethod - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the ApplicationMethod data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping\\_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"BelongsTo<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotion.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextPropeLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/Campaign
|
||||
sidebar_label: Campaign
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Campaign - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Campaign data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date that the campaign starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date that the campaign ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"HasOne<[CampaignBudget](../promotion_models.CLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/CampaignBudget
|
||||
sidebar_label: CampaignBudget
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CampaignBudget - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the CampaignBudget data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [CampaignBudgetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx)>","description":"The type of the campaign budget","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usage`, it holds the number of times the campaign's promotions have been used so far.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date that the campaign starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date that the campaign ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"HasOne<[CampaignBudget](page.mdx)>","description":"The associated budget.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [CampaignBudgetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx)>","description":"The type of the campaign budget","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usage`, it holds the number of times the campaign's promotions have been used so far.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the camLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/Promotion
|
||||
sidebar_label: Promotion
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Promotion - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the Promotion data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children"Line truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/PromotionRule
|
||||
sidebar_label: PromotionRule
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PromotionRule - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PromotionRule data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The opeLine truncated
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: promotionModelReference
|
||||
slug: /references/promotion/models/PromotionRuleValue
|
||||
sidebar_label: PromotionRuleValue
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# PromotionRuleValue - Promotion Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the PromotionRuleValue data model. It belongs to the Promotion Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping\\_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.","optional":false,"defaultValue":"","Line truncated
|
||||
Reference in new issue
Block a user