Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: revise commerce modules #10209

Merged
merged 1 commit into from
Nov 21, 2024
Merged

docs: revise commerce modules #10209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 29 additions & 28 deletions www/apps/book/app/learn/basics/commerce-modules/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,48 +8,49 @@ In this chapter, you'll learn about Medusa's commerce modules.

## What is a Commerce Module?

Medusa provides all its commerce features as separate commerce modules, such as the Product or Order modules. Medusa uses these modules in its API routes to expose their commerce features.
A commerce module is a package built by Medusa that provides business logic and data models specific for a single commerce domain, such as the Product and Order modules. Commerce modules are available out-of-the-box in your application.

Medusa's commerce modules and your custom modules are interchangeable in the Medusa application, making Medusa’s architecture more flexible.
Medusa implements core commerce flows in workflows that use the commerce modules. Then, it exposes admin and storefront API routes that, under the hood, execute these workflows.

For example, the workflow to add a product to the cart uses the Product Module to check if the product exists, the Inventory Module to ensure the product is available in the inventory, and the Cart Module to finally add the product to the cart.

<Note title="Tip">

You'll find the details and steps of the add-to-cart workflow in [this workflow reference](!resources!/references/medusa-workflows/addToCartWorkflow)

</Note>

### List of Medusa's Commerce Modules

Refer to [this reference](!resources!/commerce-modules) for a full list of commerce modules in Medusa.

---

## Resolve Commerce Module Services
## Use Commerce Modules in Custom Flows

Similar to your [custom modules](../modules/page.mdx), the Medusa application registers a commerce module's service in the [container](../medusa-container/page.mdx). So, you can resolve it in your custom flows. This is useful as you build unique requirements extending core commerce features.

Similarly to your custom module, a commerce module's main service is registered in the Medusa container. So, you can resolve it in your resources, such as API routes, to use its functionality.
For example, consider you have a [workflow](../workflows/page.mdx) (a special function that performs a task in a series of steps with rollback mechanism) that needs a step to retrieve the total number of products. You can create a step in the workflow that resolves the Product Module's service from the container to use its methods:

For example, you saw this code snippet in the [Medusa container chapter](../medusa-container/page.mdx):
export const highlights = [
["7", "Modules.PRODUCT", "Resolve the Product Module's service from the container."],
["9", "listAndCountProducts", "Use the service's method to get the products count."]
]

```ts highlights={[["10"]]}
import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { IProductModuleService } from "@medusajs/framework/types"
```ts highlights={highlights}
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { Modules } from "@medusajs/framework/utils"

export const GET = async (
req: MedusaRequest,
res: MedusaResponse
) => {
const productModuleService: IProductModuleService = req.scope.resolve(
Modules.PRODUCT
)
export const countProductsStep = createStep(
"count-products",
async ({ }, { container }) => {
const productModuleService = container.resolve(Modules.PRODUCT)

const [, count] = await productModuleService
.listAndCountProducts()
const [,count] = await productModuleService.listAndCountProducts()

res.json({
count,
})
}
return new StepResponse(count)
}
)
```

When you resolve the `Modules.PRODUCT` (or `productModuleService`) registration name, you're actually resolving the main service of the Product Module.

<Note title="Tip">

To resolve the main service of any commerce module, use the registration name defined in the `Modules` enum imported from `@medusajs/framework/utils`.

</Note>
Your workflow can use services of both custom and commerce modules, supporting you in building custom flows without having to re-build core commerce features.
2 changes: 1 addition & 1 deletion www/apps/book/generated/edit-dates.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export const generatedEditDates = {
"app/learn/basics/workflows/page.mdx": "2024-09-30T08:43:53.132Z",
"app/learn/deployment/page.mdx": "2024-11-11T11:03:59.725Z",
"app/learn/page.mdx": "2024-09-03T07:09:09.034Z",
"app/learn/basics/commerce-modules/page.mdx": "2024-09-30T08:43:53.131Z",
"app/learn/basics/commerce-modules/page.mdx": "2024-11-21T16:24:19.136Z",
"app/learn/advanced-development/workflows/retry-failed-steps/page.mdx": "2024-09-30T08:43:53.130Z",
"app/learn/advanced-development/workflows/workflow-hooks/page.mdx": "2024-09-30T08:43:53.131Z",
"app/learn/cheatsheet/page.mdx": "2024-07-11T13:53:40+03:00",
Expand Down
Loading