asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
caa561badf960c076b4f564dadbbbb9e36d00a18
medusa-store/www/apps/resources/references/modules/promotion/page.mdx
github-actions[bot] 21f61ec160 chore(docs): Generated References (automated) (#14182) 
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `helper_steps`
- `inventory_next_models`
- `js_sdk`
- `module_events`
- `modules`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values.
> 
> - **Docs Generation**:
>   - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples.
> - **Fulfillment Workflows/Steps**:
>   - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`).
>   - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag.
>   - Refreshed example snippets and sample values.
> - **Notification Step** (`sendNotificationsStep`):
>   - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional.
>   - Output includes `provider_data` and `attachments` fields.
> - **Order Steps/Workflows**:
>   - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions.
>   - Example payloads adjusted (IDs, currencies, amounts).
> - **Meta**:
>   - Updated `<SourceCodeLink>` URLs to new commit hashes throughout.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-12-02 06:59:52 +00:00

87 lines
6.7 KiB
Plaintext
Raw Blame History

import { TypeList } from "docs-ui"
# promotion
## Interfaces
- [AddItemAdjustmentAction](../../promotion/interfaces/promotion.AddItemAdjustmentAction/page.mdx)
- [AddPromotionsToCampaignDTO](../../promotion/interfaces/promotion.AddPromotionsToCampaignDTO/page.mdx)
- [AddShippingMethodAdjustment](../../promotion/interfaces/promotion.AddShippingMethodAdjustment/page.mdx)
- [ApplicationMethodDTO](../../promotion/interfaces/promotion.ApplicationMethodDTO/page.mdx)
- [BaseFilterable](../../promotion/interfaces/promotion.BaseFilterable/page.mdx)
- [CampaignBudgetDTO](../../promotion/interfaces/promotion.CampaignBudgetDTO/page.mdx)
- [CampaignBudgetExceededAction](../../promotion/interfaces/promotion.CampaignBudgetExceededAction/page.mdx)
- [CampaignBudgetUsageDTO](../../promotion/interfaces/promotion.CampaignBudgetUsageDTO/page.mdx)
- [CampaignDTO](../../promotion/interfaces/promotion.CampaignDTO/page.mdx)
- [ComputeActionAdjustmentLine](../../promotion/interfaces/promotion.ComputeActionAdjustmentLine/page.mdx)
- [ComputeActionContext](../../promotion/interfaces/promotion.ComputeActionContext/page.mdx)
- [ComputeActionItemLine](../../promotion/interfaces/promotion.ComputeActionItemLine/page.mdx)
- [ComputeActionShippingLine](../../promotion/interfaces/promotion.ComputeActionShippingLine/page.mdx)
- [Context](../../promotion/interfaces/promotion.Context/page.mdx)
- [CreateApplicationMethodDTO](../../promotion/interfaces/promotion.CreateApplicationMethodDTO/page.mdx)
- [CreateCampaignBudgetDTO](../../promotion/interfaces/promotion.CreateCampaignBudgetDTO/page.mdx)
- [CreateCampaignDTO](../../promotion/interfaces/promotion.CreateCampaignDTO/page.mdx)
- [CreatePromotionDTO](../../promotion/interfaces/promotion.CreatePromotionDTO/page.mdx)
- [CreatePromotionRuleDTO](../../promotion/interfaces/promotion.CreatePromotionRuleDTO/page.mdx)
- [FilterableCampaignProps](../../promotion/interfaces/promotion.FilterableCampaignProps/page.mdx)
- [FilterablePromotionProps](../../promotion/interfaces/promotion.FilterablePromotionProps/page.mdx)
- [FilterablePromotionRuleProps](../../promotion/interfaces/promotion.FilterablePromotionRuleProps/page.mdx)
- [FindConfig](../../promotion/interfaces/promotion.FindConfig/page.mdx)
- [IBigNumber](../../promotion/interfaces/promotion.IBigNumber/page.mdx)
- [IMessageAggregator](../../promotion/interfaces/promotion.IMessageAggregator/page.mdx)
- [IModuleService](../../promotion/interfaces/promotion.IModuleService/page.mdx)
- [IPromotionModuleService](../../promotion/interfaces/promotion.IPromotionModuleService/page.mdx)
- [JoinerServiceConfig](../../promotion/interfaces/promotion.JoinerServiceConfig/page.mdx)
- [JoinerServiceConfigAlias](../../promotion/interfaces/promotion.JoinerServiceConfigAlias/page.mdx)
- [MessageAggregatorFormat](../../promotion/interfaces/promotion.MessageAggregatorFormat/page.mdx)
- [PromotionDTO](../../promotion/interfaces/promotion.PromotionDTO/page.mdx)
- [PromotionLimitExceededAction](../../promotion/interfaces/promotion.PromotionLimitExceededAction/page.mdx)
- [PromotionRuleDTO](../../promotion/interfaces/promotion.PromotionRuleDTO/page.mdx)
- [PromotionRuleValueDTO](../../promotion/interfaces/promotion.PromotionRuleValueDTO/page.mdx)
- [RemoveItemAdjustmentAction](../../promotion/interfaces/promotion.RemoveItemAdjustmentAction/page.mdx)
- [RemovePromotionsFromCampaignDTO](../../promotion/interfaces/promotion.RemovePromotionsFromCampaignDTO/page.mdx)
- [RemoveShippingMethodAdjustment](../../promotion/interfaces/promotion.RemoveShippingMethodAdjustment/page.mdx)
- [RestoreReturn](../../promotion/interfaces/promotion.RestoreReturn/page.mdx)
- [SoftDeleteReturn](../../promotion/interfaces/promotion.SoftDeleteReturn/page.mdx)
- [UpdateApplicationMethodDTO](../../promotion/interfaces/promotion.UpdateApplicationMethodDTO/page.mdx)
- [UpdateCampaignBudgetDTO](../../promotion/interfaces/promotion.UpdateCampaignBudgetDTO/page.mdx)
- [UpdateCampaignDTO](../../promotion/interfaces/promotion.UpdateCampaignDTO/page.mdx)
- [UpdatePromotionDTO](../../promotion/interfaces/promotion.UpdatePromotionDTO/page.mdx)
- [UpdatePromotionRuleDTO](../../promotion/interfaces/promotion.UpdatePromotionRuleDTO/page.mdx)
## Type Aliases
- [ApplicationMethodAllocationValues](../../promotion/types/promotion.ApplicationMethodAllocationValues/page.mdx)
- [ApplicationMethodTargetTypeValues](../../promotion/types/promotion.ApplicationMethodTargetTypeValues/page.mdx)
- [ApplicationMethodTypeValues](../../promotion/types/promotion.ApplicationMethodTypeValues/page.mdx)
- [BigNumberInput](../../promotion/types/promotion.BigNumberInput/page.mdx)
- [BigNumberRawValue](../../promotion/types/promotion.BigNumberRawValue/page.mdx)
- [CampaignBudgetTypeValues](../../promotion/types/promotion.CampaignBudgetTypeValues/page.mdx)
- [CampaignBudgetUsageContext](../../promotion/types/promotion.CampaignBudgetUsageContext/page.mdx)
- [ComputeActions](../../promotion/types/promotion.ComputeActions/page.mdx)
- [Constructor](../../promotion/types/promotion.Constructor/page.mdx)
- [Event](../../promotion/types/promotion.Event/page.mdx)
- [EventMetadata](../../promotion/types/promotion.EventMetadata/page.mdx)
- [ExpandScalar](../../promotion/types/promotion.ExpandScalar/page.mdx)
- [FilterQuery](../../promotion/types/promotion.FilterQuery/page.mdx)
- [FilterQueryProperties](../../promotion/types/promotion.FilterQueryProperties/page.mdx)
- [FilterValue](../../promotion/types/promotion.FilterValue/page.mdx)
- [FilterValue2](../../promotion/types/promotion.FilterValue2/page.mdx)
- [FindConfigOrder](../../promotion/types/promotion.FindConfigOrder/page.mdx)
- [JoinerRelationship](../../promotion/types/promotion.JoinerRelationship/page.mdx)
- [LinkModulesExtraFields](../../promotion/types/promotion.LinkModulesExtraFields/page.mdx)
- [Message](../../promotion/types/promotion.Message/page.mdx)
- [ModuleJoinerConfig](../../promotion/types/promotion.ModuleJoinerConfig/page.mdx)
- [ModuleJoinerRelationship](../../promotion/types/promotion.ModuleJoinerRelationship/page.mdx)
- [OperatorMap](../../promotion/types/promotion.OperatorMap/page.mdx)
- [PrevLimit](../../promotion/types/promotion.PrevLimit/page.mdx)
- [Primary](../../promotion/types/promotion.Primary/page.mdx)
- [PromotionRuleOperatorValues](../../promotion/types/promotion.PromotionRuleOperatorValues/page.mdx)
- [PromotionStatusValues](../../promotion/types/promotion.PromotionStatusValues/page.mdx)
- [PromotionTypeValues](../../promotion/types/promotion.PromotionTypeValues/page.mdx)
- [Query](../../promotion/types/promotion.Query/page.mdx)
- [RawMessageFormat](../../promotion/types/promotion.RawMessageFormat/page.mdx)
- [ReadonlyPrimary](../../promotion/types/promotion.ReadonlyPrimary/page.mdx)
- [Scalar](../../promotion/types/promotion.Scalar/page.mdx)
- [UsageComputedActions](../../promotion/types/promotion.UsageComputedActions/page.mdx)
Reference in New Issue View Git Blame Copy Permalink