a74c900ab1
* docs: add documentation for migration generate cli tool * changed migrations details in marketplace recipe * added generated oas files to action * vale + lint fixes * don't import from src in medusa-config.js * fix generate command in recipe * fix module name
146 lines
3.5 KiB
Plaintext
146 lines
3.5 KiB
Plaintext
import { CodeTabs, CodeTab } from "docs-ui"
|
|
|
|
export const metadata = {
|
|
title: `Order Module`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
The Order Module is the `@medusajs/order` NPM package that provides order-related features in your Medusa and Node.js applications.
|
|
|
|
## Features
|
|
|
|
### Order Management
|
|
|
|
Store and manage your orders to retriev, create, cancel, and perform other operations.
|
|
|
|
```ts
|
|
const order = await orderModuleService.createOrders({
|
|
currency_code: "usd",
|
|
items: [
|
|
{
|
|
title: "Shirt",
|
|
quantity: 1,
|
|
unit_price: 3000,
|
|
},
|
|
],
|
|
shipping_methods: [
|
|
{
|
|
name: "Express shipping",
|
|
amount: 3000,
|
|
},
|
|
],
|
|
})
|
|
```
|
|
|
|
### Draft Orders
|
|
|
|
Allow merchants to create orders on behalf of their customers as draft orders that later are transformed to regular orders.
|
|
|
|
```ts
|
|
const draftOrder = await orderModuleService.createOrders({
|
|
currency_code: "usd",
|
|
// other details...
|
|
status: "draft",
|
|
})
|
|
```
|
|
|
|
### Apply Promotions
|
|
|
|
Apply promotions or discounts to the order's items and shipping methods by adding adjustment lines that are factored into their subtotals.
|
|
|
|
```ts
|
|
const lineAdjustments = await orderModuleService.addLineItemAdjustments({
|
|
item_id: "cali_123",
|
|
code: "50OFF",
|
|
amount: 500,
|
|
})
|
|
|
|
const shippingAdjustments =
|
|
await orderModuleService.addShippingMethodAdjustments({
|
|
shipping_method_id: "casm_123",
|
|
code: "FREESHIPPING",
|
|
amount: 1000,
|
|
})
|
|
```
|
|
|
|
### Returns, Exchanges, and Claims
|
|
|
|
Return or exchange items, with version-based control over the order's timeline.
|
|
|
|
```ts
|
|
const orderReturn = await orderModuleService.createReturn({
|
|
order_id: "order_123",
|
|
items: [{
|
|
id: "orditem_123",
|
|
quantity: 1,
|
|
}],
|
|
})
|
|
```
|
|
|
|
---
|
|
|
|
## How to Use Order Module's Service
|
|
|
|
You can use the Order Module's main service by resolving from the Medusa container the resource `ModuleRegistrationName.ORDER` imported from `@medusajs/modules-sdk`.
|
|
|
|
For example:
|
|
|
|
<CodeTabs groupId="resource-type">
|
|
<CodeTab label="API Route" value="api-route">
|
|
|
|
```ts title="src/api/store/custom/route.ts"
|
|
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
|
|
import { IOrderModuleService } from "@medusajs/types"
|
|
import { ModuleRegistrationName } from "@medusajs/utils"
|
|
|
|
export async function GET(
|
|
req: MedusaRequest,
|
|
res: MedusaResponse
|
|
): Promise<void> {
|
|
const orderModuleService: IOrderModuleService = req.scope.resolve(
|
|
ModuleRegistrationName.ORDER
|
|
)
|
|
|
|
res.json({
|
|
orders: await orderModuleService.listOrders(),
|
|
})
|
|
}
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="Subscriber" value="subscribers">
|
|
|
|
```ts title="src/subscribers/custom-handler.ts"
|
|
import { SubscriberArgs } from "@medusajs/medusa"
|
|
import { IOrderModuleService } from "@medusajs/types"
|
|
import { ModuleRegistrationName } from "@medusajs/utils"
|
|
|
|
export default async function subscriberHandler({ container }: SubscriberArgs) {
|
|
const orderModuleService: IOrderModuleService = container.resolve(
|
|
ModuleRegistrationName.ORDER
|
|
)
|
|
|
|
const orders = await orderModuleService.listOrders()
|
|
}
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="Workflow Step" value="workflow-step">
|
|
|
|
```ts title="src/workflows/hello-world/step1.ts"
|
|
import { createStep } from "@medusajs/workflows-sdk"
|
|
import { IOrderModuleService } from "@medusajs/types"
|
|
import { ModuleRegistrationName } from "@medusajs/utils"
|
|
|
|
const step1 = createStep("step-1", async (_, { container }) => {
|
|
const orderModuleService: IOrderModuleService = container.resolve(
|
|
ModuleRegistrationName.ORDER
|
|
)
|
|
const orders = await orderModuleService.listOrders()
|
|
})
|
|
```
|
|
|
|
</CodeTab>
|
|
</CodeTabs>
|