docs: edits and fixes to commerce module docs (#7468)

Apply edits and fixes to the commerce modules docs
2024-05-29 11:08:06 +00:00
parent 130de74d6d
commit 2c5ba408d4
160 changed files with 6400 additions and 3790 deletions
@@ -0,0 +1,26 @@
+export const metadata = {
+  title: `Campaign`,
+}
+
+# {metadata.title}
+
+In this document, you'll learn about campaigns.
+
+## What is a Campaign?
+
+A [Campaign](/references/promotion/models/Campaign) combines promotions under the same conditions, such as start and end dates.
+
+![A diagram showcasing the relation between the Campaign and Promotion data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899225/Medusa%20Resources/campagin-promotion_hh3qsi.jpg)
+
+---
+
+## Campaign Limits
+
+Each campaign has a budget represented by the [CampaignBudget data model](/references/promotion/models/CampaignBudget). The budget limits how many times the promotion can be used.
+
+There are two types of budgets:
+
+- `spend`: An amount that, when crossed, the promotion becomes unusable. For example, if the amount limit is set to `$100`, and the total amount of usage of this promotion crosses that threshold, the promotion can no longer be applied.
+- `usage`: The number of times that a promotion can be used. For example, if the usage limit is set to `10`, the promotion can be used only 10 times by customers. After that, it can no longer be applied.
+
+![A diagram showcasing the relation between the Campaign and CampaignBudget data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899463/Medusa%20Resources/campagin-budget_rvqlmi.jpg)