docs: added cloud plugins documentation (#12765)

* docs: added cloud plugins documentation

* fixes
This commit is contained in:
Shahed Nasser
2025-06-18 12:30:41 +03:00
committed by GitHub
parent 863861e307
commit 4c0ae51a59
5 changed files with 121 additions and 1 deletions
@@ -0,0 +1,37 @@
export const metadata = {
title: `Draft Order Plugin`,
}
# {metadata.title}
In this guide, you'll learn about the Draft Order Plugin add-on available to Cloud users.
## What is the Draft Order Plugin?
Draft orders allow admin users to create orders on behalf of customers. They are useful for customer support or when customers place orders offline.
When you sign up for Cloud, you can access the Draft Order plugin in your deployed Medusa applications.
The Draft Order Plugin is an add-on to your Cloud projects that provides draft order features in the Medusa Admin dashboard.
---
## Draft Order Plugin Features
The Draft Order Plugin provides the following features:
- Create draft orders from the Medusa Admin dashboard.
- Manage items in draft orders, including adding, updating, and removing items.
- Add shipping methods to draft orders.
- Associate the draft order with a customer in your store.
- Convert the draft order to a regular order to complete the purchase.
![A screenshot of the draft order management interface in the Medusa Admin dashboard](https://res.cloudinary.com/dza7lstvk/image/upload/v1750235297/Cloud/CleanShot_2025-06-18_at_11.27.36_2x_e6mf4v.png)
---
## How to Install the Draft Order Plugin
The Draft Order Plugin is currently only available for Cloud users. If you're not a Cloud user, [learn how to get started](../page.mdx#sign-up-for-cloud).
Then, you can [contact support](#) for assistance in installing the Draft Order Plugin in your deployed Medusa application.
@@ -0,0 +1,39 @@
export const metadata = {
title: `Loyalty Plugin`,
}
# {metadata.title}
In this guide, you'll learn about the loyalty plugin add-on available to Cloud users.
## What is the Loyalty Plugin?
Loyalty features are essential for ecommerce applications. They help businesses retain customers and encourage repeat purchases.
When you sign up for Cloud, you can access the Loyalty Plugin in your deployed Medusa applications.
The Loyalty Plugin is an add-on to your Cloud projects. It adds modules, API routes, workflows, and admin customizations that provide loyalty-related features to your Medusa application.
---
## Loyalty Plugin Features
The Loyalty Plugin provides the following features:
- **Gift Cards**:
- Admins can manage gift cards as products.
- Customers can purchase gift cards in the store.
- Customers can redeem and use gift cards during checkout.
- **Store Credits**:
- Admins can manage store credits for customers.
- Customers can earn store credits through gift cards or refunds.
![A screenshot of a gift card's details in the Medusa Admin dashboard](https://res.cloudinary.com/dza7lstvk/image/upload/v1750235297/Cloud/CleanShot_2025-06-18_at_11.27.44_2x_zwrily.png)
---
## How to Install the Loyalty Plugin
The Loyalty Plugin is currently only available for Cloud users. If you're not a Cloud user, [learn how to get started](../page.mdx#sign-up-for-cloud).
Then, you can [contact support](#) for assistance in installing the Loyalty Plugin in your deployed Medusa application.
+3 -1
View File
@@ -8,5 +8,7 @@ export const generatedEditDates = {
"app/notifications/page.mdx": "2025-06-17T12:29:18.819Z",
"app/database/page.mdx": "2025-06-17T14:34:57.104Z",
"app/redis/page.mdx": "2025-06-18T06:50:30.705Z",
"app/s3/page.mdx": "2025-06-18T07:16:14.453Z"
"app/s3/page.mdx": "2025-06-18T07:16:14.453Z",
"app/draft-order-plugin/page.mdx": "2025-06-18T08:32:21.263Z",
"app/loyalty-plugin/page.mdx": "2025-06-18T08:28:51.756Z"
}
+25
View File
@@ -88,6 +88,31 @@ export const generatedSidebars = [
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Plugins",
"initialOpen": true,
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Loyalty",
"path": "/loyalty-plugin",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Draft Orders",
"path": "/draft-order-plugin",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
+17
View File
@@ -61,6 +61,23 @@ export const sidebar = [
},
],
},
{
type: "category",
title: "Plugins",
initialOpen: true,
children: [
{
type: "link",
title: "Loyalty",
path: "/loyalty-plugin",
},
{
type: "link",
title: "Draft Orders",
path: "/draft-order-plugin",
},
],
},
{
type: "category",
title: "Monitoring & Support",