166 lines
4.5 KiB
Plaintext
166 lines
4.5 KiB
Plaintext
import { CodeTabs, CodeTab } from "docs-ui"
|
|
|
|
export const metadata = {
|
|
title: `Store Module`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
In this section of the documentation, you will find resources to learn more about the Store Module and how to use it in your application.
|
|
|
|
<Note title="Looking for no-code docs?">
|
|
|
|
Refer to the [Medusa Admin User Guide](!user-guide!/settings/store) to learn how to manage your store using the dashboard.
|
|
|
|
</Note>
|
|
|
|
Medusa has store related features available out-of-the-box through the Store Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Store Module.
|
|
|
|
<Note>
|
|
|
|
Learn more about why modules are isolated in [this documentation](!docs!/learn/fundamentals/modules/isolation).
|
|
|
|
</Note>
|
|
|
|
## Store Features
|
|
|
|
- [Store Management](/references/store/models/Store): Create and manage stores in your application.
|
|
- [Multi-Tenancy Support](/references/store/models/Store): Create multiple stores, each having its own configurations.
|
|
|
|
---
|
|
|
|
## How to Use Store Module's Service
|
|
|
|
In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](!docs!/learn/fundamentals/workflows), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism.
|
|
|
|
You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the `@medusajs/medusa/core-flows` package.
|
|
|
|
For example:
|
|
|
|
export const highlights = [
|
|
["12", "Modules.STORE", "Resolve the module in a step."]
|
|
]
|
|
|
|
```ts title="src/workflows/create-store.ts" highlights={highlights}
|
|
import {
|
|
createWorkflow,
|
|
WorkflowResponse,
|
|
createStep,
|
|
StepResponse,
|
|
} from "@medusajs/framework/workflows-sdk"
|
|
import { Modules } from "@medusajs/framework/utils"
|
|
|
|
const createStoreStep = createStep(
|
|
"create-store",
|
|
async ({}, { container }) => {
|
|
const storeModuleService = container.resolve(Modules.STORE)
|
|
|
|
const store = await storeModuleService.createStores({
|
|
name: "My Store",
|
|
supported_currencies: [{
|
|
currency_code: "usd",
|
|
is_default: true,
|
|
}],
|
|
})
|
|
|
|
return new StepResponse({ store }, store.id)
|
|
},
|
|
async (storeId, { container }) => {
|
|
if(!storeId) {
|
|
return
|
|
}
|
|
const storeModuleService = container.resolve(Modules.STORE)
|
|
|
|
await storeModuleService.deleteStores([storeId])
|
|
}
|
|
)
|
|
|
|
export const createStoreWorkflow = createWorkflow(
|
|
"create-store",
|
|
() => {
|
|
const { store } = createStoreStep()
|
|
|
|
return new WorkflowResponse({ store })
|
|
}
|
|
)
|
|
```
|
|
|
|
You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers:
|
|
|
|
<CodeTabs group="resource-types">
|
|
<CodeTab label="API Route" value="api-route">
|
|
|
|
```ts title="src/api/workflow/route.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports"
|
|
import type {
|
|
MedusaRequest,
|
|
MedusaResponse,
|
|
} from "@medusajs/framework/http"
|
|
import { createStoreWorkflow } from "../../workflows/create-store"
|
|
|
|
export async function GET(
|
|
req: MedusaRequest,
|
|
res: MedusaResponse
|
|
) {
|
|
const { result } = await createStoreWorkflow(req.scope)
|
|
.run()
|
|
|
|
res.send(result)
|
|
}
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="Subscriber" value="subscriber">
|
|
|
|
```ts title="src/subscribers/user-created.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports"
|
|
import {
|
|
type SubscriberConfig,
|
|
type SubscriberArgs,
|
|
} from "@medusajs/framework"
|
|
import { createStoreWorkflow } from "../workflows/create-store"
|
|
|
|
export default async function handleUserCreated({
|
|
event: { data },
|
|
container,
|
|
}: SubscriberArgs<{ id: string }>) {
|
|
const { result } = await createStoreWorkflow(container)
|
|
.run()
|
|
|
|
console.log(result)
|
|
}
|
|
|
|
export const config: SubscriberConfig = {
|
|
event: "user.created",
|
|
}
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="Scheduled Job" value="scheduled-job">
|
|
|
|
```ts title="src/jobs/run-daily.ts" highlights={[["7"], ["8"]]}
|
|
import { MedusaContainer } from "@medusajs/framework/types"
|
|
import { createStoreWorkflow } from "../workflows/create-store"
|
|
|
|
export default async function myCustomJob(
|
|
container: MedusaContainer
|
|
) {
|
|
const { result } = await createStoreWorkflow(container)
|
|
.run()
|
|
|
|
console.log(result)
|
|
}
|
|
|
|
export const config = {
|
|
name: "run-once-a-day",
|
|
schedule: `0 0 * * *`,
|
|
}
|
|
```
|
|
|
|
</CodeTab>
|
|
</CodeTabs>
|
|
|
|
Learn more about workflows in [this documentation](!docs!/learn/fundamentals/workflows).
|
|
|
|
---
|
|
|
|
<CommerceModuleSections />
|