docs: add workflow and js sdk reference pages for commerce modules (#10898)

* docs: add workflow and js sdk reference pages for commerce modules

* resolve build errors
This commit is contained in:
Shahed Nasser
2025-01-09 18:19:40 +02:00
committed by GitHub
parent 3fec01ab49
commit 44706ef03b
80 changed files with 7107 additions and 6113 deletions
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `API Key JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to API key related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -155,4 +155,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="API Key" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `API Key Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage API keys and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Auth JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to authentication related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" onlyTopLevel />
@@ -143,4 +143,4 @@ Medusa provides the following authentication providers out-of-the-box. You can u
---
<CommerceModuleSections name="Auth" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Auth Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to use authentication-related features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Cart JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to cart related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -167,4 +167,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Cart" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Cart Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage carts and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Currency JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to currency related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -163,4 +163,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Currency" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Customer JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to customer related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -156,4 +156,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Customer" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Customer Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage customers and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Fulfillment JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to fulfillment related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -178,4 +178,4 @@ The Fulfillment Module accepts options for further configurations. Refer to [thi
---
<CommerceModuleSections name="Fulfillment" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Fulfillment Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage fulfillments and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Inventory JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to inventory related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -159,4 +159,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Inventory" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Inventory Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage inventory and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Order JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to order related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -171,4 +171,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Order" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Order Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage orders and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Payment JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to payment related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -172,4 +172,4 @@ Medusa provides the following payment providers out-of-the-box. You can use them
---
<CommerceModuleSections name="Payment" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Payment Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage payments and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Pricing JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to pricing related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -169,4 +169,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Pricing" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Pricing Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage pricing and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Product JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to product related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -169,4 +169,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Product" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Product Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage products and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Promotion JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to promotion related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -163,4 +163,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Promotion" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Promotion Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage promotions and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Region JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to region related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -158,4 +158,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Region" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Region Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage regions and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Sales Channel JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to sales channel related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -175,4 +175,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Sales Channel" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Sales Channel Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage sales channels and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Stock Location JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to stock location related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -152,4 +152,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Stock Location" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Stock Location Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage stock locations and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Store JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to store related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -156,4 +156,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor
---
<CommerceModuleSections name="Store" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Store Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage stores and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Tax JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to tax related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -159,4 +159,4 @@ The Tax Module accepts options for further configurations. Refer to [this docume
---
<CommerceModuleSections name="Tax" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Tax Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage taxes and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `User JS SDK Methods`,
}
# {metadata.title}
The [JS SDK](../../../js-sdk/page.mdx) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.
Use the following methods or properties to send requests to user related API routes in your Medusa application. They are provided by the `@medusajs/js-sdk` package.
The following links will take you to the reference documentation for the [JS SDK](../../../js-sdk/page.mdx).
<ChildDocs type="item" />
@@ -162,4 +162,4 @@ The User Module accepts options for further configurations. Refer to [this docum
---
<CommerceModuleSections name="User" />
<CommerceModuleSections />
@@ -0,0 +1,15 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `User Workflows`,
}
# {metadata.title}
[Workflows](!docs!/learn/fundamentals/workflows) are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.
When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage users and use their features in your Medusa application. They are provided by the `@medusajs/medusa/core-flows` package.
The following links will take you to the reference documentation for [Medusa's Core Workflows](/medusa-workflows-reference).
<ChildDocs type="item" defaultItemsPerRow={2} />