a0fca16570
* feat: Add draft order plugin * version draft order plugin * update readme * chore: Update scripts * Create purple-dolls-cheer.md * port over latest changes * chore: Make package public
87 lines
2.9 KiB
Markdown
87 lines
2.9 KiB
Markdown
<p align="center">
|
|
<a href="https://www.medusajs.com">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/59018053/229103275-b5e482bb-4601-46e6-8142-244f531cebdb.svg">
|
|
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
|
|
<img alt="Medusa logo" src="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
|
|
</picture>
|
|
</a>
|
|
</p>
|
|
<h1 align="center">
|
|
Draft Order Plugin
|
|
</h1>
|
|
|
|
<h4 align="center">
|
|
<a href="https://docs.medusajs.com">Documentation</a> |
|
|
<a href="https://www.medusajs.com">Website</a>
|
|
</h4>
|
|
|
|
<p align="center">
|
|
Create and manage draft orders on behalf of customers in Medusa
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md">
|
|
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
|
|
</a>
|
|
<a href="https://www.producthunt.com/posts/medusa"><img src="https://img.shields.io/badge/Product%20Hunt-%231%20Product%20of%20the%20Day-%23DA552E" alt="Product Hunt"></a>
|
|
<a href="https://discord.gg/xpCwq3Kfn8">
|
|
<img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Discord Chat" />
|
|
</a>
|
|
<a href="https://twitter.com/intent/follow?screen_name=medusajs">
|
|
<img src="https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs" alt="Follow @medusajs" />
|
|
</a>
|
|
</p>
|
|
|
|
## Overview
|
|
|
|
The Draft Order Plugin enables admin users to create and manage orders on behalf of customers. This is particularly useful for customer support scenarios or when customers place orders offline.
|
|
|
|
## Features
|
|
|
|
- **Create draft orders** from the Medusa Admin dashboard
|
|
- **Manage items** in draft orders (add, update, remove)
|
|
- **Add shipping methods** to draft orders
|
|
- **Associate customers** with draft orders
|
|
- **Convert draft orders** to regular orders for purchase completion
|
|
|
|
|
|
## Installation
|
|
|
|
1. Install the Draft Order plugin
|
|
```
|
|
yarn add @medusajs/draft-order
|
|
```
|
|
2. Configure the plugin in your medusa-config.ts
|
|
```
|
|
module.exports = defineConfig({
|
|
projectConfig: {
|
|
...
|
|
},
|
|
plugins: [
|
|
{
|
|
resolve: "@medusajs/draft-order",
|
|
options: {},
|
|
},
|
|
],
|
|
})
|
|
```
|
|
3. Start your server
|
|
|
|
## Requirements
|
|
- Medusa application version >= 2.4.0
|
|
|
|
## Support
|
|
|
|
## Community & Contributions
|
|
|
|
The community and core team are available in [GitHub Discussions](https://github.com/medusajs/medusa/discussions), where you can ask for support, discuss roadmap, and share ideas.
|
|
|
|
Join our [Discord server](https://discord.com/invite/medusajs) to meet other community members.
|
|
|
|
## Other channels
|
|
|
|
- [GitHub Issues](https://github.com/medusajs/medusa/issues)
|
|
- [Twitter](https://twitter.com/medusajs)
|
|
- [LinkedIn](https://www.linkedin.com/company/medusajs)
|
|
- [Medusa Blog](https://medusajs.com/blog/)
|