diff --git a/www/apps/resources/app/commerce-modules/api-key/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/api-key/js-sdk/page.mdx new file mode 100644 index 0000000000..756fb21ccc --- /dev/null +++ b/www/apps/resources/app/commerce-modules/api-key/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/api-key/page.mdx b/www/apps/resources/app/commerce-modules/api-key/page.mdx index 79811aa0b4..0822ca57a6 100644 --- a/www/apps/resources/app/commerce-modules/api-key/page.mdx +++ b/www/apps/resources/app/commerce-modules/api-key/page.mdx @@ -155,4 +155,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/api-key/workflows/page.mdx b/www/apps/resources/app/commerce-modules/api-key/workflows/page.mdx new file mode 100644 index 0000000000..a2ffa66a0f --- /dev/null +++ b/www/apps/resources/app/commerce-modules/api-key/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/auth/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/auth/js-sdk/page.mdx new file mode 100644 index 0000000000..75348a2113 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/auth/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/auth/page.mdx b/www/apps/resources/app/commerce-modules/auth/page.mdx index c80d7f266d..377ea69f0b 100644 --- a/www/apps/resources/app/commerce-modules/auth/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/page.mdx @@ -143,4 +143,4 @@ Medusa provides the following authentication providers out-of-the-box. You can u --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/auth/workflows/page.mdx b/www/apps/resources/app/commerce-modules/auth/workflows/page.mdx new file mode 100644 index 0000000000..98d709517b --- /dev/null +++ b/www/apps/resources/app/commerce-modules/auth/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/cart/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/cart/js-sdk/page.mdx new file mode 100644 index 0000000000..bd0edb30ce --- /dev/null +++ b/www/apps/resources/app/commerce-modules/cart/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/cart/page.mdx b/www/apps/resources/app/commerce-modules/cart/page.mdx index 52231a4ffe..be6c558cbf 100644 --- a/www/apps/resources/app/commerce-modules/cart/page.mdx +++ b/www/apps/resources/app/commerce-modules/cart/page.mdx @@ -167,4 +167,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/cart/workflows/page.mdx b/www/apps/resources/app/commerce-modules/cart/workflows/page.mdx new file mode 100644 index 0000000000..471557920d --- /dev/null +++ b/www/apps/resources/app/commerce-modules/cart/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/currency/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/currency/js-sdk/page.mdx new file mode 100644 index 0000000000..38480d6311 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/currency/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/currency/page.mdx b/www/apps/resources/app/commerce-modules/currency/page.mdx index 511b8aa87e..7844d8ac3b 100644 --- a/www/apps/resources/app/commerce-modules/currency/page.mdx +++ b/www/apps/resources/app/commerce-modules/currency/page.mdx @@ -163,4 +163,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/customer/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/customer/js-sdk/page.mdx new file mode 100644 index 0000000000..26310b9619 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/customer/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/customer/page.mdx b/www/apps/resources/app/commerce-modules/customer/page.mdx index a33942b856..2cf9df143b 100644 --- a/www/apps/resources/app/commerce-modules/customer/page.mdx +++ b/www/apps/resources/app/commerce-modules/customer/page.mdx @@ -156,4 +156,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/customer/workflows/page.mdx b/www/apps/resources/app/commerce-modules/customer/workflows/page.mdx new file mode 100644 index 0000000000..ef46a04701 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/customer/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/fulfillment/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/fulfillment/js-sdk/page.mdx new file mode 100644 index 0000000000..36ac61f827 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/fulfillment/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/fulfillment/page.mdx b/www/apps/resources/app/commerce-modules/fulfillment/page.mdx index cfd8c3695a..ff74c62721 100644 --- a/www/apps/resources/app/commerce-modules/fulfillment/page.mdx +++ b/www/apps/resources/app/commerce-modules/fulfillment/page.mdx @@ -178,4 +178,4 @@ The Fulfillment Module accepts options for further configurations. Refer to [thi --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/fulfillment/workflows/page.mdx b/www/apps/resources/app/commerce-modules/fulfillment/workflows/page.mdx new file mode 100644 index 0000000000..7089a1f195 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/fulfillment/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/inventory/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/inventory/js-sdk/page.mdx new file mode 100644 index 0000000000..043cea9ddf --- /dev/null +++ b/www/apps/resources/app/commerce-modules/inventory/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/inventory/page.mdx b/www/apps/resources/app/commerce-modules/inventory/page.mdx index a6b4a8c4a7..86a56c5fd5 100644 --- a/www/apps/resources/app/commerce-modules/inventory/page.mdx +++ b/www/apps/resources/app/commerce-modules/inventory/page.mdx @@ -159,4 +159,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/inventory/workflows/page.mdx b/www/apps/resources/app/commerce-modules/inventory/workflows/page.mdx new file mode 100644 index 0000000000..b3dff2958f --- /dev/null +++ b/www/apps/resources/app/commerce-modules/inventory/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/order/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/order/js-sdk/page.mdx new file mode 100644 index 0000000000..443f22960d --- /dev/null +++ b/www/apps/resources/app/commerce-modules/order/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/order/page.mdx b/www/apps/resources/app/commerce-modules/order/page.mdx index 6f62b3cd60..0a02018d44 100644 --- a/www/apps/resources/app/commerce-modules/order/page.mdx +++ b/www/apps/resources/app/commerce-modules/order/page.mdx @@ -171,4 +171,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/order/workflows/page.mdx b/www/apps/resources/app/commerce-modules/order/workflows/page.mdx new file mode 100644 index 0000000000..d671b85c6a --- /dev/null +++ b/www/apps/resources/app/commerce-modules/order/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/payment/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/payment/js-sdk/page.mdx new file mode 100644 index 0000000000..e47b23018b --- /dev/null +++ b/www/apps/resources/app/commerce-modules/payment/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/payment/page.mdx b/www/apps/resources/app/commerce-modules/payment/page.mdx index 5ae0b744fe..8df09ecd2c 100644 --- a/www/apps/resources/app/commerce-modules/payment/page.mdx +++ b/www/apps/resources/app/commerce-modules/payment/page.mdx @@ -172,4 +172,4 @@ Medusa provides the following payment providers out-of-the-box. You can use them --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/payment/workflows/page.mdx b/www/apps/resources/app/commerce-modules/payment/workflows/page.mdx new file mode 100644 index 0000000000..41e7a6a1f7 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/payment/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/pricing/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/pricing/js-sdk/page.mdx new file mode 100644 index 0000000000..2375de717f --- /dev/null +++ b/www/apps/resources/app/commerce-modules/pricing/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/pricing/page.mdx b/www/apps/resources/app/commerce-modules/pricing/page.mdx index bf10090096..1a4df678a9 100644 --- a/www/apps/resources/app/commerce-modules/pricing/page.mdx +++ b/www/apps/resources/app/commerce-modules/pricing/page.mdx @@ -169,4 +169,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/pricing/workflows/page.mdx b/www/apps/resources/app/commerce-modules/pricing/workflows/page.mdx new file mode 100644 index 0000000000..b5ada09868 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/pricing/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/product/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/product/js-sdk/page.mdx new file mode 100644 index 0000000000..789ddf443b --- /dev/null +++ b/www/apps/resources/app/commerce-modules/product/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/product/page.mdx b/www/apps/resources/app/commerce-modules/product/page.mdx index 442c46e4e5..77878f26f6 100644 --- a/www/apps/resources/app/commerce-modules/product/page.mdx +++ b/www/apps/resources/app/commerce-modules/product/page.mdx @@ -169,4 +169,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/product/workflows/page.mdx b/www/apps/resources/app/commerce-modules/product/workflows/page.mdx new file mode 100644 index 0000000000..e590c9ea5a --- /dev/null +++ b/www/apps/resources/app/commerce-modules/product/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/promotion/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/promotion/js-sdk/page.mdx new file mode 100644 index 0000000000..52f8b857d3 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/promotion/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/promotion/page.mdx b/www/apps/resources/app/commerce-modules/promotion/page.mdx index 947659e958..0e8f75c707 100644 --- a/www/apps/resources/app/commerce-modules/promotion/page.mdx +++ b/www/apps/resources/app/commerce-modules/promotion/page.mdx @@ -163,4 +163,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/promotion/workflows/page.mdx b/www/apps/resources/app/commerce-modules/promotion/workflows/page.mdx new file mode 100644 index 0000000000..fd62cd0254 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/promotion/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/region/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/region/js-sdk/page.mdx new file mode 100644 index 0000000000..6bb73d4c0f --- /dev/null +++ b/www/apps/resources/app/commerce-modules/region/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/region/page.mdx b/www/apps/resources/app/commerce-modules/region/page.mdx index 8d7ccc2750..a7da230d39 100644 --- a/www/apps/resources/app/commerce-modules/region/page.mdx +++ b/www/apps/resources/app/commerce-modules/region/page.mdx @@ -158,4 +158,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - + diff --git a/www/apps/resources/app/commerce-modules/region/workflows/page.mdx b/www/apps/resources/app/commerce-modules/region/workflows/page.mdx new file mode 100644 index 0000000000..d8749ccd51 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/region/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/sales-channel/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/sales-channel/js-sdk/page.mdx new file mode 100644 index 0000000000..a0d5c0e294 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/sales-channel/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/sales-channel/page.mdx b/www/apps/resources/app/commerce-modules/sales-channel/page.mdx index f144d01b43..59b008c1e1 100644 --- a/www/apps/resources/app/commerce-modules/sales-channel/page.mdx +++ b/www/apps/resources/app/commerce-modules/sales-channel/page.mdx @@ -175,4 +175,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/sales-channel/workflows/page.mdx b/www/apps/resources/app/commerce-modules/sales-channel/workflows/page.mdx new file mode 100644 index 0000000000..591faf8fb5 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/sales-channel/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/stock-location/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/stock-location/js-sdk/page.mdx new file mode 100644 index 0000000000..7a7bf66e9d --- /dev/null +++ b/www/apps/resources/app/commerce-modules/stock-location/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/stock-location/page.mdx b/www/apps/resources/app/commerce-modules/stock-location/page.mdx index ca17c0c0e5..f32cc9fe40 100644 --- a/www/apps/resources/app/commerce-modules/stock-location/page.mdx +++ b/www/apps/resources/app/commerce-modules/stock-location/page.mdx @@ -152,4 +152,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - + diff --git a/www/apps/resources/app/commerce-modules/stock-location/workflows/page.mdx b/www/apps/resources/app/commerce-modules/stock-location/workflows/page.mdx new file mode 100644 index 0000000000..0dab3f12c1 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/stock-location/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/store/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/store/js-sdk/page.mdx new file mode 100644 index 0000000000..e7cbbfaad2 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/store/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/store/page.mdx b/www/apps/resources/app/commerce-modules/store/page.mdx index 94edf8071c..4fc64c8aa9 100644 --- a/www/apps/resources/app/commerce-modules/store/page.mdx +++ b/www/apps/resources/app/commerce-modules/store/page.mdx @@ -156,4 +156,4 @@ Learn more about workflows in [this documentation](!docs!/learn/fundamentals/wor --- - + diff --git a/www/apps/resources/app/commerce-modules/store/workflows/page.mdx b/www/apps/resources/app/commerce-modules/store/workflows/page.mdx new file mode 100644 index 0000000000..ba53523f73 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/store/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/tax/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/tax/js-sdk/page.mdx new file mode 100644 index 0000000000..10ed6ac1f5 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/tax/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/tax/page.mdx b/www/apps/resources/app/commerce-modules/tax/page.mdx index 3e8f85dc0a..8cee91a18f 100644 --- a/www/apps/resources/app/commerce-modules/tax/page.mdx +++ b/www/apps/resources/app/commerce-modules/tax/page.mdx @@ -159,4 +159,4 @@ The Tax Module accepts options for further configurations. Refer to [this docume --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/tax/workflows/page.mdx b/www/apps/resources/app/commerce-modules/tax/workflows/page.mdx new file mode 100644 index 0000000000..499de906d6 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/tax/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/user/js-sdk/page.mdx b/www/apps/resources/app/commerce-modules/user/js-sdk/page.mdx new file mode 100644 index 0000000000..42416df863 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/user/js-sdk/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/user/page.mdx b/www/apps/resources/app/commerce-modules/user/page.mdx index d563e51fd5..a5dd3edd70 100644 --- a/www/apps/resources/app/commerce-modules/user/page.mdx +++ b/www/apps/resources/app/commerce-modules/user/page.mdx @@ -162,4 +162,4 @@ The User Module accepts options for further configurations. Refer to [this docum --- - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/user/workflows/page.mdx b/www/apps/resources/app/commerce-modules/user/workflows/page.mdx new file mode 100644 index 0000000000..3020a9b6d9 --- /dev/null +++ b/www/apps/resources/app/commerce-modules/user/workflows/page.mdx @@ -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). + + \ No newline at end of file diff --git a/www/apps/resources/app/page.mdx b/www/apps/resources/app/page.mdx index c742f3cd35..083f8c67f5 100644 --- a/www/apps/resources/app/page.mdx +++ b/www/apps/resources/app/page.mdx @@ -21,7 +21,6 @@ import { Stripe, PhotoSolid, BuildingsSolid, - Javascript } from "@medusajs/icons" # Medusa Development Resources @@ -130,7 +129,7 @@ Follow the [Medusa Docs](!docs!/learn) to become an advanced Medusa developer. { +export const CommerceModuleSections = () => { const guideComponents: (JSX.Element | JSX.Element[])[] = [] const referenceComponents: (JSX.Element | JSX.Element[])[] = [] - const { items: workflowItems, component: workflowsComponent } = useChildDocs({ - showItems: ["Workflows"], - titleLevel: 3, - itemsPerRow: 2, - }) - const { items: stepItems, component: stepsComponent } = useChildDocs({ - showItems: ["Steps"], - titleLevel: 3, - itemsPerRow: 2, - }) - - const hideWorkflowsSection = useMemo(() => { - return !workflowItems?.default.length && !stepItems?.default.length - }, [workflowItems, stepItems]) const { items: serverGuideItems, component: serverGuidesComponent } = useChildDocs({ showItems: ["Server Guides"], - itemsPerRow: 2, + defaultItemsPerRow: 2, }) if (serverGuideItems?.default.length) { guideComponents.push(serverGuidesComponent) @@ -38,7 +18,7 @@ export const CommerceModuleSections = ({ const { items: storefrontGuideItems, component: storefrontGuidesComponent } = useChildDocs({ showItems: ["Storefront Guides"], - itemsPerRow: 2, + defaultItemsPerRow: 2, }) if (storefrontGuideItems?.default.length) { guideComponents.push(storefrontGuidesComponent) @@ -46,7 +26,7 @@ export const CommerceModuleSections = ({ const { items: adminGuideItems, component: adminGuidesComponent } = useChildDocs({ showItems: ["Admin Guides"], - itemsPerRow: 2, + defaultItemsPerRow: 2, }) if (adminGuideItems?.default.length) { guideComponents.push(adminGuidesComponent) @@ -54,7 +34,7 @@ export const CommerceModuleSections = ({ const { items: userGuideItems, component: userGuidesComponent } = useChildDocs({ showItems: ["User Guides"], - itemsPerRow: 2, + defaultItemsPerRow: 2, }) if (userGuideItems?.default.length) { guideComponents.push(userGuidesComponent) @@ -69,7 +49,7 @@ export const CommerceModuleSections = ({ const { items: referenceItems, component: referencesComponent } = useChildDocs({ showItems: ["References"], - itemsPerRow: 2, + defaultItemsPerRow: 2, }) if (referenceItems?.default.length) { referenceComponents.push(referencesComponent) @@ -85,23 +65,11 @@ export const CommerceModuleSections = ({ ))} - {!hideWorkflowsSection && ( - <> - {guideComponents.length > 0 &&
} -

Medusa Workflows and Steps

-

- Medusa provides the following workflows and steps that use the{" "} - {name} Module. You can use these workflows and steps in your - customizations: -

- {workflowsComponent} - {stepsComponent} - - )} + {guideComponents.length > 0 && referenceComponents.length > 0 &&
} {referenceComponents.map((component, i) => ( <> - {(i !== 0 || !hideWorkflowsSection) &&
} + {i !== 0 &&
} {component} diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs index 1564dbe9e2..850cae4647 100644 --- a/www/apps/resources/generated/edit-dates.mjs +++ b/www/apps/resources/generated/edit-dates.mjs @@ -4,20 +4,20 @@ export const generatedEditDates = { "app/commerce-modules/auth/authentication-route/page.mdx": "2025-01-07T09:26:27.809Z", "app/commerce-modules/auth/examples/page.mdx": "2024-10-15T15:02:13.794Z", "app/commerce-modules/auth/module-options/page.mdx": "2025-01-07T12:47:35.073Z", - "app/commerce-modules/auth/page.mdx": "2024-12-25T15:40:37.154Z", + "app/commerce-modules/auth/page.mdx": "2025-01-09T13:41:05.476Z", "app/commerce-modules/cart/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/cart/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/cart/concepts/page.mdx": "2024-10-08T07:49:03.737Z", "app/commerce-modules/cart/promotions/page.mdx": "2024-10-08T07:54:31.120Z", "app/commerce-modules/cart/tax-lines/page.mdx": "2024-10-08T07:57:19.168Z", - "app/commerce-modules/cart/page.mdx": "2024-12-25T15:55:02.850Z", + "app/commerce-modules/cart/page.mdx": "2025-01-09T13:41:05.278Z", "app/commerce-modules/currency/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/currency/_events/page.mdx": "2024-07-03T19:27:13+03:00", - "app/commerce-modules/currency/page.mdx": "2024-12-25T15:55:02.850Z", + "app/commerce-modules/currency/page.mdx": "2025-01-09T13:41:04.697Z", "app/commerce-modules/customer/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/customer/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/customer/customer-accounts/page.mdx": "2024-10-08T12:20:44.769Z", - "app/commerce-modules/customer/page.mdx": "2024-12-25T15:55:02.850Z", + "app/commerce-modules/customer/page.mdx": "2025-01-09T13:41:05.014Z", "app/commerce-modules/fulfillment/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/fulfillment/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/fulfillment/concepts/page.mdx": "2024-06-19T13:02:16+00:00", @@ -25,12 +25,12 @@ export const generatedEditDates = { "app/commerce-modules/fulfillment/item-fulfillment/page.mdx": "2024-10-08T14:38:15.496Z", "app/commerce-modules/fulfillment/module-options/page.mdx": "2024-10-15T12:51:56.118Z", "app/commerce-modules/fulfillment/shipping-option/page.mdx": "2024-10-08T14:36:02.660Z", - "app/commerce-modules/fulfillment/page.mdx": "2024-12-25T15:55:02.850Z", + "app/commerce-modules/fulfillment/page.mdx": "2025-01-09T13:41:05.614Z", "app/commerce-modules/inventory/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/inventory/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/inventory/concepts/page.mdx": "2024-10-08T15:11:27.634Z", "app/commerce-modules/inventory/inventory-in-flows/page.mdx": "2025-01-08T12:21:12.157Z", - "app/commerce-modules/inventory/page.mdx": "2025-01-09T09:28:33.889Z", + "app/commerce-modules/inventory/page.mdx": "2025-01-09T13:41:05.212Z", "app/commerce-modules/order/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/order/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/order/claim/page.mdx": "2024-10-09T10:11:12.090Z", @@ -41,7 +41,7 @@ export const generatedEditDates = { "app/commerce-modules/order/return/page.mdx": "2024-10-09T10:19:40.731Z", "app/commerce-modules/order/tax-lines/page.mdx": "2024-10-09T10:22:49.335Z", "app/commerce-modules/order/transactions/page.mdx": "2024-10-09T10:23:36.485Z", - "app/commerce-modules/order/page.mdx": "2024-12-25T15:55:02.851Z", + "app/commerce-modules/order/page.mdx": "2025-01-09T13:41:05.344Z", "app/commerce-modules/payment/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/payment/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/payment/module-options/page.mdx": "2024-10-15T12:51:40.574Z", @@ -52,52 +52,52 @@ export const generatedEditDates = { "app/commerce-modules/payment/payment-provider/page.mdx": "2024-10-09T11:07:27.269Z", "app/commerce-modules/payment/payment-session/page.mdx": "2024-10-09T10:58:00.960Z", "app/commerce-modules/payment/webhook-events/page.mdx": "2024-11-19T11:45:02.167Z", - "app/commerce-modules/payment/page.mdx": "2024-12-25T15:55:02.850Z", + "app/commerce-modules/payment/page.mdx": "2025-01-09T13:41:05.409Z", "app/commerce-modules/pricing/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/pricing/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/pricing/concepts/page.mdx": "2024-10-09T13:37:25.678Z", "app/commerce-modules/pricing/price-calculation/page.mdx": "2024-10-09T13:43:14.038Z", "app/commerce-modules/pricing/price-rules/page.mdx": "2024-10-09T13:38:47.112Z", "app/commerce-modules/pricing/tax-inclusive-pricing/page.mdx": "2024-10-09T13:48:23.261Z", - "app/commerce-modules/pricing/page.mdx": "2024-12-25T15:55:02.851Z", + "app/commerce-modules/pricing/page.mdx": "2025-01-09T13:41:04.553Z", "app/commerce-modules/product/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/product/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/product/guides/price/page.mdx": "2024-12-25T15:10:37.730Z", "app/commerce-modules/product/guides/price-with-taxes/page.mdx": "2024-12-25T15:10:40.879Z", - "app/commerce-modules/product/page.mdx": "2025-01-09T09:29:05.898Z", + "app/commerce-modules/product/page.mdx": "2025-01-09T13:41:04.786Z", "app/commerce-modules/promotion/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/promotion/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/promotion/actions/page.mdx": "2024-10-09T14:49:01.645Z", "app/commerce-modules/promotion/application-method/page.mdx": "2024-06-26T07:55:59+00:00", "app/commerce-modules/promotion/campaign/page.mdx": "2024-05-29T11:08:06+00:00", "app/commerce-modules/promotion/concepts/page.mdx": "2024-10-09T14:50:50.255Z", - "app/commerce-modules/promotion/page.mdx": "2024-12-25T15:55:02.850Z", + "app/commerce-modules/promotion/page.mdx": "2025-01-09T13:41:04.946Z", "app/commerce-modules/region/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/region/_events/page.mdx": "2024-07-03T19:27:13+03:00", - "app/commerce-modules/region/page.mdx": "2024-12-25T15:55:02.851Z", + "app/commerce-modules/region/page.mdx": "2025-01-09T13:41:05.146Z", "app/commerce-modules/sales-channel/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/sales-channel/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/sales-channel/publishable-api-keys/page.mdx": "2024-10-15T14:21:38.353Z", - "app/commerce-modules/sales-channel/page.mdx": "2024-12-25T15:55:17.802Z", + "app/commerce-modules/sales-channel/page.mdx": "2025-01-09T13:41:04.880Z", "app/commerce-modules/stock-location/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/stock-location/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/stock-location/concepts/page.mdx": "2024-10-15T14:32:21.875Z", - "app/commerce-modules/stock-location/page.mdx": "2024-12-25T16:09:26.781Z", + "app/commerce-modules/stock-location/page.mdx": "2025-01-09T13:41:05.080Z", "app/commerce-modules/store/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/store/_events/page.mdx": "2024-07-03T19:27:13+03:00", - "app/commerce-modules/store/page.mdx": "2024-12-25T16:09:12.124Z", + "app/commerce-modules/store/page.mdx": "2025-01-09T13:41:04.629Z", "app/commerce-modules/tax/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/tax/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/tax/module-options/page.mdx": "2024-10-15T14:35:46.117Z", "app/commerce-modules/tax/tax-calculation-with-provider/page.mdx": "2024-10-15T14:43:00.700Z", "app/commerce-modules/tax/tax-rates-and-rules/page.mdx": "2024-10-15T14:38:06.889Z", "app/commerce-modules/tax/tax-region/page.mdx": "2024-10-15T14:36:47.028Z", - "app/commerce-modules/tax/page.mdx": "2024-12-25T16:22:51.953Z", + "app/commerce-modules/tax/page.mdx": "2025-01-09T13:41:05.680Z", "app/commerce-modules/user/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/user/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/user/module-options/page.mdx": "2024-09-30T08:43:53.171Z", "app/commerce-modules/user/user-creation-flows/page.mdx": "2024-10-15T14:51:37.311Z", - "app/commerce-modules/user/page.mdx": "2024-12-25T16:24:26.837Z", + "app/commerce-modules/user/page.mdx": "2025-01-09T13:41:05.543Z", "app/commerce-modules/page.mdx": "2024-12-23T14:38:21.064Z", "app/contribution-guidelines/docs/page.mdx": "2024-12-12T11:06:12.250Z", "app/create-medusa-app/page.mdx": "2025-01-06T09:14:55.483Z", @@ -190,12 +190,12 @@ export const generatedEditDates = { "app/troubleshooting/s3/page.mdx": "2024-08-06T09:59:46+03:00", "app/troubleshooting/page.mdx": "2024-07-18T08:57:11+02:00", "app/usage/page.mdx": "2024-05-13T18:55:11+03:00", - "app/page.mdx": "2024-10-16T11:40:59.669Z", + "app/page.mdx": "2025-01-09T11:40:57.826Z", "app/commerce-modules/auth/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/auth/auth-flows/page.mdx": "2025-01-07T09:29:52.153Z", "app/commerce-modules/auth/_events/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/auth/auth-identity-and-actor-types/page.mdx": "2025-01-07T09:02:27.235Z", - "app/commerce-modules/api-key/page.mdx": "2024-12-25T15:55:02.846Z", + "app/commerce-modules/api-key/page.mdx": "2025-01-09T13:41:04.492Z", "app/commerce-modules/auth/create-actor-type/page.mdx": "2024-12-25T13:26:27.176Z", "app/architectural-modules/page.mdx": "2025-01-08T12:13:50.333Z", "app/architectural-modules/workflow-engine/redis/page.mdx": "2024-10-15T12:50:59.507Z", @@ -5788,5 +5788,41 @@ export const generatedEditDates = { "references/types/StockLocationTypes/interfaces/types.StockLocationTypes.FilterableStockLocationAddressProps/page.mdx": "2025-01-07T12:54:23.060Z", "references/types/StockLocationTypes/types/types.StockLocationTypes.UpdateStockLocationAddressInput/page.mdx": "2025-01-07T12:54:23.057Z", "references/types/StockLocationTypes/types/types.StockLocationTypes.UpsertStockLocationAddressInput/page.mdx": "2025-01-07T12:54:23.058Z", - "app/commerce-modules/inventory/inventory-kit/page.mdx": "2025-01-09T09:39:50.221Z" + "app/commerce-modules/inventory/inventory-kit/page.mdx": "2025-01-09T09:39:50.221Z", + "app/commerce-modules/api-key/workflows/page.mdx": "2025-01-09T13:41:46.573Z", + "app/commerce-modules/api-key/js-sdk/page.mdx": "2025-01-09T12:04:39.787Z", + "app/commerce-modules/auth/js-sdk/page.mdx": "2025-01-09T13:27:54.016Z", + "app/commerce-modules/auth/workflows/page.mdx": "2025-01-09T13:41:46.777Z", + "app/commerce-modules/cart/js-sdk/page.mdx": "2025-01-09T12:04:34.274Z", + "app/commerce-modules/cart/workflows/page.mdx": "2025-01-09T13:41:45.857Z", + "app/commerce-modules/currency/js-sdk/page.mdx": "2025-01-09T12:04:27.827Z", + "app/commerce-modules/currency/workflows/page.mdx": "2025-01-09T12:04:13.629Z", + "app/commerce-modules/customer/js-sdk/page.mdx": "2025-01-09T12:09:40.763Z", + "app/commerce-modules/customer/workflows/page.mdx": "2025-01-09T13:41:45.790Z", + "app/commerce-modules/fulfillment/js-sdk/page.mdx": "2025-01-09T12:24:16.522Z", + "app/commerce-modules/fulfillment/workflows/page.mdx": "2025-01-09T13:41:46.369Z", + "app/commerce-modules/inventory/js-sdk/page.mdx": "2025-01-09T12:35:04.930Z", + "app/commerce-modules/inventory/workflows/page.mdx": "2025-01-09T13:41:46.036Z", + "app/commerce-modules/order/js-sdk/page.mdx": "2025-01-09T12:37:15.684Z", + "app/commerce-modules/order/workflows/page.mdx": "2025-01-09T13:41:46.710Z", + "app/commerce-modules/payment/js-sdk/page.mdx": "2025-01-09T12:38:46.117Z", + "app/commerce-modules/payment/workflows/page.mdx": "2025-01-09T13:41:46.435Z", + "app/commerce-modules/pricing/js-sdk/page.mdx": "2025-01-09T12:40:41.041Z", + "app/commerce-modules/pricing/workflows/page.mdx": "2025-01-09T13:41:45.963Z", + "app/commerce-modules/product/js-sdk/page.mdx": "2025-01-09T12:42:19.137Z", + "app/commerce-modules/product/workflows/page.mdx": "2025-01-09T13:41:45.656Z", + "app/commerce-modules/promotion/js-sdk/page.mdx": "2025-01-09T12:44:32.129Z", + "app/commerce-modules/promotion/workflows/page.mdx": "2025-01-09T13:41:46.643Z", + "app/commerce-modules/region/js-sdk/page.mdx": "2025-01-09T12:46:15.466Z", + "app/commerce-modules/region/workflows/page.mdx": "2025-01-09T13:41:46.170Z", + "app/commerce-modules/sales-channel/js-sdk/page.mdx": "2025-01-09T12:48:14.632Z", + "app/commerce-modules/sales-channel/workflows/page.mdx": "2025-01-09T13:41:46.102Z", + "app/commerce-modules/stock-location/js-sdk/page.mdx": "2025-01-09T12:49:43.647Z", + "app/commerce-modules/stock-location/workflows/page.mdx": "2025-01-09T13:41:46.236Z", + "app/commerce-modules/store/js-sdk/page.mdx": "2025-01-09T12:51:17.432Z", + "app/commerce-modules/store/workflows/page.mdx": "2025-01-09T13:41:45.719Z", + "app/commerce-modules/tax/js-sdk/page.mdx": "2025-01-09T12:52:47.112Z", + "app/commerce-modules/tax/workflows/page.mdx": "2025-01-09T13:41:46.504Z", + "app/commerce-modules/user/js-sdk/page.mdx": "2025-01-09T12:55:02.289Z", + "app/commerce-modules/user/workflows/page.mdx": "2025-01-09T13:41:46.302Z" } \ No newline at end of file diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs index 0c5448175f..7c34441c46 100644 --- a/www/apps/resources/generated/files-map.mjs +++ b/www/apps/resources/generated/files-map.mjs @@ -127,6 +127,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/api-key/concepts/page.mdx", "pathname": "/commerce-modules/api-key/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/api-key/js-sdk/page.mdx", + "pathname": "/commerce-modules/api-key/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/api-key/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/api-key/links-to-other-modules" @@ -135,6 +139,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/api-key/page.mdx", "pathname": "/commerce-modules/api-key" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/api-key/workflows/page.mdx", + "pathname": "/commerce-modules/api-key/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/auth/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/auth/admin-widget-zones" @@ -175,6 +183,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/auth/events/page.mdx", "pathname": "/commerce-modules/auth/events" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/auth/js-sdk/page.mdx", + "pathname": "/commerce-modules/auth/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/auth/module-options/page.mdx", "pathname": "/commerce-modules/auth/module-options" @@ -187,6 +199,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx", "pathname": "/commerce-modules/auth/reset-password" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/auth/workflows/page.mdx", + "pathname": "/commerce-modules/auth/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/cart/concepts/page.mdx", "pathname": "/commerce-modules/cart/concepts" @@ -199,6 +215,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/cart/extend/page.mdx", "pathname": "/commerce-modules/cart/extend" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/cart/js-sdk/page.mdx", + "pathname": "/commerce-modules/cart/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/cart/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/cart/links-to-other-modules" @@ -215,6 +235,14 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/cart/tax-lines/page.mdx", "pathname": "/commerce-modules/cart/tax-lines" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/cart/workflows/page.mdx", + "pathname": "/commerce-modules/cart/workflows" + }, + { + "filePath": "/www/apps/resources/app/commerce-modules/currency/js-sdk/page.mdx", + "pathname": "/commerce-modules/currency/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/currency/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/currency/links-to-other-modules" @@ -239,6 +267,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/customer/extend/page.mdx", "pathname": "/commerce-modules/customer/extend" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/customer/js-sdk/page.mdx", + "pathname": "/commerce-modules/customer/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/customer/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/customer/links-to-other-modules" @@ -247,6 +279,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/customer/page.mdx", "pathname": "/commerce-modules/customer" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/customer/workflows/page.mdx", + "pathname": "/commerce-modules/customer/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/fulfillment/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/fulfillment/admin-widget-zones" @@ -267,6 +303,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/fulfillment/item-fulfillment/page.mdx", "pathname": "/commerce-modules/fulfillment/item-fulfillment" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/fulfillment/js-sdk/page.mdx", + "pathname": "/commerce-modules/fulfillment/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/fulfillment/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/fulfillment/links-to-other-modules" @@ -283,6 +323,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/fulfillment/shipping-option/page.mdx", "pathname": "/commerce-modules/fulfillment/shipping-option" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/fulfillment/workflows/page.mdx", + "pathname": "/commerce-modules/fulfillment/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/inventory/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/inventory/admin-widget-zones" @@ -299,6 +343,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/inventory/inventory-kit/page.mdx", "pathname": "/commerce-modules/inventory/inventory-kit" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/inventory/js-sdk/page.mdx", + "pathname": "/commerce-modules/inventory/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/inventory/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/inventory/links-to-other-modules" @@ -307,6 +355,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/inventory/page.mdx", "pathname": "/commerce-modules/inventory" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/inventory/workflows/page.mdx", + "pathname": "/commerce-modules/inventory/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/order/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/order/admin-widget-zones" @@ -331,6 +383,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/order/exchange/page.mdx", "pathname": "/commerce-modules/order/exchange" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/order/js-sdk/page.mdx", + "pathname": "/commerce-modules/order/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/order/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/order/links-to-other-modules" @@ -363,6 +419,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/order/transactions/page.mdx", "pathname": "/commerce-modules/order/transactions" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/order/workflows/page.mdx", + "pathname": "/commerce-modules/order/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/page.mdx", "pathname": "/commerce-modules" @@ -371,6 +431,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/payment/events/page.mdx", "pathname": "/commerce-modules/payment/events" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/payment/js-sdk/page.mdx", + "pathname": "/commerce-modules/payment/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/payment/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/payment/links-to-other-modules" @@ -411,6 +475,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/payment/webhook-events/page.mdx", "pathname": "/commerce-modules/payment/webhook-events" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/payment/workflows/page.mdx", + "pathname": "/commerce-modules/payment/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/pricing/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/pricing/admin-widget-zones" @@ -419,6 +487,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/pricing/concepts/page.mdx", "pathname": "/commerce-modules/pricing/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/pricing/js-sdk/page.mdx", + "pathname": "/commerce-modules/pricing/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/pricing/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/pricing/links-to-other-modules" @@ -439,6 +511,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/pricing/tax-inclusive-pricing/page.mdx", "pathname": "/commerce-modules/pricing/tax-inclusive-pricing" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/pricing/workflows/page.mdx", + "pathname": "/commerce-modules/pricing/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/product/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/product/admin-widget-zones" @@ -459,6 +535,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/product/guides/price-with-taxes/page.mdx", "pathname": "/commerce-modules/product/guides/price-with-taxes" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/product/js-sdk/page.mdx", + "pathname": "/commerce-modules/product/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/product/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/product/links-to-other-modules" @@ -467,6 +547,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/product/page.mdx", "pathname": "/commerce-modules/product" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/product/workflows/page.mdx", + "pathname": "/commerce-modules/product/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/promotion/actions/page.mdx", "pathname": "/commerce-modules/promotion/actions" @@ -491,6 +575,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/promotion/extend/page.mdx", "pathname": "/commerce-modules/promotion/extend" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/promotion/js-sdk/page.mdx", + "pathname": "/commerce-modules/promotion/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/promotion/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/promotion/links-to-other-modules" @@ -499,6 +587,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/promotion/page.mdx", "pathname": "/commerce-modules/promotion" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/promotion/workflows/page.mdx", + "pathname": "/commerce-modules/promotion/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/region/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/region/admin-widget-zones" @@ -507,6 +599,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/region/events/page.mdx", "pathname": "/commerce-modules/region/events" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/region/js-sdk/page.mdx", + "pathname": "/commerce-modules/region/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/region/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/region/links-to-other-modules" @@ -515,6 +611,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/region/page.mdx", "pathname": "/commerce-modules/region" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/region/workflows/page.mdx", + "pathname": "/commerce-modules/region/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/sales-channel/admin-widget-zones" @@ -523,6 +623,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx", "pathname": "/commerce-modules/sales-channel/events" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/js-sdk/page.mdx", + "pathname": "/commerce-modules/sales-channel/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/sales-channel/links-to-other-modules" @@ -535,6 +639,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/publishable-api-keys/page.mdx", "pathname": "/commerce-modules/sales-channel/publishable-api-keys" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/sales-channel/workflows/page.mdx", + "pathname": "/commerce-modules/sales-channel/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/stock-location/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/stock-location/admin-widget-zones" @@ -543,6 +651,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/stock-location/concepts/page.mdx", "pathname": "/commerce-modules/stock-location/concepts" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/stock-location/js-sdk/page.mdx", + "pathname": "/commerce-modules/stock-location/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/stock-location/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/stock-location/links-to-other-modules" @@ -551,10 +663,18 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/stock-location/page.mdx", "pathname": "/commerce-modules/stock-location" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/stock-location/workflows/page.mdx", + "pathname": "/commerce-modules/stock-location/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/store/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/store/admin-widget-zones" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/store/js-sdk/page.mdx", + "pathname": "/commerce-modules/store/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/store/links-to-other-modules/page.mdx", "pathname": "/commerce-modules/store/links-to-other-modules" @@ -563,10 +683,18 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/store/page.mdx", "pathname": "/commerce-modules/store" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/store/workflows/page.mdx", + "pathname": "/commerce-modules/store/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/tax/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/tax/admin-widget-zones" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/tax/js-sdk/page.mdx", + "pathname": "/commerce-modules/tax/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/tax/module-options/page.mdx", "pathname": "/commerce-modules/tax/module-options" @@ -587,6 +715,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/tax/tax-region/page.mdx", "pathname": "/commerce-modules/tax/tax-region" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/tax/workflows/page.mdx", + "pathname": "/commerce-modules/tax/workflows" + }, { "filePath": "/www/apps/resources/app/commerce-modules/user/admin-widget-zones/page.mdx", "pathname": "/commerce-modules/user/admin-widget-zones" @@ -595,6 +727,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/user/events/page.mdx", "pathname": "/commerce-modules/user/events" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/user/js-sdk/page.mdx", + "pathname": "/commerce-modules/user/js-sdk" + }, { "filePath": "/www/apps/resources/app/commerce-modules/user/module-options/page.mdx", "pathname": "/commerce-modules/user/module-options" @@ -607,6 +743,10 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/user/user-creation-flows/page.mdx", "pathname": "/commerce-modules/user/user-creation-flows" }, + { + "filePath": "/www/apps/resources/app/commerce-modules/user/workflows/page.mdx", + "pathname": "/commerce-modules/user/workflows" + }, { "filePath": "/www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx", "pathname": "/contribution-guidelines/admin-translations" diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs index f6eea7f5fb..7fc7f7c537 100644 --- a/www/apps/resources/generated/sidebar.mjs +++ b/www/apps/resources/generated/sidebar.mjs @@ -243,124 +243,133 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", + "title": "References", "initialOpen": false, - "autogenerate_tags": "workflow+apiKey", - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createApiKeysWorkflow", - "path": "/references/medusa-workflows/createApiKeysWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteApiKeysWorkflow", - "path": "/references/medusa-workflows/deleteApiKeysWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "revokeApiKeysWorkflow", - "path": "/references/medusa-workflows/revokeApiKeysWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateApiKeysWorkflow", - "path": "/references/medusa-workflows/updateApiKeysWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "initialOpen": false, - "autogenerate_tags": "step+apiKey", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createApiKeysStep", - "path": "/references/medusa-workflows/steps/createApiKeysStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteApiKeysStep", - "path": "/references/medusa-workflows/steps/deleteApiKeysStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "revokeApiKeysStep", - "path": "/references/medusa-workflows/steps/revokeApiKeysStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateApiKeysStep", - "path": "/references/medusa-workflows/steps/updateApiKeysStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+apiKey", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/api-key/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "apiKey", - "path": "/references/js-sdk/admin/apiKey", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+apiKey", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createApiKeysWorkflow", + "path": "/references/medusa-workflows/createApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteApiKeysWorkflow", + "path": "/references/medusa-workflows/deleteApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "revokeApiKeysWorkflow", + "path": "/references/medusa-workflows/revokeApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateApiKeysWorkflow", + "path": "/references/medusa-workflows/updateApiKeysWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+apiKey", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createApiKeysStep", + "path": "/references/medusa-workflows/steps/createApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteApiKeysStep", + "path": "/references/medusa-workflows/steps/deleteApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "revokeApiKeysStep", + "path": "/references/medusa-workflows/steps/revokeApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateApiKeysStep", + "path": "/references/medusa-workflows/steps/updateApiKeysStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+apiKey", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "apiKey", + "path": "/references/js-sdk/admin/apiKey", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -658,76 +667,6 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+auth", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAccountWorkflow", - "path": "/references/medusa-workflows/createCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCustomerAccountWorkflow", - "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptInviteWorkflow", - "path": "/references/medusa-workflows/acceptInviteWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUserAccountWorkflow", - "path": "/references/medusa-workflows/createUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeUserAccountWorkflow", - "path": "/references/medusa-workflows/removeUserAccountWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+auth", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setAuthAppMetadataStep", - "path": "/references/medusa-workflows/steps/setAuthAppMetadataStep", - "children": [] - } - ] - }, { "loaded": true, "isPathHref": true, @@ -761,82 +700,160 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "autogenerate_tags": "jsSdk+auth", - "autogenerate_as_ref": true, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "callback", - "path": "/references/js-sdk/auth/callback", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "login", - "path": "/references/js-sdk/auth/login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "logout", - "path": "/references/js-sdk/auth/logout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refresh", - "path": "/references/js-sdk/auth/refresh", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "register", - "path": "/references/js-sdk/auth/register", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "resetPassword", - "path": "/references/js-sdk/auth/resetPassword", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProvider", - "path": "/references/js-sdk/auth/updateProvider", - "children": [] - } - ] - }, { "loaded": true, "isPathHref": true, "type": "category", "title": "References", "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", + "description": "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+auth", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAccountWorkflow", + "path": "/references/medusa-workflows/createCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCustomerAccountWorkflow", + "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptInviteWorkflow", + "path": "/references/medusa-workflows/acceptInviteWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUserAccountWorkflow", + "path": "/references/medusa-workflows/createUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeUserAccountWorkflow", + "path": "/references/medusa-workflows/removeUserAccountWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+auth", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setAuthAppMetadataStep", + "path": "/references/medusa-workflows/steps/setAuthAppMetadataStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "autogenerate_tags": "jsSdk+auth", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "callback", + "path": "/references/js-sdk/auth/callback", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "login", + "path": "/references/js-sdk/auth/login", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "logout", + "path": "/references/js-sdk/auth/logout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refresh", + "path": "/references/js-sdk/auth/refresh", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "register", + "path": "/references/js-sdk/auth/register", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "resetPassword", + "path": "/references/js-sdk/auth/resetPassword", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProvider", + "path": "/references/js-sdk/auth/updateProvider", + "children": [] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -1216,252 +1233,261 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+cart", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsWorkflow", - "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxLinesWorkflow", - "path": "/references/medusa-workflows/updateTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+cart", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartStep", - "path": "/references/medusa-workflows/steps/addShippingMethodToCartStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartsStep", - "path": "/references/medusa-workflows/steps/createCartsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLineItemAdjustmentsStep", - "path": "/references/medusa-workflows/steps/createLineItemAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLineItemsStep", - "path": "/references/medusa-workflows/steps/createLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingMethodAdjustmentsStep", - "path": "/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getLineItemActionsStep", - "path": "/references/medusa-workflows/steps/getLineItemActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeLineItemAdjustmentsStep", - "path": "/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeShippingMethodAdjustmentsStep", - "path": "/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeShippingMethodFromCartStep", - "path": "/references/medusa-workflows/steps/removeShippingMethodFromCartStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setTaxLinesForItemsStep", - "path": "/references/medusa-workflows/steps/setTaxLinesForItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartsStep", - "path": "/references/medusa-workflows/steps/updateCartsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemsStep", - "path": "/references/medusa-workflows/steps/updateLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsStep", - "path": "/references/medusa-workflows/steps/deleteLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemsStepWithSelector", - "path": "/references/medusa-workflows/steps/updateLineItemsStepWithSelector", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+cart", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/cart/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "cart", - "path": "/references/js-sdk/store/cart", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+cart", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsWorkflow", + "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxLinesWorkflow", + "path": "/references/medusa-workflows/updateTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+cart", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartStep", + "path": "/references/medusa-workflows/steps/addShippingMethodToCartStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartsStep", + "path": "/references/medusa-workflows/steps/createCartsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLineItemAdjustmentsStep", + "path": "/references/medusa-workflows/steps/createLineItemAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLineItemsStep", + "path": "/references/medusa-workflows/steps/createLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingMethodAdjustmentsStep", + "path": "/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getLineItemActionsStep", + "path": "/references/medusa-workflows/steps/getLineItemActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeLineItemAdjustmentsStep", + "path": "/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeShippingMethodAdjustmentsStep", + "path": "/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeShippingMethodFromCartStep", + "path": "/references/medusa-workflows/steps/removeShippingMethodFromCartStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setTaxLinesForItemsStep", + "path": "/references/medusa-workflows/steps/setTaxLinesForItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartsStep", + "path": "/references/medusa-workflows/steps/updateCartsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemsStep", + "path": "/references/medusa-workflows/steps/updateLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsStep", + "path": "/references/medusa-workflows/steps/deleteLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemsStepWithSelector", + "path": "/references/medusa-workflows/steps/updateLineItemsStepWithSelector", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+cart", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cart", + "path": "/references/js-sdk/store/cart", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -2024,39 +2050,40 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "JS SDK", + "type": "sub-category", + "title": "References", "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", + "description": "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+currency", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/currency/js-sdk", + "title": "JS SDK", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "currency", - "path": "/references/js-sdk/admin/currency", - "children": [] + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+currency", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "currency", + "path": "/references/js-sdk/admin/currency", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, { "loaded": true, "isPathHref": true, @@ -2284,358 +2311,368 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+customer", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAccountWorkflow", - "path": "/references/medusa-workflows/createCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAddressesWorkflow", - "path": "/references/medusa-workflows/createCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomersWorkflow", - "path": "/references/medusa-workflows/createCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerAddressesWorkflow", - "path": "/references/medusa-workflows/deleteCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomersWorkflow", - "path": "/references/medusa-workflows/deleteCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCustomerAccountWorkflow", - "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerAddressesWorkflow", - "path": "/references/medusa-workflows/updateCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomersWorkflow", - "path": "/references/medusa-workflows/updateCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerGroupsWorkflow", - "path": "/references/medusa-workflows/createCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerGroupsWorkflow", - "path": "/references/medusa-workflows/deleteCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomerGroupsToCustomerWorkflow", - "path": "/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomersToCustomerGroupWorkflow", - "path": "/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerGroupsWorkflow", - "path": "/references/medusa-workflows/updateCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+customer", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOrCreateCustomerStep", - "path": "/references/medusa-workflows/steps/findOrCreateCustomerStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAddressesStep", - "path": "/references/medusa-workflows/steps/createCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomersStep", - "path": "/references/medusa-workflows/steps/createCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerAddressesStep", - "path": "/references/medusa-workflows/steps/deleteCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomersStep", - "path": "/references/medusa-workflows/steps/deleteCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "maybeUnsetDefaultBillingAddressesStep", - "path": "/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "maybeUnsetDefaultShippingAddressesStep", - "path": "/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerAddressesStep", - "path": "/references/medusa-workflows/steps/updateCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomersStep", - "path": "/references/medusa-workflows/steps/updateCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerGroupsStep", - "path": "/references/medusa-workflows/steps/createCustomerGroupsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerGroupStep", - "path": "/references/medusa-workflows/steps/deleteCustomerGroupStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomerGroupsToCustomerStep", - "path": "/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomersToCustomerGroupStep", - "path": "/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerGroupsStep", - "path": "/references/medusa-workflows/steps/updateCustomerGroupsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+customer", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/customer/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "customer", - "path": "/references/js-sdk/store/customer", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+customer", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "customer", - "path": "/references/js-sdk/admin/customer", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+customer", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAccountWorkflow", + "path": "/references/medusa-workflows/createCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAddressesWorkflow", + "path": "/references/medusa-workflows/createCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomersWorkflow", + "path": "/references/medusa-workflows/createCustomersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerAddressesWorkflow", + "path": "/references/medusa-workflows/deleteCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomersWorkflow", + "path": "/references/medusa-workflows/deleteCustomersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCustomerAccountWorkflow", + "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerAddressesWorkflow", + "path": "/references/medusa-workflows/updateCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomersWorkflow", + "path": "/references/medusa-workflows/updateCustomersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerGroupsWorkflow", + "path": "/references/medusa-workflows/createCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerGroupsWorkflow", + "path": "/references/medusa-workflows/deleteCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomerGroupsToCustomerWorkflow", + "path": "/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomersToCustomerGroupWorkflow", + "path": "/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerGroupsWorkflow", + "path": "/references/medusa-workflows/updateCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + } + ] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "customerGroup", - "path": "/references/js-sdk/admin/customerGroup", - "children": [] + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+customer", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOrCreateCustomerStep", + "path": "/references/medusa-workflows/steps/findOrCreateCustomerStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAddressesStep", + "path": "/references/medusa-workflows/steps/createCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomersStep", + "path": "/references/medusa-workflows/steps/createCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerAddressesStep", + "path": "/references/medusa-workflows/steps/deleteCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomersStep", + "path": "/references/medusa-workflows/steps/deleteCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "maybeUnsetDefaultBillingAddressesStep", + "path": "/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "maybeUnsetDefaultShippingAddressesStep", + "path": "/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerAddressesStep", + "path": "/references/medusa-workflows/steps/updateCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomersStep", + "path": "/references/medusa-workflows/steps/updateCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerGroupsStep", + "path": "/references/medusa-workflows/steps/createCustomerGroupsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerGroupStep", + "path": "/references/medusa-workflows/steps/deleteCustomerGroupStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomerGroupsToCustomerStep", + "path": "/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomersToCustomerGroupStep", + "path": "/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerGroupsStep", + "path": "/references/medusa-workflows/steps/updateCustomerGroupsStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+customer", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Customer Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customer", + "path": "/references/js-sdk/store/customer", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+customer", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customer", + "path": "/references/js-sdk/admin/customer", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customerGroup", + "path": "/references/js-sdk/admin/customerGroup", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -3043,482 +3080,492 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+fulfillment", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "listShippingOptionsForCartWithPricingWorkflow", - "path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchShippingOptionRulesWorkflow", - "path": "/references/medusa-workflows/batchShippingOptionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "calculateShippingOptionsPricesWorkflow", - "path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelFulfillmentWorkflow", - "path": "/references/medusa-workflows/cancelFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentWorkflow", - "path": "/references/medusa-workflows/createFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnFulfillmentWorkflow", - "path": "/references/medusa-workflows/createReturnFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createServiceZonesWorkflow", - "path": "/references/medusa-workflows/createServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShipmentWorkflow", - "path": "/references/medusa-workflows/createShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingProfilesWorkflow", - "path": "/references/medusa-workflows/createShippingProfilesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteFulfillmentSetsWorkflow", - "path": "/references/medusa-workflows/deleteFulfillmentSetsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteServiceZonesWorkflow", - "path": "/references/medusa-workflows/deleteServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionsWorkflow", - "path": "/references/medusa-workflows/deleteShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markFulfillmentAsDeliveredWorkflow", - "path": "/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateFulfillmentWorkflow", - "path": "/references/medusa-workflows/updateFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingProfilesWorkflow", - "path": "/references/medusa-workflows/updateShippingProfilesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createAndCompleteReturnOrderWorkflow", - "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderShipmentWorkflow", - "path": "/references/medusa-workflows/createOrderShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markOrderFulfillmentAsDeliveredWorkflow", - "path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingProfileWorkflow", - "path": "/references/medusa-workflows/deleteShippingProfileWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLocationFulfillmentSetWorkflow", - "path": "/references/medusa-workflows/createLocationFulfillmentSetWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+fulfillment", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateCartShippingOptionsStep", - "path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "calculateShippingOptionsPricesStep", - "path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelFulfillmentStep", - "path": "/references/medusa-workflows/steps/cancelFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentSets", - "path": "/references/medusa-workflows/steps/createFulfillmentSets", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentStep", - "path": "/references/medusa-workflows/steps/createFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnFulfillmentStep", - "path": "/references/medusa-workflows/steps/createReturnFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createServiceZonesStep", - "path": "/references/medusa-workflows/steps/createServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionRulesStep", - "path": "/references/medusa-workflows/steps/createShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingProfilesStep", - "path": "/references/medusa-workflows/steps/createShippingProfilesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteFulfillmentSetsStep", - "path": "/references/medusa-workflows/steps/deleteFulfillmentSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteServiceZonesStep", - "path": "/references/medusa-workflows/steps/deleteServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionRulesStep", - "path": "/references/medusa-workflows/steps/deleteShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionsStep", - "path": "/references/medusa-workflows/steps/deleteShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateFulfillmentStep", - "path": "/references/medusa-workflows/steps/updateFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingProfilesStep", - "path": "/references/medusa-workflows/steps/updateShippingProfilesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "upsertShippingOptionsStep", - "path": "/references/medusa-workflows/steps/upsertShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateShipmentStep", - "path": "/references/medusa-workflows/steps/validateShipmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingProfilesStep", - "path": "/references/medusa-workflows/steps/deleteShippingProfilesStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+fulfillment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillment", - "path": "/references/js-sdk/store/fulfillment", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+fulfillment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillment", - "path": "/references/js-sdk/admin/fulfillment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillmentProvider", - "path": "/references/js-sdk/admin/fulfillmentProvider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillmentSet", - "path": "/references/js-sdk/admin/fulfillmentSet", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "shippingOption", - "path": "/references/js-sdk/admin/shippingOption", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "shippingProfile", - "path": "/references/js-sdk/admin/shippingProfile", - "children": [] - } - ] - } - ] - }, { "loaded": true, "isPathHref": true, "type": "category", "title": "References", "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", + "description": "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+fulfillment", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "listShippingOptionsForCartWithPricingWorkflow", + "path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchShippingOptionRulesWorkflow", + "path": "/references/medusa-workflows/batchShippingOptionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "calculateShippingOptionsPricesWorkflow", + "path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelFulfillmentWorkflow", + "path": "/references/medusa-workflows/cancelFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentWorkflow", + "path": "/references/medusa-workflows/createFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnFulfillmentWorkflow", + "path": "/references/medusa-workflows/createReturnFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createServiceZonesWorkflow", + "path": "/references/medusa-workflows/createServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShipmentWorkflow", + "path": "/references/medusa-workflows/createShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingProfilesWorkflow", + "path": "/references/medusa-workflows/createShippingProfilesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteFulfillmentSetsWorkflow", + "path": "/references/medusa-workflows/deleteFulfillmentSetsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteServiceZonesWorkflow", + "path": "/references/medusa-workflows/deleteServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionsWorkflow", + "path": "/references/medusa-workflows/deleteShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markFulfillmentAsDeliveredWorkflow", + "path": "/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateFulfillmentWorkflow", + "path": "/references/medusa-workflows/updateFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingProfilesWorkflow", + "path": "/references/medusa-workflows/updateShippingProfilesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createAndCompleteReturnOrderWorkflow", + "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderShipmentWorkflow", + "path": "/references/medusa-workflows/createOrderShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markOrderFulfillmentAsDeliveredWorkflow", + "path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingProfileWorkflow", + "path": "/references/medusa-workflows/deleteShippingProfileWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLocationFulfillmentSetWorkflow", + "path": "/references/medusa-workflows/createLocationFulfillmentSetWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+fulfillment", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateCartShippingOptionsStep", + "path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "calculateShippingOptionsPricesStep", + "path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelFulfillmentStep", + "path": "/references/medusa-workflows/steps/cancelFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentSets", + "path": "/references/medusa-workflows/steps/createFulfillmentSets", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentStep", + "path": "/references/medusa-workflows/steps/createFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnFulfillmentStep", + "path": "/references/medusa-workflows/steps/createReturnFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createServiceZonesStep", + "path": "/references/medusa-workflows/steps/createServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionRulesStep", + "path": "/references/medusa-workflows/steps/createShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingProfilesStep", + "path": "/references/medusa-workflows/steps/createShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteFulfillmentSetsStep", + "path": "/references/medusa-workflows/steps/deleteFulfillmentSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteServiceZonesStep", + "path": "/references/medusa-workflows/steps/deleteServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionRulesStep", + "path": "/references/medusa-workflows/steps/deleteShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionsStep", + "path": "/references/medusa-workflows/steps/deleteShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateFulfillmentStep", + "path": "/references/medusa-workflows/steps/updateFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingProfilesStep", + "path": "/references/medusa-workflows/steps/updateShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "upsertShippingOptionsStep", + "path": "/references/medusa-workflows/steps/upsertShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateShipmentStep", + "path": "/references/medusa-workflows/steps/validateShipmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingProfilesStep", + "path": "/references/medusa-workflows/steps/deleteShippingProfilesStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+fulfillment", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillment", + "path": "/references/js-sdk/store/fulfillment", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+fulfillment", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillment", + "path": "/references/js-sdk/admin/fulfillment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillmentProvider", + "path": "/references/js-sdk/admin/fulfillmentProvider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillmentSet", + "path": "/references/js-sdk/admin/fulfillmentSet", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "shippingOption", + "path": "/references/js-sdk/admin/shippingOption", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "shippingProfile", + "path": "/references/js-sdk/admin/shippingProfile", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -4311,444 +4358,453 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+inventory", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmVariantInventoryWorkflow", - "path": "/references/medusa-workflows/confirmVariantInventoryWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "bulkCreateDeleteLevelsWorkflow", - "path": "/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryItemsWorkflow", - "path": "/references/medusa-workflows/createInventoryItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryLevelsWorkflow", - "path": "/references/medusa-workflows/createInventoryLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInventoryItemWorkflow", - "path": "/references/medusa-workflows/deleteInventoryItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryItemsWorkflow", - "path": "/references/medusa-workflows/updateInventoryItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryLevelsWorkflow", - "path": "/references/medusa-workflows/updateInventoryLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimWorkflow", - "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeWorkflow", - "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnReceiveWorkflow", - "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsWorkflow", - "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsWorkflow", - "path": "/references/medusa-workflows/deleteProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReservationsWorkflow", - "path": "/references/medusa-workflows/createReservationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsByLineItemsWorkflow", - "path": "/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsWorkflow", - "path": "/references/medusa-workflows/deleteReservationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReservationsWorkflow", - "path": "/references/medusa-workflows/updateReservationsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+inventory", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmInventoryStep", - "path": "/references/medusa-workflows/steps/confirmInventoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "reserveInventoryStep", - "path": "/references/medusa-workflows/steps/reserveInventoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "adjustInventoryLevelsStep", - "path": "/references/medusa-workflows/steps/adjustInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryItemsStep", - "path": "/references/medusa-workflows/steps/createInventoryItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryLevelsStep", - "path": "/references/medusa-workflows/steps/createInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInventoryItemStep", - "path": "/references/medusa-workflows/steps/deleteInventoryItemStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryItemsStep", - "path": "/references/medusa-workflows/steps/updateInventoryItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryLevelsStep", - "path": "/references/medusa-workflows/steps/updateInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReservationsStep", - "path": "/references/medusa-workflows/steps/createReservationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsByLineItemsStep", - "path": "/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsStep", - "path": "/references/medusa-workflows/steps/deleteReservationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReservationsStep", - "path": "/references/medusa-workflows/steps/updateReservationsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+inventory", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/inventory/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "inventoryItem", - "path": "/references/js-sdk/admin/inventoryItem", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+inventory", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmVariantInventoryWorkflow", + "path": "/references/medusa-workflows/confirmVariantInventoryWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "bulkCreateDeleteLevelsWorkflow", + "path": "/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryItemsWorkflow", + "path": "/references/medusa-workflows/createInventoryItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryLevelsWorkflow", + "path": "/references/medusa-workflows/createInventoryLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInventoryItemWorkflow", + "path": "/references/medusa-workflows/deleteInventoryItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryItemsWorkflow", + "path": "/references/medusa-workflows/updateInventoryItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryLevelsWorkflow", + "path": "/references/medusa-workflows/updateInventoryLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimWorkflow", + "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeWorkflow", + "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnReceiveWorkflow", + "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsWorkflow", + "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsWorkflow", + "path": "/references/medusa-workflows/deleteProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReservationsWorkflow", + "path": "/references/medusa-workflows/createReservationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsByLineItemsWorkflow", + "path": "/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsWorkflow", + "path": "/references/medusa-workflows/deleteReservationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReservationsWorkflow", + "path": "/references/medusa-workflows/updateReservationsWorkflow", + "children": [] + } + ] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "reservation", - "path": "/references/js-sdk/admin/reservation", - "children": [] + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+inventory", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmInventoryStep", + "path": "/references/medusa-workflows/steps/confirmInventoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "reserveInventoryStep", + "path": "/references/medusa-workflows/steps/reserveInventoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "adjustInventoryLevelsStep", + "path": "/references/medusa-workflows/steps/adjustInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryItemsStep", + "path": "/references/medusa-workflows/steps/createInventoryItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryLevelsStep", + "path": "/references/medusa-workflows/steps/createInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInventoryItemStep", + "path": "/references/medusa-workflows/steps/deleteInventoryItemStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryItemsStep", + "path": "/references/medusa-workflows/steps/updateInventoryItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryLevelsStep", + "path": "/references/medusa-workflows/steps/updateInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReservationsStep", + "path": "/references/medusa-workflows/steps/createReservationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsByLineItemsStep", + "path": "/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsStep", + "path": "/references/medusa-workflows/steps/deleteReservationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReservationsStep", + "path": "/references/medusa-workflows/steps/updateReservationsStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+inventory", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "inventoryItem", + "path": "/references/js-sdk/admin/inventoryItem", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "reservation", + "path": "/references/js-sdk/admin/reservation", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -5240,1122 +5296,1132 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+order", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptOrderTransferWorkflow", - "path": "/references/medusa-workflows/acceptOrderTransferWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "archiveOrderWorkflow", - "path": "/references/medusa-workflows/archiveOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginClaimOrderWorkflow", - "path": "/references/medusa-workflows/beginClaimOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginExchangeOrderWorkflow", - "path": "/references/medusa-workflows/beginExchangeOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginOrderEditOrderWorkflow", - "path": "/references/medusa-workflows/beginOrderEditOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginReceiveReturnWorkflow", - "path": "/references/medusa-workflows/beginReceiveReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginReturnOrderWorkflow", - "path": "/references/medusa-workflows/beginReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderClaimWorkflow", - "path": "/references/medusa-workflows/cancelBeginOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderEditWorkflow", - "path": "/references/medusa-workflows/cancelBeginOrderEditWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderExchangeWorkflow", - "path": "/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderChangeWorkflow", - "path": "/references/medusa-workflows/cancelOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimWorkflow", - "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeWorkflow", - "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderTransferRequestWorkflow", - "path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnReceiveWorkflow", - "path": "/references/medusa-workflows/cancelReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnRequestWorkflow", - "path": "/references/medusa-workflows/cancelReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnWorkflow", - "path": "/references/medusa-workflows/cancelReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeOrderWorkflow", - "path": "/references/medusa-workflows/completeOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnReceiveWorkflow", - "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createAndCompleteReturnOrderWorkflow", - "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createClaimShippingMethodWorkflow", - "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createExchangeShippingMethodWorkflow", - "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderChangeWorkflow", - "path": "/references/medusa-workflows/createOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderEditShippingMethodWorkflow", - "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderShipmentWorkflow", - "path": "/references/medusa-workflows/createOrderShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnShippingMethodWorkflow", - "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderChangeWorkflow", - "path": "/references/medusa-workflows/declineOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderTransferRequestWorkflow", - "path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeActionsWorkflow", - "path": "/references/medusa-workflows/deleteOrderChangeActionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeWorkflow", - "path": "/references/medusa-workflows/deleteOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "dismissItemReturnRequestWorkflow", - "path": "/references/medusa-workflows/dismissItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markPaymentCollectionAsPaid", - "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimItemWorkflow", - "path": "/references/medusa-workflows/orderClaimItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimRequestItemReturnWorkflow", - "path": "/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditUpdateItemQuantityWorkflow", - "path": "/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeRequestItemReturnWorkflow", - "path": "/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "receiveItemReturnRequestWorkflow", - "path": "/references/medusa-workflows/receiveItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeAddItemClaimActionWorkflow", - "path": "/references/medusa-workflows/removeAddItemClaimActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeClaimShippingMethodWorkflow", - "path": "/references/medusa-workflows/removeClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeExchangeShippingMethodWorkflow", - "path": "/references/medusa-workflows/removeExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemClaimActionWorkflow", - "path": "/references/medusa-workflows/removeItemClaimActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemExchangeActionWorkflow", - "path": "/references/medusa-workflows/removeItemExchangeActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemOrderEditActionWorkflow", - "path": "/references/medusa-workflows/removeItemOrderEditActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemReceiveReturnActionWorkflow", - "path": "/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemReturnActionWorkflow", - "path": "/references/medusa-workflows/removeItemReturnActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeOrderEditShippingMethodWorkflow", - "path": "/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeReturnShippingMethodWorkflow", - "path": "/references/medusa-workflows/removeReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestItemReturnWorkflow", - "path": "/references/medusa-workflows/requestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderEditRequestWorkflow", - "path": "/references/medusa-workflows/requestOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderTransferWorkflow", - "path": "/references/medusa-workflows/requestOrderTransferWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimAddItemWorkflow", - "path": "/references/medusa-workflows/updateClaimAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimItemWorkflow", - "path": "/references/medusa-workflows/updateClaimItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimShippingMethodWorkflow", - "path": "/references/medusa-workflows/updateClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateExchangeAddItemWorkflow", - "path": "/references/medusa-workflows/updateExchangeAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateExchangeShippingMethodWorkflow", - "path": "/references/medusa-workflows/updateExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangeActionsWorkflow", - "path": "/references/medusa-workflows/updateOrderChangeActionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangesWorkflow", - "path": "/references/medusa-workflows/updateOrderChangesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditAddItemWorkflow", - "path": "/references/medusa-workflows/updateOrderEditAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditItemQuantityWorkflow", - "path": "/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditShippingMethodWorkflow", - "path": "/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderTaxLinesWorkflow", - "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderWorkflow", - "path": "/references/medusa-workflows/updateOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReceiveItemReturnRequestWorkflow", - "path": "/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRequestItemReturnWorkflow", - "path": "/references/medusa-workflows/updateRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnShippingMethodWorkflow", - "path": "/references/medusa-workflows/updateReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnWorkflow", - "path": "/references/medusa-workflows/updateReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentWorkflow", - "path": "/references/medusa-workflows/capturePaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "processPaymentWorkflow", - "path": "/references/medusa-workflows/processPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentWorkflow", - "path": "/references/medusa-workflows/refundPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsWorkflow", - "path": "/references/medusa-workflows/refundPaymentsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnReasonsWorkflow", - "path": "/references/medusa-workflows/createReturnReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnReasonsWorkflow", - "path": "/references/medusa-workflows/deleteReturnReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnReasonsWorkflow", - "path": "/references/medusa-workflows/updateReturnReasonsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+order", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderTransactionStep", - "path": "/references/medusa-workflows/steps/addOrderTransactionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "archiveOrdersStep", - "path": "/references/medusa-workflows/steps/archiveOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderChangeStep", - "path": "/references/medusa-workflows/steps/cancelOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimStep", - "path": "/references/medusa-workflows/steps/cancelOrderClaimStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeStep", - "path": "/references/medusa-workflows/steps/cancelOrderExchangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentStep", - "path": "/references/medusa-workflows/steps/cancelOrderFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderReturnStep", - "path": "/references/medusa-workflows/steps/cancelOrderReturnStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrdersStep", - "path": "/references/medusa-workflows/steps/cancelOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeOrdersStep", - "path": "/references/medusa-workflows/steps/completeOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCompleteReturnStep", - "path": "/references/medusa-workflows/steps/createCompleteReturnStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderChangeStep", - "path": "/references/medusa-workflows/steps/createOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderClaimItemsFromActionsStep", - "path": "/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderClaimsStep", - "path": "/references/medusa-workflows/steps/createOrderClaimsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderExchangeItemsFromActionsStep", - "path": "/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderExchangesStep", - "path": "/references/medusa-workflows/steps/createOrderExchangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderLineItemsStep", - "path": "/references/medusa-workflows/steps/createOrderLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrdersStep", - "path": "/references/medusa-workflows/steps/createOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnsStep", - "path": "/references/medusa-workflows/steps/createReturnsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderChangeStep", - "path": "/references/medusa-workflows/steps/declineOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteClaimsStep", - "path": "/references/medusa-workflows/steps/deleteClaimsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteExchangesStep", - "path": "/references/medusa-workflows/steps/deleteExchangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeActionsStep", - "path": "/references/medusa-workflows/steps/deleteOrderChangeActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangesStep", - "path": "/references/medusa-workflows/steps/deleteOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderShippingMethods", - "path": "/references/medusa-workflows/steps/deleteOrderShippingMethods", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnsStep", - "path": "/references/medusa-workflows/steps/deleteReturnsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "previewOrderChangeStep", - "path": "/references/medusa-workflows/steps/previewOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderChangesStep", - "path": "/references/medusa-workflows/steps/registerOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderFulfillmentStep", - "path": "/references/medusa-workflows/steps/registerOrderFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderShipmentStep", - "path": "/references/medusa-workflows/steps/registerOrderShipmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setOrderTaxLinesForItemsStep", - "path": "/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangeActionsStep", - "path": "/references/medusa-workflows/steps/updateOrderChangeActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangesStep", - "path": "/references/medusa-workflows/steps/updateOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderExchangesStep", - "path": "/references/medusa-workflows/steps/updateOrderExchangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderShippingMethodsStep", - "path": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrdersStep", - "path": "/references/medusa-workflows/steps/updateOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnReasonsStep", - "path": "/references/medusa-workflows/steps/createReturnReasonsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnReasonStep", - "path": "/references/medusa-workflows/steps/deleteReturnReasonStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnReasonsStep", - "path": "/references/medusa-workflows/steps/updateReturnReasonsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+order", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "order", - "path": "/references/js-sdk/store/order", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+order", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "claim", - "path": "/references/js-sdk/admin/claim", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "exchange", - "path": "/references/js-sdk/admin/exchange", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "order", - "path": "/references/js-sdk/admin/order", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEdit", - "path": "/references/js-sdk/admin/orderEdit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundReason", - "path": "/references/js-sdk/admin/refundReason", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "return", - "path": "/references/js-sdk/admin/return", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "returnReason", - "path": "/references/js-sdk/admin/returnReason", - "children": [] - } - ] - } - ] - }, { "loaded": true, "isPathHref": true, "type": "category", "title": "References", "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", + "description": "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+order", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptOrderTransferWorkflow", + "path": "/references/medusa-workflows/acceptOrderTransferWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "archiveOrderWorkflow", + "path": "/references/medusa-workflows/archiveOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginClaimOrderWorkflow", + "path": "/references/medusa-workflows/beginClaimOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginExchangeOrderWorkflow", + "path": "/references/medusa-workflows/beginExchangeOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginOrderEditOrderWorkflow", + "path": "/references/medusa-workflows/beginOrderEditOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginReceiveReturnWorkflow", + "path": "/references/medusa-workflows/beginReceiveReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginReturnOrderWorkflow", + "path": "/references/medusa-workflows/beginReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderClaimWorkflow", + "path": "/references/medusa-workflows/cancelBeginOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderEditWorkflow", + "path": "/references/medusa-workflows/cancelBeginOrderEditWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderExchangeWorkflow", + "path": "/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderChangeWorkflow", + "path": "/references/medusa-workflows/cancelOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimWorkflow", + "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeWorkflow", + "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderTransferRequestWorkflow", + "path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnReceiveWorkflow", + "path": "/references/medusa-workflows/cancelReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnRequestWorkflow", + "path": "/references/medusa-workflows/cancelReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnWorkflow", + "path": "/references/medusa-workflows/cancelReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeOrderWorkflow", + "path": "/references/medusa-workflows/completeOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnReceiveWorkflow", + "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createAndCompleteReturnOrderWorkflow", + "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createClaimShippingMethodWorkflow", + "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createExchangeShippingMethodWorkflow", + "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderChangeWorkflow", + "path": "/references/medusa-workflows/createOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderEditShippingMethodWorkflow", + "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderShipmentWorkflow", + "path": "/references/medusa-workflows/createOrderShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnShippingMethodWorkflow", + "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderChangeWorkflow", + "path": "/references/medusa-workflows/declineOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderTransferRequestWorkflow", + "path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeActionsWorkflow", + "path": "/references/medusa-workflows/deleteOrderChangeActionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeWorkflow", + "path": "/references/medusa-workflows/deleteOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "dismissItemReturnRequestWorkflow", + "path": "/references/medusa-workflows/dismissItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markPaymentCollectionAsPaid", + "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimItemWorkflow", + "path": "/references/medusa-workflows/orderClaimItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimRequestItemReturnWorkflow", + "path": "/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditUpdateItemQuantityWorkflow", + "path": "/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeRequestItemReturnWorkflow", + "path": "/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "receiveItemReturnRequestWorkflow", + "path": "/references/medusa-workflows/receiveItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeAddItemClaimActionWorkflow", + "path": "/references/medusa-workflows/removeAddItemClaimActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeClaimShippingMethodWorkflow", + "path": "/references/medusa-workflows/removeClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeExchangeShippingMethodWorkflow", + "path": "/references/medusa-workflows/removeExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemClaimActionWorkflow", + "path": "/references/medusa-workflows/removeItemClaimActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemExchangeActionWorkflow", + "path": "/references/medusa-workflows/removeItemExchangeActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemOrderEditActionWorkflow", + "path": "/references/medusa-workflows/removeItemOrderEditActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemReceiveReturnActionWorkflow", + "path": "/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemReturnActionWorkflow", + "path": "/references/medusa-workflows/removeItemReturnActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeOrderEditShippingMethodWorkflow", + "path": "/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeReturnShippingMethodWorkflow", + "path": "/references/medusa-workflows/removeReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestItemReturnWorkflow", + "path": "/references/medusa-workflows/requestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderEditRequestWorkflow", + "path": "/references/medusa-workflows/requestOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderTransferWorkflow", + "path": "/references/medusa-workflows/requestOrderTransferWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimAddItemWorkflow", + "path": "/references/medusa-workflows/updateClaimAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimItemWorkflow", + "path": "/references/medusa-workflows/updateClaimItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimShippingMethodWorkflow", + "path": "/references/medusa-workflows/updateClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateExchangeAddItemWorkflow", + "path": "/references/medusa-workflows/updateExchangeAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateExchangeShippingMethodWorkflow", + "path": "/references/medusa-workflows/updateExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangeActionsWorkflow", + "path": "/references/medusa-workflows/updateOrderChangeActionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangesWorkflow", + "path": "/references/medusa-workflows/updateOrderChangesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditAddItemWorkflow", + "path": "/references/medusa-workflows/updateOrderEditAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditItemQuantityWorkflow", + "path": "/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditShippingMethodWorkflow", + "path": "/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderTaxLinesWorkflow", + "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderWorkflow", + "path": "/references/medusa-workflows/updateOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReceiveItemReturnRequestWorkflow", + "path": "/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRequestItemReturnWorkflow", + "path": "/references/medusa-workflows/updateRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnShippingMethodWorkflow", + "path": "/references/medusa-workflows/updateReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnWorkflow", + "path": "/references/medusa-workflows/updateReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentWorkflow", + "path": "/references/medusa-workflows/capturePaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "processPaymentWorkflow", + "path": "/references/medusa-workflows/processPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentWorkflow", + "path": "/references/medusa-workflows/refundPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsWorkflow", + "path": "/references/medusa-workflows/refundPaymentsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnReasonsWorkflow", + "path": "/references/medusa-workflows/createReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnReasonsWorkflow", + "path": "/references/medusa-workflows/deleteReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnReasonsWorkflow", + "path": "/references/medusa-workflows/updateReturnReasonsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+order", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderTransactionStep", + "path": "/references/medusa-workflows/steps/addOrderTransactionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "archiveOrdersStep", + "path": "/references/medusa-workflows/steps/archiveOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderChangeStep", + "path": "/references/medusa-workflows/steps/cancelOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimStep", + "path": "/references/medusa-workflows/steps/cancelOrderClaimStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeStep", + "path": "/references/medusa-workflows/steps/cancelOrderExchangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentStep", + "path": "/references/medusa-workflows/steps/cancelOrderFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderReturnStep", + "path": "/references/medusa-workflows/steps/cancelOrderReturnStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrdersStep", + "path": "/references/medusa-workflows/steps/cancelOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeOrdersStep", + "path": "/references/medusa-workflows/steps/completeOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCompleteReturnStep", + "path": "/references/medusa-workflows/steps/createCompleteReturnStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderChangeStep", + "path": "/references/medusa-workflows/steps/createOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderClaimItemsFromActionsStep", + "path": "/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderClaimsStep", + "path": "/references/medusa-workflows/steps/createOrderClaimsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderExchangeItemsFromActionsStep", + "path": "/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderExchangesStep", + "path": "/references/medusa-workflows/steps/createOrderExchangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderLineItemsStep", + "path": "/references/medusa-workflows/steps/createOrderLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrdersStep", + "path": "/references/medusa-workflows/steps/createOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnsStep", + "path": "/references/medusa-workflows/steps/createReturnsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderChangeStep", + "path": "/references/medusa-workflows/steps/declineOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteClaimsStep", + "path": "/references/medusa-workflows/steps/deleteClaimsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteExchangesStep", + "path": "/references/medusa-workflows/steps/deleteExchangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeActionsStep", + "path": "/references/medusa-workflows/steps/deleteOrderChangeActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangesStep", + "path": "/references/medusa-workflows/steps/deleteOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderShippingMethods", + "path": "/references/medusa-workflows/steps/deleteOrderShippingMethods", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnsStep", + "path": "/references/medusa-workflows/steps/deleteReturnsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "previewOrderChangeStep", + "path": "/references/medusa-workflows/steps/previewOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderChangesStep", + "path": "/references/medusa-workflows/steps/registerOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderFulfillmentStep", + "path": "/references/medusa-workflows/steps/registerOrderFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderShipmentStep", + "path": "/references/medusa-workflows/steps/registerOrderShipmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setOrderTaxLinesForItemsStep", + "path": "/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangeActionsStep", + "path": "/references/medusa-workflows/steps/updateOrderChangeActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangesStep", + "path": "/references/medusa-workflows/steps/updateOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderExchangesStep", + "path": "/references/medusa-workflows/steps/updateOrderExchangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderShippingMethodsStep", + "path": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrdersStep", + "path": "/references/medusa-workflows/steps/updateOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnReasonsStep", + "path": "/references/medusa-workflows/steps/createReturnReasonsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnReasonStep", + "path": "/references/medusa-workflows/steps/deleteReturnReasonStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnReasonsStep", + "path": "/references/medusa-workflows/steps/updateReturnReasonsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+order", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Order Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "order", + "path": "/references/js-sdk/store/order", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+order", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Order Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "claim", + "path": "/references/js-sdk/admin/claim", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "exchange", + "path": "/references/js-sdk/admin/exchange", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "order", + "path": "/references/js-sdk/admin/order", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEdit", + "path": "/references/js-sdk/admin/orderEdit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundReason", + "path": "/references/js-sdk/admin/refundReason", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "return", + "path": "/references/js-sdk/admin/return", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "returnReason", + "path": "/references/js-sdk/admin/returnReason", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -7804,236 +7870,6 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+payment", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentCollectionForCartWorkflow", - "path": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshPaymentCollectionForCartWorkflow", - "path": "/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderPaymentCollectionWorkflow", - "path": "/references/medusa-workflows/createOrderPaymentCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markPaymentCollectionAsPaid", - "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentWorkflow", - "path": "/references/medusa-workflows/capturePaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "processPaymentWorkflow", - "path": "/references/medusa-workflows/processPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentWorkflow", - "path": "/references/medusa-workflows/refundPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsWorkflow", - "path": "/references/medusa-workflows/refundPaymentsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentSessionsWorkflow", - "path": "/references/medusa-workflows/createPaymentSessionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRefundReasonsWorkflow", - "path": "/references/medusa-workflows/createRefundReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePaymentSessionsWorkflow", - "path": "/references/medusa-workflows/deletePaymentSessionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRefundReasonsWorkflow", - "path": "/references/medusa-workflows/updateRefundReasonsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+payment", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentCollectionsStep", - "path": "/references/medusa-workflows/steps/createPaymentCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "authorizePaymentSessionStep", - "path": "/references/medusa-workflows/steps/authorizePaymentSessionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelPaymentStep", - "path": "/references/medusa-workflows/steps/cancelPaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentStep", - "path": "/references/medusa-workflows/steps/capturePaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentStep", - "path": "/references/medusa-workflows/steps/refundPaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsStep", - "path": "/references/medusa-workflows/steps/refundPaymentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentSessionStep", - "path": "/references/medusa-workflows/steps/createPaymentSessionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRefundReasonStep", - "path": "/references/medusa-workflows/steps/createRefundReasonStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePaymentSessionsStep", - "path": "/references/medusa-workflows/steps/deletePaymentSessionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePaymentCollectionStep", - "path": "/references/medusa-workflows/steps/updatePaymentCollectionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRefundReasonsStep", - "path": "/references/medusa-workflows/steps/updateRefundReasonsStep", - "children": [] - } - ] - }, { "loaded": true, "isPathHref": true, @@ -8055,64 +7891,304 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "JS SDK", + "title": "References", "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", + "description": "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+payment", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/payment/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "payment", - "path": "/references/js-sdk/store/payment", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+payment", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentCollectionForCartWorkflow", + "path": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshPaymentCollectionForCartWorkflow", + "path": "/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderPaymentCollectionWorkflow", + "path": "/references/medusa-workflows/createOrderPaymentCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markPaymentCollectionAsPaid", + "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentWorkflow", + "path": "/references/medusa-workflows/capturePaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "processPaymentWorkflow", + "path": "/references/medusa-workflows/processPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentWorkflow", + "path": "/references/medusa-workflows/refundPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsWorkflow", + "path": "/references/medusa-workflows/refundPaymentsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentSessionsWorkflow", + "path": "/references/medusa-workflows/createPaymentSessionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRefundReasonsWorkflow", + "path": "/references/medusa-workflows/createRefundReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePaymentSessionsWorkflow", + "path": "/references/medusa-workflows/deletePaymentSessionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRefundReasonsWorkflow", + "path": "/references/medusa-workflows/updateRefundReasonsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+payment", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentCollectionsStep", + "path": "/references/medusa-workflows/steps/createPaymentCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "authorizePaymentSessionStep", + "path": "/references/medusa-workflows/steps/authorizePaymentSessionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelPaymentStep", + "path": "/references/medusa-workflows/steps/cancelPaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentStep", + "path": "/references/medusa-workflows/steps/capturePaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentStep", + "path": "/references/medusa-workflows/steps/refundPaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsStep", + "path": "/references/medusa-workflows/steps/refundPaymentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentSessionStep", + "path": "/references/medusa-workflows/steps/createPaymentSessionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRefundReasonStep", + "path": "/references/medusa-workflows/steps/createRefundReasonStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePaymentSessionsStep", + "path": "/references/medusa-workflows/steps/deletePaymentSessionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePaymentCollectionStep", + "path": "/references/medusa-workflows/steps/updatePaymentCollectionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRefundReasonsStep", + "path": "/references/medusa-workflows/steps/updateRefundReasonsStep", + "children": [] + } + ] } ] }, { "loaded": true, "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+payment", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/payment/js-sdk", + "title": "JS SDK", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "payment", - "path": "/references/js-sdk/admin/payment", - "children": [] + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+payment", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "payment", + "path": "/references/js-sdk/store/payment", + "children": [] + } + ] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "paymentCollection", - "path": "/references/js-sdk/admin/paymentCollection", - "children": [] + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+payment", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "payment", + "path": "/references/js-sdk/admin/payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "paymentCollection", + "path": "/references/js-sdk/admin/paymentCollection", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, { "loaded": true, "isPathHref": true, @@ -8628,372 +8704,381 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+pricing", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchPriceListPricesWorkflow", - "path": "/references/medusa-workflows/batchPriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListPricesWorkflow", - "path": "/references/medusa-workflows/createPriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListsWorkflow", - "path": "/references/medusa-workflows/createPriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePriceListsWorkflow", - "path": "/references/medusa-workflows/deletePriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removePriceListPricesWorkflow", - "path": "/references/medusa-workflows/removePriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListPricesWorkflow", - "path": "/references/medusa-workflows/updatePriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListsWorkflow", - "path": "/references/medusa-workflows/updatePriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPricePreferencesWorkflow", - "path": "/references/medusa-workflows/createPricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePricePreferencesWorkflow", - "path": "/references/medusa-workflows/deletePricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesWorkflow", - "path": "/references/medusa-workflows/updatePricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsWorkflow", - "path": "/references/medusa-workflows/updateProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsWorkflow", - "path": "/references/medusa-workflows/updateProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "upsertVariantPricesWorkflow", - "path": "/references/medusa-workflows/upsertVariantPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresWorkflow", - "path": "/references/medusa-workflows/createStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresWorkflow", - "path": "/references/medusa-workflows/updateStoresWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+pricing", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsPriceSetsStep", - "path": "/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setShippingOptionsPricesStep", - "path": "/references/medusa-workflows/steps/setShippingOptionsPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListPricesStep", - "path": "/references/medusa-workflows/steps/createPriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListsStep", - "path": "/references/medusa-workflows/steps/createPriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePriceListsStep", - "path": "/references/medusa-workflows/steps/deletePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removePriceListPricesStep", - "path": "/references/medusa-workflows/steps/removePriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListPricesStep", - "path": "/references/medusa-workflows/steps/updatePriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListsStep", - "path": "/references/medusa-workflows/steps/updatePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validatePriceListsStep", - "path": "/references/medusa-workflows/steps/validatePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPricePreferencesStep", - "path": "/references/medusa-workflows/steps/createPricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceSetsStep", - "path": "/references/medusa-workflows/steps/createPriceSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePricePreferencesStep", - "path": "/references/medusa-workflows/steps/deletePricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesAsArrayStep", - "path": "/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesStep", - "path": "/references/medusa-workflows/steps/updatePricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceSetsStep", - "path": "/references/medusa-workflows/steps/updatePriceSetsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+pricing", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/pricing/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "priceList", - "path": "/references/js-sdk/admin/priceList", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+pricing", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchPriceListPricesWorkflow", + "path": "/references/medusa-workflows/batchPriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListPricesWorkflow", + "path": "/references/medusa-workflows/createPriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListsWorkflow", + "path": "/references/medusa-workflows/createPriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePriceListsWorkflow", + "path": "/references/medusa-workflows/deletePriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removePriceListPricesWorkflow", + "path": "/references/medusa-workflows/removePriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListPricesWorkflow", + "path": "/references/medusa-workflows/updatePriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListsWorkflow", + "path": "/references/medusa-workflows/updatePriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPricePreferencesWorkflow", + "path": "/references/medusa-workflows/createPricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePricePreferencesWorkflow", + "path": "/references/medusa-workflows/deletePricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesWorkflow", + "path": "/references/medusa-workflows/updatePricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsWorkflow", + "path": "/references/medusa-workflows/updateProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsWorkflow", + "path": "/references/medusa-workflows/updateProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "upsertVariantPricesWorkflow", + "path": "/references/medusa-workflows/upsertVariantPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresWorkflow", + "path": "/references/medusa-workflows/createStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresWorkflow", + "path": "/references/medusa-workflows/updateStoresWorkflow", + "children": [] + } + ] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "pricePreference", - "path": "/references/js-sdk/admin/pricePreference", - "children": [] + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+pricing", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsPriceSetsStep", + "path": "/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setShippingOptionsPricesStep", + "path": "/references/medusa-workflows/steps/setShippingOptionsPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListPricesStep", + "path": "/references/medusa-workflows/steps/createPriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListsStep", + "path": "/references/medusa-workflows/steps/createPriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePriceListsStep", + "path": "/references/medusa-workflows/steps/deletePriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removePriceListPricesStep", + "path": "/references/medusa-workflows/steps/removePriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListPricesStep", + "path": "/references/medusa-workflows/steps/updatePriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListsStep", + "path": "/references/medusa-workflows/steps/updatePriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validatePriceListsStep", + "path": "/references/medusa-workflows/steps/validatePriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPricePreferencesStep", + "path": "/references/medusa-workflows/steps/createPricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceSetsStep", + "path": "/references/medusa-workflows/steps/createPriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePricePreferencesStep", + "path": "/references/medusa-workflows/steps/deletePricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesAsArrayStep", + "path": "/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesStep", + "path": "/references/medusa-workflows/steps/updatePricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceSetsStep", + "path": "/references/medusa-workflows/steps/updatePriceSetsStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+pricing", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "priceList", + "path": "/references/js-sdk/admin/priceList", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "pricePreference", + "path": "/references/js-sdk/admin/pricePreference", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -9660,538 +9745,548 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+product", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCollectionWorkflow", - "path": "/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCollectionsWorkflow", - "path": "/references/medusa-workflows/createCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductOptionsWorkflow", - "path": "/references/medusa-workflows/createProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTagsWorkflow", - "path": "/references/medusa-workflows/createProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTypesWorkflow", - "path": "/references/medusa-workflows/createProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCollectionsWorkflow", - "path": "/references/medusa-workflows/deleteCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductOptionsWorkflow", - "path": "/references/medusa-workflows/deleteProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTagsWorkflow", - "path": "/references/medusa-workflows/deleteProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTypesWorkflow", - "path": "/references/medusa-workflows/deleteProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsWorkflow", - "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsWorkflow", - "path": "/references/medusa-workflows/deleteProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCollectionsWorkflow", - "path": "/references/medusa-workflows/updateCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductOptionsWorkflow", - "path": "/references/medusa-workflows/updateProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTagsWorkflow", - "path": "/references/medusa-workflows/updateProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTypesWorkflow", - "path": "/references/medusa-workflows/updateProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsWorkflow", - "path": "/references/medusa-workflows/updateProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsWorkflow", - "path": "/references/medusa-workflows/updateProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductCategoriesWorkflow", - "path": "/references/medusa-workflows/createProductCategoriesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductCategoriesWorkflow", - "path": "/references/medusa-workflows/deleteProductCategoriesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductCategoriesWorkflow", - "path": "/references/medusa-workflows/updateProductCategoriesWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+product", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCollectionStep", - "path": "/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCollectionsStep", - "path": "/references/medusa-workflows/steps/createCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductOptionsStep", - "path": "/references/medusa-workflows/steps/createProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTagsStep", - "path": "/references/medusa-workflows/steps/createProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTypesStep", - "path": "/references/medusa-workflows/steps/createProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsStep", - "path": "/references/medusa-workflows/steps/createProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsStep", - "path": "/references/medusa-workflows/steps/createProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCollectionsStep", - "path": "/references/medusa-workflows/steps/deleteCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductOptionsStep", - "path": "/references/medusa-workflows/steps/deleteProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTagsStep", - "path": "/references/medusa-workflows/steps/deleteProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTypesStep", - "path": "/references/medusa-workflows/steps/deleteProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsStep", - "path": "/references/medusa-workflows/steps/deleteProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsStep", - "path": "/references/medusa-workflows/steps/deleteProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getProductsStep", - "path": "/references/medusa-workflows/steps/getProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "groupProductsForBatchStep", - "path": "/references/medusa-workflows/steps/groupProductsForBatchStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCollectionsStep", - "path": "/references/medusa-workflows/steps/updateCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductOptionsStep", - "path": "/references/medusa-workflows/steps/updateProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTagsStep", - "path": "/references/medusa-workflows/steps/updateProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTypesStep", - "path": "/references/medusa-workflows/steps/updateProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsStep", - "path": "/references/medusa-workflows/steps/updateProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsStep", - "path": "/references/medusa-workflows/steps/updateProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductCategoriesStep", - "path": "/references/medusa-workflows/steps/createProductCategoriesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductCategoriesStep", - "path": "/references/medusa-workflows/steps/deleteProductCategoriesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductCategoriesStep", - "path": "/references/medusa-workflows/steps/updateProductCategoriesStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+product", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "category", - "path": "/references/js-sdk/store/category", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "collection", - "path": "/references/js-sdk/store/collection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "product", - "path": "/references/js-sdk/store/product", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+product", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "product", - "path": "/references/js-sdk/admin/product", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productCategory", - "path": "/references/js-sdk/admin/productCategory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productCollection", - "path": "/references/js-sdk/admin/productCollection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productTag", - "path": "/references/js-sdk/admin/productTag", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productType", - "path": "/references/js-sdk/admin/productType", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productVariant", - "path": "/references/js-sdk/admin/productVariant", - "children": [] - } - ] - } - ] - }, { "loaded": true, "isPathHref": true, "type": "category", "title": "References", "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", + "description": "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+product", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCollectionWorkflow", + "path": "/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCollectionsWorkflow", + "path": "/references/medusa-workflows/createCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductOptionsWorkflow", + "path": "/references/medusa-workflows/createProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTagsWorkflow", + "path": "/references/medusa-workflows/createProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTypesWorkflow", + "path": "/references/medusa-workflows/createProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCollectionsWorkflow", + "path": "/references/medusa-workflows/deleteCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductOptionsWorkflow", + "path": "/references/medusa-workflows/deleteProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTagsWorkflow", + "path": "/references/medusa-workflows/deleteProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTypesWorkflow", + "path": "/references/medusa-workflows/deleteProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsWorkflow", + "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsWorkflow", + "path": "/references/medusa-workflows/deleteProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCollectionsWorkflow", + "path": "/references/medusa-workflows/updateCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductOptionsWorkflow", + "path": "/references/medusa-workflows/updateProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTagsWorkflow", + "path": "/references/medusa-workflows/updateProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTypesWorkflow", + "path": "/references/medusa-workflows/updateProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsWorkflow", + "path": "/references/medusa-workflows/updateProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsWorkflow", + "path": "/references/medusa-workflows/updateProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductCategoriesWorkflow", + "path": "/references/medusa-workflows/createProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductCategoriesWorkflow", + "path": "/references/medusa-workflows/deleteProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductCategoriesWorkflow", + "path": "/references/medusa-workflows/updateProductCategoriesWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+product", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCollectionStep", + "path": "/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCollectionsStep", + "path": "/references/medusa-workflows/steps/createCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductOptionsStep", + "path": "/references/medusa-workflows/steps/createProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTagsStep", + "path": "/references/medusa-workflows/steps/createProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTypesStep", + "path": "/references/medusa-workflows/steps/createProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsStep", + "path": "/references/medusa-workflows/steps/createProductVariantsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsStep", + "path": "/references/medusa-workflows/steps/createProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCollectionsStep", + "path": "/references/medusa-workflows/steps/deleteCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductOptionsStep", + "path": "/references/medusa-workflows/steps/deleteProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTagsStep", + "path": "/references/medusa-workflows/steps/deleteProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTypesStep", + "path": "/references/medusa-workflows/steps/deleteProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsStep", + "path": "/references/medusa-workflows/steps/deleteProductVariantsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsStep", + "path": "/references/medusa-workflows/steps/deleteProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getProductsStep", + "path": "/references/medusa-workflows/steps/getProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "groupProductsForBatchStep", + "path": "/references/medusa-workflows/steps/groupProductsForBatchStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCollectionsStep", + "path": "/references/medusa-workflows/steps/updateCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductOptionsStep", + "path": "/references/medusa-workflows/steps/updateProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTagsStep", + "path": "/references/medusa-workflows/steps/updateProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTypesStep", + "path": "/references/medusa-workflows/steps/updateProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsStep", + "path": "/references/medusa-workflows/steps/updateProductVariantsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsStep", + "path": "/references/medusa-workflows/steps/updateProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductCategoriesStep", + "path": "/references/medusa-workflows/steps/createProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductCategoriesStep", + "path": "/references/medusa-workflows/steps/deleteProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductCategoriesStep", + "path": "/references/medusa-workflows/steps/updateProductCategoriesStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+product", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Product Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "category", + "path": "/references/js-sdk/store/category", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "collection", + "path": "/references/js-sdk/store/collection", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "product", + "path": "/references/js-sdk/store/product", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+product", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "product", + "path": "/references/js-sdk/admin/product", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productCategory", + "path": "/references/js-sdk/admin/productCategory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productCollection", + "path": "/references/js-sdk/admin/productCollection", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productTag", + "path": "/references/js-sdk/admin/productTag", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productType", + "path": "/references/js-sdk/admin/productType", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productVariant", + "path": "/references/js-sdk/admin/productVariant", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -10976,292 +11071,301 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+promotion", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsWorkflow", - "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrRemoveCampaignPromotionsWorkflow", - "path": "/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchPromotionRulesWorkflow", - "path": "/references/medusa-workflows/batchPromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCampaignsWorkflow", - "path": "/references/medusa-workflows/createCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionRulesWorkflow", - "path": "/references/medusa-workflows/createPromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionsWorkflow", - "path": "/references/medusa-workflows/createPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCampaignsWorkflow", - "path": "/references/medusa-workflows/deleteCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionRulesWorkflow", - "path": "/references/medusa-workflows/deletePromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionsWorkflow", - "path": "/references/medusa-workflows/deletePromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCampaignsWorkflow", - "path": "/references/medusa-workflows/updateCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionRulesWorkflow", - "path": "/references/medusa-workflows/updatePromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsWorkflow", - "path": "/references/medusa-workflows/updatePromotionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+promotion", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getActionsToComputeFromPromotionsStep", - "path": "/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getPromotionCodesToApply", - "path": "/references/medusa-workflows/steps/getPromotionCodesToApply", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "prepareAdjustmentsFromPromotionActionsStep", - "path": "/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsStep", - "path": "/references/medusa-workflows/steps/updateCartPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addCampaignPromotionsStep", - "path": "/references/medusa-workflows/steps/addCampaignPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addRulesToPromotionsStep", - "path": "/references/medusa-workflows/steps/addRulesToPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCampaignsStep", - "path": "/references/medusa-workflows/steps/createCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionsStep", - "path": "/references/medusa-workflows/steps/createPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCampaignsStep", - "path": "/references/medusa-workflows/steps/deleteCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionsStep", - "path": "/references/medusa-workflows/steps/deletePromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCampaignPromotionsStep", - "path": "/references/medusa-workflows/steps/removeCampaignPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeRulesFromPromotionsStep", - "path": "/references/medusa-workflows/steps/removeRulesFromPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCampaignsStep", - "path": "/references/medusa-workflows/steps/updateCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionRulesStep", - "path": "/references/medusa-workflows/steps/updatePromotionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsStep", - "path": "/references/medusa-workflows/steps/updatePromotionsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+promotion", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/promotion/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "campaign", - "path": "/references/js-sdk/admin/campaign", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+promotion", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsWorkflow", + "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrRemoveCampaignPromotionsWorkflow", + "path": "/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchPromotionRulesWorkflow", + "path": "/references/medusa-workflows/batchPromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCampaignsWorkflow", + "path": "/references/medusa-workflows/createCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionRulesWorkflow", + "path": "/references/medusa-workflows/createPromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionsWorkflow", + "path": "/references/medusa-workflows/createPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCampaignsWorkflow", + "path": "/references/medusa-workflows/deleteCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionRulesWorkflow", + "path": "/references/medusa-workflows/deletePromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionsWorkflow", + "path": "/references/medusa-workflows/deletePromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCampaignsWorkflow", + "path": "/references/medusa-workflows/updateCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionRulesWorkflow", + "path": "/references/medusa-workflows/updatePromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsWorkflow", + "path": "/references/medusa-workflows/updatePromotionsWorkflow", + "children": [] + } + ] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "promotion", - "path": "/references/js-sdk/admin/promotion", - "children": [] + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+promotion", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getActionsToComputeFromPromotionsStep", + "path": "/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getPromotionCodesToApply", + "path": "/references/medusa-workflows/steps/getPromotionCodesToApply", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "prepareAdjustmentsFromPromotionActionsStep", + "path": "/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsStep", + "path": "/references/medusa-workflows/steps/updateCartPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addCampaignPromotionsStep", + "path": "/references/medusa-workflows/steps/addCampaignPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addRulesToPromotionsStep", + "path": "/references/medusa-workflows/steps/addRulesToPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCampaignsStep", + "path": "/references/medusa-workflows/steps/createCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionsStep", + "path": "/references/medusa-workflows/steps/createPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCampaignsStep", + "path": "/references/medusa-workflows/steps/deleteCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionsStep", + "path": "/references/medusa-workflows/steps/deletePromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCampaignPromotionsStep", + "path": "/references/medusa-workflows/steps/removeCampaignPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeRulesFromPromotionsStep", + "path": "/references/medusa-workflows/steps/removeRulesFromPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCampaignsStep", + "path": "/references/medusa-workflows/steps/updateCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionRulesStep", + "path": "/references/medusa-workflows/steps/updatePromotionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsStep", + "path": "/references/medusa-workflows/steps/updatePromotionsStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+promotion", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "campaign", + "path": "/references/js-sdk/admin/campaign", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "promotion", + "path": "/references/js-sdk/admin/promotion", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -11667,218 +11771,228 @@ export const generatedSidebar = [ } ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+region", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "exportProductsWorkflow", - "path": "/references/medusa-workflows/exportProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRegionsWorkflow", - "path": "/references/medusa-workflows/deleteRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+region", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOneOrAnyRegionStep", - "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "generateProductCsvStep", - "path": "/references/medusa-workflows/steps/generateProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsStep", - "path": "/references/medusa-workflows/steps/createRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRegionsStep", - "path": "/references/medusa-workflows/steps/deleteRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsStep", - "path": "/references/medusa-workflows/steps/updateRegionsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+region", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "region", - "path": "/references/js-sdk/store/region", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+region", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "region", - "path": "/references/js-sdk/admin/region", - "children": [] - } - ] - } - ] - }, { "loaded": true, "isPathHref": true, "type": "category", "title": "References", "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", + "description": "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+region", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "exportProductsWorkflow", + "path": "/references/medusa-workflows/exportProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRegionsWorkflow", + "path": "/references/medusa-workflows/deleteRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+region", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOneOrAnyRegionStep", + "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "generateProductCsvStep", + "path": "/references/medusa-workflows/steps/generateProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsStep", + "path": "/references/medusa-workflows/steps/createRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRegionsStep", + "path": "/references/medusa-workflows/steps/deleteRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsStep", + "path": "/references/medusa-workflows/steps/updateRegionsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+region", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Region Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "region", + "path": "/references/js-sdk/store/region", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+region", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Region Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "region", + "path": "/references/js-sdk/admin/region", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -12118,220 +12232,229 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+salesChannel", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "linkSalesChannelsToApiKeyWorkflow", - "path": "/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultsWorkflow", - "path": "/references/medusa-workflows/createDefaultsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createSalesChannelsWorkflow", - "path": "/references/medusa-workflows/createSalesChannelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteSalesChannelsWorkflow", - "path": "/references/medusa-workflows/deleteSalesChannelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateSalesChannelsWorkflow", - "path": "/references/medusa-workflows/updateSalesChannelsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+salesChannel", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateSalesChannelsExistStep", - "path": "/references/medusa-workflows/steps/validateSalesChannelsExistStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findSalesChannelStep", - "path": "/references/medusa-workflows/steps/findSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultSalesChannelStep", - "path": "/references/medusa-workflows/steps/createDefaultSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createSalesChannelsStep", - "path": "/references/medusa-workflows/steps/createSalesChannelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteSalesChannelsStep", - "path": "/references/medusa-workflows/steps/deleteSalesChannelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateSalesChannelsStep", - "path": "/references/medusa-workflows/steps/updateSalesChannelsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+salesChannel", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "salesChannel", - "path": "/references/js-sdk/admin/salesChannel", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+salesChannel", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkSalesChannelsToApiKeyWorkflow", + "path": "/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultsWorkflow", + "path": "/references/medusa-workflows/createDefaultsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createSalesChannelsWorkflow", + "path": "/references/medusa-workflows/createSalesChannelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteSalesChannelsWorkflow", + "path": "/references/medusa-workflows/deleteSalesChannelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateSalesChannelsWorkflow", + "path": "/references/medusa-workflows/updateSalesChannelsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+salesChannel", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateSalesChannelsExistStep", + "path": "/references/medusa-workflows/steps/validateSalesChannelsExistStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findSalesChannelStep", + "path": "/references/medusa-workflows/steps/findSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultSalesChannelStep", + "path": "/references/medusa-workflows/steps/createDefaultSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createSalesChannelsStep", + "path": "/references/medusa-workflows/steps/createSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteSalesChannelsStep", + "path": "/references/medusa-workflows/steps/deleteSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateSalesChannelsStep", + "path": "/references/medusa-workflows/steps/updateSalesChannelsStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+salesChannel", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "salesChannel", + "path": "/references/js-sdk/admin/salesChannel", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -12519,108 +12642,117 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+stockLocation", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createStockLocationsWorkflow", - "path": "/references/medusa-workflows/createStockLocationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStockLocationsWorkflow", - "path": "/references/medusa-workflows/deleteStockLocationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStockLocationsWorkflow", - "path": "/references/medusa-workflows/updateStockLocationsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+stockLocation", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStockLocations", - "path": "/references/medusa-workflows/steps/createStockLocations", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStockLocationsStep", - "path": "/references/medusa-workflows/steps/deleteStockLocationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStockLocationsStep", - "path": "/references/medusa-workflows/steps/updateStockLocationsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+stockLocation", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/stock-location/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "stockLocation", - "path": "/references/js-sdk/admin/stockLocation", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+stockLocation", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStockLocationsWorkflow", + "path": "/references/medusa-workflows/createStockLocationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStockLocationsWorkflow", + "path": "/references/medusa-workflows/deleteStockLocationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStockLocationsWorkflow", + "path": "/references/medusa-workflows/updateStockLocationsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+stockLocation", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStockLocations", + "path": "/references/medusa-workflows/steps/createStockLocations", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStockLocationsStep", + "path": "/references/medusa-workflows/steps/deleteStockLocationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStockLocationsStep", + "path": "/references/medusa-workflows/steps/updateStockLocationsStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+stockLocation", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "stockLocation", + "path": "/references/js-sdk/admin/stockLocation", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -12824,196 +12956,205 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+store", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultsWorkflow", - "path": "/references/medusa-workflows/createDefaultsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresWorkflow", - "path": "/references/medusa-workflows/createStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStoresWorkflow", - "path": "/references/medusa-workflows/deleteStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresWorkflow", - "path": "/references/medusa-workflows/updateStoresWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+store", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOneOrAnyRegionStep", - "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findSalesChannelStep", - "path": "/references/medusa-workflows/steps/findSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultStoreStep", - "path": "/references/medusa-workflows/steps/createDefaultStoreStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresStep", - "path": "/references/medusa-workflows/steps/createStoresStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStoresStep", - "path": "/references/medusa-workflows/steps/deleteStoresStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresStep", - "path": "/references/medusa-workflows/steps/updateStoresStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+store", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/store/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "store", - "path": "/references/js-sdk/admin/store", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+store", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultsWorkflow", + "path": "/references/medusa-workflows/createDefaultsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresWorkflow", + "path": "/references/medusa-workflows/createStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStoresWorkflow", + "path": "/references/medusa-workflows/deleteStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresWorkflow", + "path": "/references/medusa-workflows/updateStoresWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+store", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOneOrAnyRegionStep", + "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findSalesChannelStep", + "path": "/references/medusa-workflows/steps/findSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultStoreStep", + "path": "/references/medusa-workflows/steps/createDefaultStoreStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresStep", + "path": "/references/medusa-workflows/steps/createStoresStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStoresStep", + "path": "/references/medusa-workflows/steps/deleteStoresStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresStep", + "path": "/references/medusa-workflows/steps/updateStoresStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+store", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Store Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "store", + "path": "/references/js-sdk/admin/store", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -13265,308 +13406,317 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+tax", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxLinesWorkflow", - "path": "/references/medusa-workflows/updateTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createClaimShippingMethodWorkflow", - "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createExchangeShippingMethodWorkflow", - "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderEditShippingMethodWorkflow", - "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnShippingMethodWorkflow", - "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderTaxLinesWorkflow", - "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRateRulesWorkflow", - "path": "/references/medusa-workflows/createTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRatesWorkflow", - "path": "/references/medusa-workflows/createTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRegionsWorkflow", - "path": "/references/medusa-workflows/createTaxRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRateRulesWorkflow", - "path": "/references/medusa-workflows/deleteTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRatesWorkflow", - "path": "/references/medusa-workflows/deleteTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRegionsWorkflow", - "path": "/references/medusa-workflows/deleteTaxRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setTaxRateRulesWorkflow", - "path": "/references/medusa-workflows/setTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRatesWorkflow", - "path": "/references/medusa-workflows/updateTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRegionsWorkflow", - "path": "/references/medusa-workflows/updateTaxRegionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+tax", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRateRulesStep", - "path": "/references/medusa-workflows/steps/createTaxRateRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRatesStep", - "path": "/references/medusa-workflows/steps/createTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRegionsStep", - "path": "/references/medusa-workflows/steps/createTaxRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRateRulesStep", - "path": "/references/medusa-workflows/steps/deleteTaxRateRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRatesStep", - "path": "/references/medusa-workflows/steps/deleteTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRegionsStep", - "path": "/references/medusa-workflows/steps/deleteTaxRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getItemTaxLinesStep", - "path": "/references/medusa-workflows/steps/getItemTaxLinesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "listTaxRateRuleIdsStep", - "path": "/references/medusa-workflows/steps/listTaxRateRuleIdsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRatesStep", - "path": "/references/medusa-workflows/steps/updateTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRegionsStep", - "path": "/references/medusa-workflows/steps/updateTaxRegionsStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+tax", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/tax/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "taxRate", - "path": "/references/js-sdk/admin/taxRate", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+tax", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxLinesWorkflow", + "path": "/references/medusa-workflows/updateTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createClaimShippingMethodWorkflow", + "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createExchangeShippingMethodWorkflow", + "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderEditShippingMethodWorkflow", + "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnShippingMethodWorkflow", + "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderTaxLinesWorkflow", + "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRateRulesWorkflow", + "path": "/references/medusa-workflows/createTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRatesWorkflow", + "path": "/references/medusa-workflows/createTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRegionsWorkflow", + "path": "/references/medusa-workflows/createTaxRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRateRulesWorkflow", + "path": "/references/medusa-workflows/deleteTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRatesWorkflow", + "path": "/references/medusa-workflows/deleteTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRegionsWorkflow", + "path": "/references/medusa-workflows/deleteTaxRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setTaxRateRulesWorkflow", + "path": "/references/medusa-workflows/setTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRatesWorkflow", + "path": "/references/medusa-workflows/updateTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRegionsWorkflow", + "path": "/references/medusa-workflows/updateTaxRegionsWorkflow", + "children": [] + } + ] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "taxRegion", - "path": "/references/js-sdk/admin/taxRegion", - "children": [] + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+tax", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRateRulesStep", + "path": "/references/medusa-workflows/steps/createTaxRateRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRatesStep", + "path": "/references/medusa-workflows/steps/createTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRegionsStep", + "path": "/references/medusa-workflows/steps/createTaxRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRateRulesStep", + "path": "/references/medusa-workflows/steps/deleteTaxRateRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRatesStep", + "path": "/references/medusa-workflows/steps/deleteTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRegionsStep", + "path": "/references/medusa-workflows/steps/deleteTaxRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getItemTaxLinesStep", + "path": "/references/medusa-workflows/steps/getItemTaxLinesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "listTaxRateRuleIdsStep", + "path": "/references/medusa-workflows/steps/listTaxRateRuleIdsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRatesStep", + "path": "/references/medusa-workflows/steps/updateTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRegionsStep", + "path": "/references/medusa-workflows/steps/updateTaxRegionsStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+tax", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "taxRate", + "path": "/references/js-sdk/admin/taxRate", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "taxRegion", + "path": "/references/js-sdk/admin/taxRegion", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, @@ -13869,196 +14019,205 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+user", + "title": "References", "initialOpen": false, - "autogenerate_as_ref": true, + "description": "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "acceptInviteWorkflow", - "path": "/references/medusa-workflows/acceptInviteWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInvitesWorkflow", - "path": "/references/medusa-workflows/createInvitesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInvitesWorkflow", - "path": "/references/medusa-workflows/deleteInvitesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshInviteTokensWorkflow", - "path": "/references/medusa-workflows/refreshInviteTokensWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUserAccountWorkflow", - "path": "/references/medusa-workflows/createUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUsersWorkflow", - "path": "/references/medusa-workflows/createUsersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteUsersWorkflow", - "path": "/references/medusa-workflows/deleteUsersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeUserAccountWorkflow", - "path": "/references/medusa-workflows/removeUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateUsersWorkflow", - "path": "/references/medusa-workflows/updateUsersWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+user", - "initialOpen": false, - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInviteStep", - "path": "/references/medusa-workflows/steps/createInviteStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInvitesStep", - "path": "/references/medusa-workflows/steps/deleteInvitesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshInviteTokensStep", - "path": "/references/medusa-workflows/steps/refreshInviteTokensStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateTokenStep", - "path": "/references/medusa-workflows/steps/validateTokenStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUsersStep", - "path": "/references/medusa-workflows/steps/createUsersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteUsersStep", - "path": "/references/medusa-workflows/steps/deleteUsersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateUsersStep", - "path": "/references/medusa-workflows/steps/updateUsersStep", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "JS SDK", - "initialOpen": false, - "description": "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+user", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/user/workflows", + "title": "Workflows", + "hideChildren": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "invite", - "path": "/references/js-sdk/admin/invite", - "children": [] + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+user", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptInviteWorkflow", + "path": "/references/medusa-workflows/acceptInviteWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInvitesWorkflow", + "path": "/references/medusa-workflows/createInvitesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInvitesWorkflow", + "path": "/references/medusa-workflows/deleteInvitesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshInviteTokensWorkflow", + "path": "/references/medusa-workflows/refreshInviteTokensWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUserAccountWorkflow", + "path": "/references/medusa-workflows/createUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUsersWorkflow", + "path": "/references/medusa-workflows/createUsersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteUsersWorkflow", + "path": "/references/medusa-workflows/deleteUsersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeUserAccountWorkflow", + "path": "/references/medusa-workflows/removeUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateUsersWorkflow", + "path": "/references/medusa-workflows/updateUsersWorkflow", + "children": [] + } + ] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "user", - "path": "/references/js-sdk/admin/user", - "children": [] + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+user", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInviteStep", + "path": "/references/medusa-workflows/steps/createInviteStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInvitesStep", + "path": "/references/medusa-workflows/steps/deleteInvitesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshInviteTokensStep", + "path": "/references/medusa-workflows/steps/refreshInviteTokensStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateTokenStep", + "path": "/references/medusa-workflows/steps/validateTokenStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUsersStep", + "path": "/references/medusa-workflows/steps/createUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteUsersStep", + "path": "/references/medusa-workflows/steps/deleteUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateUsersStep", + "path": "/references/medusa-workflows/steps/updateUsersStep", + "children": [] + } + ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for data models, methods, and more. These are useful for your customizations.", - "children": [ + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+user", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the User Module.", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "invite", + "path": "/references/js-sdk/admin/invite", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "user", + "path": "/references/js-sdk/admin/user", + "children": [] + } + ] + } + ] + }, { "loaded": true, "isPathHref": true, diff --git a/www/apps/resources/sidebars/api-key.mjs b/www/apps/resources/sidebars/api-key.mjs index ad4cbe90ff..5dc40bb80a 100644 --- a/www/apps/resources/sidebars/api-key.mjs +++ b/www/apps/resources/sidebars/api-key.mjs @@ -66,48 +66,57 @@ export const apiKeySidebar = [ description: "Learn how to utilize and manage API Key features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - initialOpen: false, - autogenerate_tags: "workflow+apiKey", - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - initialOpen: false, - autogenerate_tags: "step+apiKey", - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+apiKey", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+apiKey", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/api-key/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+apiKey", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+apiKey", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/api-key/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+apiKey", + description: + "The following methods or properties are used to send requests to Store API Routes related to the API Key Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+apiKey", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/api-key/admin-widget-zones", diff --git a/www/apps/resources/sidebars/auth.mjs b/www/apps/resources/sidebars/auth.mjs index 915a90368e..5e44a734cf 100644 --- a/www/apps/resources/sidebars/auth.mjs +++ b/www/apps/resources/sidebars/auth.mjs @@ -98,20 +98,6 @@ export const authSidebar = [ description: "Learn how to utilize and manage Auth features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+auth", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+auth", - initialOpen: false, - autogenerate_as_ref: true, - }, { type: "category", title: "Providers", @@ -134,22 +120,41 @@ export const authSidebar = [ }, ], }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - autogenerate_tags: "jsSdk+auth", - autogenerate_as_ref: true, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/auth/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+auth", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+auth", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/auth/js-sdk", + title: "JS SDK", + hideChildren: true, + autogenerate_tags: "jsSdk+auth", + autogenerate_as_ref: true, + }, { type: "link", path: "/commerce-modules/auth/events", diff --git a/www/apps/resources/sidebars/cart.mjs b/www/apps/resources/sidebars/cart.mjs index 302809787c..266f322be5 100644 --- a/www/apps/resources/sidebars/cart.mjs +++ b/www/apps/resources/sidebars/cart.mjs @@ -83,48 +83,57 @@ export const cartSidebar = [ description: "Learn how to utilize and manage Cart features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+cart", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+cart", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+cart", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+cart", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/cart/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+cart", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+cart", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/cart/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+cart", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+cart", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Cart Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/cart/events", diff --git a/www/apps/resources/sidebars/currency.mjs b/www/apps/resources/sidebars/currency.mjs index 4bac5d3967..c7929b1a3a 100644 --- a/www/apps/resources/sidebars/currency.mjs +++ b/www/apps/resources/sidebars/currency.mjs @@ -61,48 +61,37 @@ export const currencySidebar = [ description: "Learn how to utilize and manage Currency features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+currency", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+currency", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+currency", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+currency", - autogenerate_as_ref: true, - }, - ], - }, { type: "sub-category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/currency/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+currency", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Currency Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+currency", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/references/currency", diff --git a/www/apps/resources/sidebars/customer.mjs b/www/apps/resources/sidebars/customer.mjs index 640242f5e9..e30fcb351f 100644 --- a/www/apps/resources/sidebars/customer.mjs +++ b/www/apps/resources/sidebars/customer.mjs @@ -73,48 +73,57 @@ export const customerSidebar = [ description: "Learn how to utilize and manage Customer features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+customer", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+customer", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+customer", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+customer", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/customer/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+customer", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+customer", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/customer/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+customer", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Customer Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+customer", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/customer/events", diff --git a/www/apps/resources/sidebars/fulfillment.mjs b/www/apps/resources/sidebars/fulfillment.mjs index d343e63260..b52e73f3d0 100644 --- a/www/apps/resources/sidebars/fulfillment.mjs +++ b/www/apps/resources/sidebars/fulfillment.mjs @@ -98,48 +98,57 @@ export const fulfillmentSidebar = [ description: "Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+fulfillment", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+fulfillment", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+fulfillment", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+fulfillment", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/fulfillment/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+fulfillment", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+fulfillment", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/fulfillment/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+fulfillment", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+fulfillment", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/fulfillment/events", diff --git a/www/apps/resources/sidebars/inventory.mjs b/www/apps/resources/sidebars/inventory.mjs index caa869177f..1f263f409a 100644 --- a/www/apps/resources/sidebars/inventory.mjs +++ b/www/apps/resources/sidebars/inventory.mjs @@ -76,48 +76,57 @@ export const inventorySidebar = [ description: "Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+inventory", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+inventory", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+inventory", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+inventory", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/inventory/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+inventory", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+inventory", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/inventory/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+inventory", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Inventory Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+inventory", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/inventory/admin-widget-zones", diff --git a/www/apps/resources/sidebars/order-module.mjs b/www/apps/resources/sidebars/order-module.mjs index a3c2c3f203..bc63c0bcc5 100644 --- a/www/apps/resources/sidebars/order-module.mjs +++ b/www/apps/resources/sidebars/order-module.mjs @@ -111,48 +111,57 @@ export const orderSidebar = [ description: "Learn how to utilize and manage Order features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+order", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+order", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+order", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+order", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/order/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+order", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+order", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/order/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+order", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Order Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+order", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Order Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/order/events", diff --git a/www/apps/resources/sidebars/payment.mjs b/www/apps/resources/sidebars/payment.mjs index ed5b689d18..867fa3c6d4 100644 --- a/www/apps/resources/sidebars/payment.mjs +++ b/www/apps/resources/sidebars/payment.mjs @@ -103,20 +103,6 @@ export const paymentSidebar = [ description: "Learn how to utilize and manage Payment features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+payment", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+payment", - initialOpen: false, - autogenerate_as_ref: true, - }, { type: "category", title: "Providers", @@ -129,34 +115,57 @@ export const paymentSidebar = [ }, ], }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+payment", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+payment", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/payment/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+payment", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+payment", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/payment/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+payment", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+payment", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/payment/events", diff --git a/www/apps/resources/sidebars/pricing.mjs b/www/apps/resources/sidebars/pricing.mjs index 9ad9f4f380..0ba6017f66 100644 --- a/www/apps/resources/sidebars/pricing.mjs +++ b/www/apps/resources/sidebars/pricing.mjs @@ -81,48 +81,57 @@ export const pricingSidebar = [ description: "Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+pricing", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+pricing", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+pricing", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+pricing", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/pricing/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+pricing", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+pricing", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/pricing/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+pricing", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Pricing Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+pricing", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/pricing/admin-widget-zones", diff --git a/www/apps/resources/sidebars/product.mjs b/www/apps/resources/sidebars/product.mjs index 8bd3064f7b..e9e7080d2a 100644 --- a/www/apps/resources/sidebars/product.mjs +++ b/www/apps/resources/sidebars/product.mjs @@ -80,48 +80,57 @@ export const productSidebar = [ description: "Learn how to utilize and manage Product features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+product", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+product", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+product", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+product", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/product/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+product", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+product", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/product/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+product", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Product Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+product", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/product/events", diff --git a/www/apps/resources/sidebars/promotion.mjs b/www/apps/resources/sidebars/promotion.mjs index 76e2edfb83..f069392114 100644 --- a/www/apps/resources/sidebars/promotion.mjs +++ b/www/apps/resources/sidebars/promotion.mjs @@ -88,48 +88,57 @@ export const promotionSidebar = [ description: "Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+promotion", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+promotion", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+promotion", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+promotion", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/promotion/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+promotion", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+promotion", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/promotion/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+promotion", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Promotion Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+promotion", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/promotion/admin-widget-zones", diff --git a/www/apps/resources/sidebars/region.mjs b/www/apps/resources/sidebars/region.mjs index bd7c929201..616f08149b 100644 --- a/www/apps/resources/sidebars/region.mjs +++ b/www/apps/resources/sidebars/region.mjs @@ -61,48 +61,57 @@ export const regionSidebar = [ description: "Learn how to utilize and manage Region features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+region", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+region", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+region", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+region", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/region/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+region", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+region", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/region/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+region", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Region Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+region", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Region Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/region/events", diff --git a/www/apps/resources/sidebars/sales-channel.mjs b/www/apps/resources/sidebars/sales-channel.mjs index af3388ee94..4386034336 100644 --- a/www/apps/resources/sidebars/sales-channel.mjs +++ b/www/apps/resources/sidebars/sales-channel.mjs @@ -66,48 +66,57 @@ export const salesChannelSidebar = [ description: "Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+salesChannel", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+salesChannel", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+salesChannel", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+salesChannel", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/sales-channel/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+salesChannel", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+salesChannel", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/sales-channel/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+salesChannel", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Sales Channel Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+salesChannel", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/sales-channel/events", diff --git a/www/apps/resources/sidebars/stock-location.mjs b/www/apps/resources/sidebars/stock-location.mjs index a8248d5119..79c2860dc0 100644 --- a/www/apps/resources/sidebars/stock-location.mjs +++ b/www/apps/resources/sidebars/stock-location.mjs @@ -66,48 +66,57 @@ export const stockLocationSidebar = [ description: "Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+stockLocation", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+stockLocation", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+stockLocation", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+stockLocation", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/stock-location/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+stockLocation", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+stockLocation", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/stock-location/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+stockLocation", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Stock Location Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+stockLocation", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/stock-location/admin-widget-zones", diff --git a/www/apps/resources/sidebars/store.mjs b/www/apps/resources/sidebars/store.mjs index 4167905622..e717b540f3 100644 --- a/www/apps/resources/sidebars/store.mjs +++ b/www/apps/resources/sidebars/store.mjs @@ -61,48 +61,57 @@ export const storeSidebar = [ description: "Learn how to utilize and manage Store features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+store", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+store", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+store", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+store", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/store/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+store", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+store", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/store/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+store", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Store Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+store", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Store Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/store/admin-widget-zones", diff --git a/www/apps/resources/sidebars/tax.mjs b/www/apps/resources/sidebars/tax.mjs index 71c76e36df..df59cfa685 100644 --- a/www/apps/resources/sidebars/tax.mjs +++ b/www/apps/resources/sidebars/tax.mjs @@ -83,48 +83,57 @@ export const taxSidebar = [ description: "Learn how to utilize and manage Tax features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+tax", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+tax", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+tax", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+tax", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/tax/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+tax", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+tax", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/tax/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+tax", + description: + "The following methods or properties are used to send requests to Store API Routes related to the Tax Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+tax", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/tax/admin-widget-zones", diff --git a/www/apps/resources/sidebars/user.mjs b/www/apps/resources/sidebars/user.mjs index e09516c67b..d4c20d3283 100644 --- a/www/apps/resources/sidebars/user.mjs +++ b/www/apps/resources/sidebars/user.mjs @@ -61,48 +61,57 @@ export const userSidebar = [ description: "Learn how to utilize and manage User features in the Medusa Admin dashboard.", }, - { - type: "category", - title: "Workflows", - autogenerate_tags: "workflow+user", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "Steps", - autogenerate_tags: "step+user", - initialOpen: false, - autogenerate_as_ref: true, - }, - { - type: "category", - title: "JS SDK", - initialOpen: false, - description: - "The [JS SDK](/js-sdk) allows you to send requests to the Medusa server application from your client applications, such as a storefront or the Medusa Admin dashboard.", - children: [ - { - type: "sub-category", - title: "Store", - autogenerate_tags: "jsSdk+storefront+user", - autogenerate_as_ref: true, - }, - { - type: "sub-category", - title: "Admin", - autogenerate_tags: "jsSdk+admin+user", - autogenerate_as_ref: true, - }, - ], - }, { type: "category", title: "References", initialOpen: false, description: - "Find references for data models, methods, and more. These are useful for your customizations.", + "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", children: [ + { + type: "link", + path: "/commerce-modules/user/workflows", + title: "Workflows", + hideChildren: true, + children: [ + { + type: "category", + title: "Workflows", + autogenerate_tags: "workflow+user", + autogenerate_as_ref: true, + }, + { + type: "category", + title: "Steps", + autogenerate_tags: "step+user", + autogenerate_as_ref: true, + }, + ], + }, + { + type: "link", + path: "/commerce-modules/user/js-sdk", + title: "JS SDK", + hideChildren: true, + children: [ + { + type: "sub-category", + title: "Store", + autogenerate_tags: "jsSdk+storefront+user", + description: + "The following methods or properties are used to send requests to Store API Routes related to the User Module.", + autogenerate_as_ref: true, + }, + { + type: "sub-category", + title: "Admin", + autogenerate_tags: "jsSdk+admin+user", + description: + "The following methods or properties are used to send requests to Admin API Routes related to the User Module.", + autogenerate_as_ref: true, + }, + ], + }, { type: "link", path: "/commerce-modules/user/events", diff --git a/www/packages/docs-ui/src/components/Card/Layout/Default/index.tsx b/www/packages/docs-ui/src/components/Card/Layout/Default/index.tsx index 02d0842934..de31304980 100644 --- a/www/packages/docs-ui/src/components/Card/Layout/Default/index.tsx +++ b/www/packages/docs-ui/src/components/Card/Layout/Default/index.tsx @@ -16,6 +16,7 @@ export const CardDefaultLayout = ({ iconClassName, children, badge, + rightIcon: RightIconComponent, }: CardProps) => { const isExternal = useIsExternalLink({ href }) @@ -61,7 +62,9 @@ export const CardDefaultLayout = ({ {badge && } - {isExternal ? : } + {RightIconComponent && } + {!RightIconComponent && isExternal && } + {!RightIconComponent && !isExternal && } {href && ( diff --git a/www/packages/docs-ui/src/components/Card/index.tsx b/www/packages/docs-ui/src/components/Card/index.tsx index 643975e39d..c710ea177a 100644 --- a/www/packages/docs-ui/src/components/Card/index.tsx +++ b/www/packages/docs-ui/src/components/Card/index.tsx @@ -9,6 +9,7 @@ import { CardLayoutMini } from "./Layout/Mini" export type CardProps = { type?: "default" | "large" | "filler" | "mini" icon?: React.FC + rightIcon?: React.FC image?: string themeImage?: { light: string diff --git a/www/packages/docs-ui/src/components/CardList/index.tsx b/www/packages/docs-ui/src/components/CardList/index.tsx index cf34d027d4..ce85565149 100644 --- a/www/packages/docs-ui/src/components/CardList/index.tsx +++ b/www/packages/docs-ui/src/components/CardList/index.tsx @@ -5,13 +5,22 @@ import clsx from "clsx" type CardListProps = { items: CardProps[] itemsPerRow?: number + defaultItemsPerRow?: number className?: string } -export const CardList = ({ items, itemsPerRow, className }: CardListProps) => { +export const CardList = ({ + items, + itemsPerRow, + className, + defaultItemsPerRow, +}: CardListProps) => { if (!itemsPerRow) { // if length of items is even, set to `2`, else set to `3` - itemsPerRow = items.length === 1 ? 0 : items.length % 2 === 0 ? 2 : 3 + itemsPerRow = + items.length === 1 + ? 1 + : defaultItemsPerRow || (items.length % 2 === 0 ? 2 : 3) } return (
@@ -30,6 +31,7 @@ export type UseChildDocsProps = { titleLevel?: number childLevel?: number itemsPerRow?: number + defaultItemsPerRow?: number } export const useChildDocs = ({ @@ -42,6 +44,7 @@ export const useChildDocs = ({ titleLevel = 2, childLevel = 1, itemsPerRow, + defaultItemsPerRow, }: UseChildDocsProps) => { const { currentItems, activeItem } = useSidebar() const TitleHeaderComponent = useCallback( @@ -178,10 +181,13 @@ export const useChildDocs = ({ return { title: childItem.title, href, + rightIcon: + childItem.type === "ref" ? ChevronDoubleRight : undefined, } }) || [] } itemsPerRow={itemsPerRow} + defaultItemsPerRow={defaultItemsPerRow} /> ) } @@ -227,16 +233,26 @@ export const useChildDocs = ({ title: childItem.title, href: isSidebarItemLink(childItem) ? childItem.path : "", text: childItem.description, + rightIcon: + childItem.type === "ref" + ? ChevronDoubleRight + : undefined, })) || [] } itemsPerRow={itemsPerRow} + defaultItemsPerRow={defaultItemsPerRow} /> )} {key !== filteredItems.length - 1 && headerLevel === 2 &&
} )} {!HeadingComponent && isSidebarItemLink(item) && ( - + )} )