asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: add how-to guides for retrieving cart and order totals (#13044)

Browse Source
This commit is contained in:
Shahed Nasser
2025-07-25 15:42:34 +03:00
committed by GitHub
parent 713dbe442c
commit 9643769127
19 changed files with 572 additions and 305 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/commerce-modules/cart/cart-totals/page.mdx
+238
View File
@@ -0,0 +1,238 @@
---
tags:
- cart
- name: how to
label: Retrieve Cart Totals
- server
---
import { CodeTabs, CodeTab } from "docs-ui"
export const metadata = {
title: `Retrieve Cart Totals using Query`,
}
# {metadata.title}
In this guide, you'll learn how to retrieve cart totals in your Medusa application using [Query](!docs!/learn/fundamentals/module-links/query).
You may need to retrieve cart totals in your Medusa customizations, such as workflows or custom API routes, to perform custom actions with them. The ideal way to retrieve totals is with Query.
<Note title="Looking for a storefront guide?">
Refer to the [Retrieve Cart Totals in Storefront](../../../storefront-development/cart/totals/page.mdx) guide for a storefront-specific approach.
</Note>
## How to Retrieve Cart Totals with Query
To retrieve cart totals, pass the `total` field within the `fields` option of Query. For example:
<Note title="Tip">
Use `useQueryGraphStep` in workflows, and `query.graph` in custom API routes, scheduled jobs, and subscribers.
</Note>
<CodeTabs group="query-type">
<CodeTab label="useQueryGraphStep" value="useQueryGraphStep">
```ts highlights={[["12"]]}
import { createWorkflow } from "@medusajs/framework/workflows-sdk"
import { useQueryGraphStep } from "@medusajs/medusa/core-flows"
export const myWorkflow = createWorkflow(
"my-workflow",
() => {
const { data: carts } = useQueryGraphStep({
entity: "cart",
fields: [
"id",
"currency_code",
"total",
"items.*",
"shipping_methods.*",
],
filters: {
id: "cart_123", // Specify the cart ID
},
})
}
)
```
</CodeTab>
<CodeTab label="query.graph" value="query.graph">
```ts highlights={[["8"]]}
const query = container.resolve("query") // or req.scope.resolve in API routes
const { data: [cart] } = await query.graph({
entity: "cart",
fields: [
"id",
"currency_code",
"total",
"items.*",
"shipping_methods.*",
],
filters: {
id: "cart_123", // Specify the cart ID
}
})
```
</CodeTab>
</CodeTabs>
By specifying the `total` field, you retrieve totals related to the cart, line items, and shipping methods. The returned `cart` object will look like this:
```json
{
"id": "cart_123",
"currency_code": "usd",
"total": 10,
"items": [
{
"id": "cali_123",
// ...
"unit_price": 10,
"subtotal": 10,
"total": 0,
"original_total": 10,
"discount_total": 10,
"discount_subtotal": 10,
"discount_tax_total": 0,
"tax_total": 0,
"original_tax_total": 0,
}
],
"shipping_methods": [
{
"id": "casm_01K10AYZDKZGQXE8WXW3QP9T22",
// ...
"amount": 10,
"subtotal": 10,
"total": 10,
"original_total": 10,
"discount_total": 0,
"discount_subtotal": 0,
"discount_tax_total": 0,
"tax_total": 0,
"original_tax_total": 0,
}
]
}
```
### Cart Grand Total
The cart's grand total is the `total` field in the `cart` object. It represents the total amount of the cart, including all line items, shipping methods, taxes, and discounts.
### Cart Line Item Totals
The `items` array in the `cart` object contains total fields for each line item:
- `unit_price`: The price of a single unit of the line item. This field is not calculated and is stored in the database.
- `subtotal`: The total price of the line item before any discounts or taxes.
- `total`: The total price of the line item after applying discounts and taxes.
- `original_total`: The total price of the line item before any discounts.
- `discount_total`: The total amount of discounts applied to the line item.
- `discount_subtotal`: The total amount of discounts applied to the line item's subtotal.
- `discount_tax_total`: The total amount of discounts applied to the line item's tax.
- `tax_total`: The total tax amount applied to the line item.
- `original_tax_total`: The total tax amount applied to the line item before any discounts.
### Cart Shipping Method Totals
The `shipping_methods` array in the `cart` object contains total fields for each shipping method:
- `amount`: The amount charged for the shipping method. This field is not calculated and is stored in the database.
- `subtotal`: The total price of the shipping method before any discounts or taxes.
- `total`: The total price of the shipping method after applying discounts and taxes.
- `original_total`: The total price of the shipping method before any discounts.
- `discount_total`: The total amount of discounts applied to the shipping method.
- `discount_subtotal`: The total amount of discounts applied to the shipping method's subtotal.
- `discount_tax_total`: The total amount of discounts applied to the shipping method's tax.
- `tax_total`: The total tax amount applied to the shipping method.
- `original_tax_total`: The total tax amount applied to the shipping method before any discounts.
---
## Caveats of Retrieving Cart Totals
### Using Astrisk (*) in Cart's Query
Cart totals are calculated based on the cart's line items, shipping methods, taxes, and any discounts applied. They are not stored in the `Cart` data model.
For that reason, you cannot retrieve cart totals by passing `*` to the Query's fields. For example, the following query will not return cart totals:
<CodeTabs group="query-type">
<CodeTab label="useQueryGraphStep" value="useQueryGraphStep">
```ts
const { data: carts } = useQueryGraphStep({
entity: "cart",
fields: ["*"],
filters: {
id: "cart_123",
},
})
// carts don't include cart totals
```
</CodeTab>
<CodeTab label="query.graph" value="query.graph">
```ts
const { data: [cart] } = await query.graph({
entity: "cart",
fields: ["*"],
filters: {
id: "cart_123",
}
})
// cart doesn't include cart totals
```
</CodeTab>
</CodeTabs>
This will return the cart data stored in the database, but not the calculated totals.
You also can't pass `*` along with `total` in the Query's fields option. Passing `*` will override the `total` field, and you will not retrieve cart totals. For example, the following query will not return cart totals:
<CodeTabs group="query-type">
<CodeTab label="useQueryGraphStep" value="useQueryGraphStep">
```ts
const { data: carts } = useQueryGraphStep({
entity: "cart",
fields: ["*", "total"],
filters: {
id: "cart_123",
},
})
// carts don't include cart totals
```
</CodeTab>
<CodeTab label="query.graph" value="query.graph">
```ts
const { data: [cart] } = await query.graph({
entity: "cart",
fields: ["*", "total"],
filters: {
id: "cart_123",
}
})
// cart doesn't include cart totals
```
</CodeTab>
</CodeTabs>
Instead, when you need to retrieve cart totals, explicitly pass the `total` field in the Query's fields option, as shown in [the previous section](#how-to-retrieve-cart-totals-with-query). You can also include other fields and relations you need, such as `email` and `items.*`.
### Applying Filters on Cart Totals
You can't apply filters directly on the cart totals, as they are not stored in the `Cart` data model. You can still filter the cart based on its properties, such as `id`, `email`, or `currency_code`, but not on the calculated totals.
www/apps/resources/app/commerce-modules/order/order-totals/page.mdx
+255
View File
@@ -0,0 +1,255 @@
---
tags:
- order
- name: how to
label: Retrieve Order Totals
- server
---
import { CodeTabs, CodeTab } from "docs-ui"
export const metadata = {
title: `Retrieve Order Totals Using Query`,
}
# {metadata.title}
In this guide, you'll learn how to retrieve order totals in your Medusa application using [Query](!docs!/learn/fundamentals/module-links/query).
You may need to retrieve order totals in your Medusa customizations, such as workflows or custom API routes, to perform custom actions with them. The ideal way to retrieve totals is with Query.
<Note title="Looking for a storefront guide?">
Refer to the [Order Confirmation in Storefront](../../../storefront-development/checkout/order-confirmation/page.mdx#show-order-totals) guide for a storefront-specific approach.
</Note>
## How to Retrieve Order Totals with Query
To retrieve order totals, pass the `total` field within the `fields` option of the Query. For example:
<Note title="Tip">
Use `useQueryGraphStep` in workflows, and `query.graph` in custom API routes, scheduled jobs, and subscribers.
</Note>
<CodeTabs group="query-type">
<CodeTab label="useQueryGraphStep" value="useQueryGraphStep">
```ts highlights={[["12"]]}
import { createWorkflow } from "@medusajs/framework/workflows-sdk"
import { useQueryGraphStep } from "@medusajs/medusa/core-flows"
export const myWorkflow = createWorkflow(
"my-workflow",
() => {
const { data: orders } = useQueryGraphStep({
entity: "order",
fields: [
"id",
"currency_code",
"total",
"items.*",
"shipping_methods.*",
],
filters: {
id: "order_123", // Specify the order ID
},
})
}
)
```
</CodeTab>
<CodeTab label="query.graph" value="query.graph">
```ts highlights={[["8"]]}
const query = container.resolve("query") // or req.scope.resolve in API routes
const { data: [order] } = await query.graph({
entity: "order",
fields: [
"id",
"currency_code",
"total",
"items.*",
"shipping_methods.*",
],
filters: {
id: "order_123", // Specify the order ID
}
})
```
</CodeTab>
</CodeTabs>
By specifying the `total` field, you retrieve totals related to the order, line items, and shipping methods. The returned `order` object will look like this:
```json
{
"id": "order_123",
"currency_code": "usd",
"total": 28,
"items": [
{
"id": "ordli_01K10AZQZ0F86MSTT4FKFNNN8X",
// ...
"unit_price": 10,
"subtotal": 10,
"total": 0,
"original_total": 10,
"discount_total": 10,
"discount_subtotal": 10,
"discount_tax_total": 0,
"tax_total": 0,
"original_tax_total": 0,
"refundable_total_per_unit": 0,
"refundable_total": 0,
"fulfilled_total": 0,
"shipped_total": 0,
"return_requested_total": 0,
"return_received_total": 0,
"return_dismissed_total": 0,
"write_off_total": 0,
}
],
"shipping_methods": [
{
"id": "ordsm_01K10AZQYZ1PVCX0DPEAY1G9B9",
// ...
"subtotal": 10,
"total": 10,
"original_total": 10,
"discount_total": 0,
"discount_subtotal": 0,
"discount_tax_total": 0,
"tax_total": 0,
"original_tax_total": 0,
}
]
}
```
### Order Grand Total
The order's grand total is the `total` field in the `order` object. It represents the total amount of the order, including all line items, shipping methods, taxes, and discounts.
### Order Line Item Totals
The `items` array in the `order` object contains total fields for each line item:
- `unit_price`: The price of a single unit of the line item. This field is not calculated and is stored in the database.
- `subtotal`: The total price of the line item before any discounts or taxes.
- `total`: The total price of the line item after applying discounts and taxes.
- `original_total`: The total price of the line item before any discounts.
- `discount_total`: The total amount of discounts applied to the line item.
- `discount_subtotal`: The total amount of discounts applied to the line item's subtotal.
- `discount_tax_total`: The total amount of discounts applied to the line item's tax.
- `tax_total`: The total tax amount applied to the line item.
- `original_tax_total`: The total tax amount applied to the line item before any discounts.
- `refundable_total_per_unit`: The total amount that can be refunded per unit of the line item.
- `refundable_total`: The total amount that can be refunded for the line item.
- `fulfilled_total`: The total amount of the line item that has been fulfilled.
- `shipped_total`: The total amount of the line item that has been shipped.
- `return_requested_total`: The total amount of the line item that has been requested for return.
- `return_received_total`: The total amount of the line item that has been received from a return.
- `return_dismissed_total`: The total amount of the line item that has been dismissed by a return.
- These items are considered damaged and are not returned to the inventory.
- `write_off_total`: The total amount of the line item that has been written off.
- For example, if the order is edited and the line item is removed or its quantity has changed.
### Order Shipping Method Totals
The `shipping_methods` array in the `order` object contains total fields for each shipping method:
- `amount`: The amount charged for the shipping method. This field is not calculated and is stored in the database.
- `subtotal`: The total price of the shipping method before any discounts or taxes.
- `total`: The total price of the shipping method after applying discounts and taxes.
- `original_total`: The total price of the shipping method before any discounts.
- `discount_total`: The total amount of discounts applied to the shipping method.
- `discount_subtotal`: The total amount of discounts applied to the shipping method's subtotal.
- `discount_tax_total`: The total amount of discounts applied to the shipping method's tax.
- `tax_total`: The total tax amount applied to the shipping method.
- `original_tax_total`: The total tax amount applied to the shipping method before any discounts.
---
## Caveats of Retrieving Order Totals
### Using Asterisk (*) in Order's Query
Order totals are calculated based on the order's line items, shipping methods, taxes, and any discounts applied. They are not stored in the `Order` data model.
For that reason, you cannot retrieve order totals by passing `*` to the Query's fields. For example, the following query will not return order totals:
<CodeTabs group="query-type">
<CodeTab label="useQueryGraphStep" value="useQueryGraphStep">
```ts
const { data: orders } = useQueryGraphStep({
entity: "order",
fields: ["*"],
filters: {
id: "order_123",
},
})
// orders don't include order totals
```
</CodeTab>
<CodeTab label="query.graph" value="query.graph">
```ts
const { data: [order] } = await query.graph({
entity: "order",
fields: ["*"],
filters: {
id: "order_123",
}
})
// order doesn't include order totals
```
</CodeTab>
</CodeTabs>
This will return the order data stored in the database, but not the calculated totals.
You also can't pass `*` along with `total` in the Query's fields option. Passing `*` will override the `total` field, and you will not retrieve order totals. For example, the following query will not return order totals:
<CodeTabs group="query-type">
<CodeTab label="useQueryGraphStep" value="useQueryGraphStep">
```ts
const { data: orders } = useQueryGraphStep({
entity: "order",
fields: ["*", "total"],
filters: {
id: "order_123",
},
})
// orders don't include order totals
```
</CodeTab>
<CodeTab label="query.graph" value="query.graph">
```ts
const { data: [order] } = await query.graph({
entity: "order",
fields: ["*", "total"],
filters: {
id: "order_123",
}
})
// order doesn't include order totals
```
</CodeTab>
</CodeTabs>
Instead, when you need to retrieve order totals, explicitly pass the `total` field in the Query's fields option, as shown in [the previous section](#how-to-retrieve-order-totals-with-query). You can also include other fields and relations you need, such as `email` and `items.*`.
### Applying Filters on Order Totals
You can't apply filters directly on the order totals, as they are not stored in the `Order` data model. You can still filter the order based on its properties, such as `id`, `email`, or `currency_code`, but not on the calculated totals.
www/apps/resources/generated/edit-dates.mjs
+3 -1
View File
@@ -6561,5 +6561,7 @@ export const generatedEditDates = {
"app/recipes/personalized-products/example/page.mdx": "2025-07-22T08:53:58.182Z",
"app/how-to-tutorials/tutorials/preorder/page.mdx": "2025-07-18T06:57:19.943Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.archive/page.mdx": "2025-07-24T08:20:57.709Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.complete/page.mdx": "2025-07-24T08:20:57.714Z"
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.complete/page.mdx": "2025-07-24T08:20:57.714Z",
"app/commerce-modules/cart/cart-totals/page.mdx": "2025-07-25T10:23:59.783Z",
"app/commerce-modules/order/order-totals/page.mdx": "2025-07-25T10:23:55.842Z"
}
www/apps/resources/generated/files-map.mjs
+8
View File
@@ -127,6 +127,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/auth/workflows/page.mdx",
"pathname": "/commerce-modules/auth/workflows"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/cart-totals/page.mdx",
"pathname": "/commerce-modules/cart/cart-totals"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/concepts/page.mdx",
"pathname": "/commerce-modules/cart/concepts"
@@ -303,6 +307,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/order/order-change/page.mdx",
"pathname": "/commerce-modules/order/order-change"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/order-totals/page.mdx",
"pathname": "/commerce-modules/order/order-totals"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/order-versioning/page.mdx",
"pathname": "/commerce-modules/order/order-versioning"
www/apps/resources/generated/generated-commerce-modules-sidebar.mjs
+16 -24
View File
@@ -1135,6 +1135,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/examples/guides/quote-management",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/cart/cart-totals",
"title": "Retrieve Cart Totals",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -6125,6 +6133,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"title": "Implement Re-Order",
"path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/re-order",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/order/order-totals",
"title": "Retrieve Order Totals",
"children": []
}
]
},
@@ -6760,14 +6776,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -9479,14 +9487,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -16208,14 +16208,6 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "removeDraftOrderShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderShippingMethodWorkflow",
"children": []
},
{
"loaded": true,
"isPathHref": true,
www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs
+16
View File
@@ -142,6 +142,22 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Retrieve Cart Totals",
"path": "https://docs.medusajs.com/resources/commerce-modules/cart/cart-totals",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Retrieve Order Totals",
"path": "https://docs.medusajs.com/resources/commerce-modules/order/order-totals",
"children": []
},
{
"loaded": true,
"isPathHref": true,
www/apps/resources/sidebars/cart.mjs
+5
View File
@@ -53,6 +53,11 @@ export const cartSidebar = [
path: "/commerce-modules/cart/extend",
title: "Extend Module",
},
{
type: "link",
path: "/commerce-modules/cart/cart-totals",
title: "Retrieve Cart Totals",
},
],
},
{
www/apps/resources/sidebars/order-module.mjs
+7
View File
@@ -82,6 +82,13 @@ export const orderSidebar = [
sort_sidebar: "alphabetize",
description:
"Learn how to use the Order Module in your customizations on the Medusa application server.",
children: [
{
type: "link",
path: "/commerce-modules/order/order-totals",
title: "Retrieve Order Totals",
},
],
},
{
type: "category",
www/packages/tags/src/tags/cart.ts
+4
View File
@@ -1,4 +1,8 @@
export const cart = [
{
"title": "Retrieve Cart Totals using Query",
"path": "https://docs.medusajs.com/resources/commerce-modules/cart/cart-totals"
},
{
"title": "Extend Cart",
"path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend"
www/packages/tags/src/tags/event-bus.ts
-8
View File
@@ -119,10 +119,6 @@ export const eventBus = [
"title": "confirmReturnRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow"
},
{
"title": "createAndCompleteReturnOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow"
},
{
"title": "createOrderFulfillmentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow"
@@ -155,10 +151,6 @@ export const eventBus = [
"title": "capturePaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow"
},
{
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow"
www/packages/tags/src/tags/how-to.ts
+8
View File
@@ -7,6 +7,14 @@ export const howTo = [
"title": "Handle Password Reset Event",
"path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password"
},
{
"title": "Retrieve Cart Totals",
"path": "https://docs.medusajs.com/resources/commerce-modules/cart/cart-totals"
},
{
"title": "Retrieve Order Totals",
"path": "https://docs.medusajs.com/resources/commerce-modules/order/order-totals"
},
{
"title": "Get Variant Prices",
"path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price"
www/packages/tags/src/tags/link.ts
-32
View File
@@ -31,10 +31,6 @@ export const link = [
"title": "createCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow"
},
{
"title": "createPaymentCollectionForCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentCollectionForCartWorkflow"
},
{
"title": "refreshCartItemsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow"
@@ -91,18 +87,10 @@ export const link = [
"title": "updateLinksWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLinksWorkflow"
},
{
"title": "confirmDraftOrderEditWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmDraftOrderEditWorkflow"
},
{
"title": "deleteDraftOrdersWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteDraftOrdersWorkflow"
},
{
"title": "requestDraftOrderEditWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestDraftOrderEditWorkflow"
},
{
"title": "deleteFulfillmentSetsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteFulfillmentSetsWorkflow"
@@ -119,18 +107,6 @@ export const link = [
"title": "deleteLineItemsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow"
},
{
"title": "confirmClaimRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow"
},
{
"title": "confirmExchangeRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow"
},
{
"title": "confirmOrderEditRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow"
},
{
"title": "confirmReturnRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow"
@@ -139,18 +115,10 @@ export const link = [
"title": "createAndCompleteReturnOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow"
},
{
"title": "createOrUpdateOrderPaymentCollectionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow"
},
{
"title": "createOrderFulfillmentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow"
},
{
"title": "createOrderPaymentCollectionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderPaymentCollectionWorkflow"
},
{
"title": "deleteOrderPaymentCollections",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderPaymentCollections"
www/packages/tags/src/tags/logger.ts
-4
View File
@@ -63,10 +63,6 @@ export const logger = [
"title": "refundPaymentsStep",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentsStep"
},
{
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow"
www/packages/tags/src/tags/order.ts
+4 -4
View File
@@ -35,6 +35,10 @@ export const order = [
"title": "Manage Return Reasons",
"path": "https://docs.medusajs.com/user-guide/settings/return-reasons"
},
{
"title": "Retrieve Order Totals Using Query",
"path": "https://docs.medusajs.com/resources/commerce-modules/order/order-totals"
},
{
"title": "Implement Quote Management",
"path": "https://docs.medusajs.com/resources/examples/guides/quote-management"
@@ -611,10 +615,6 @@ export const order = [
"title": "capturePaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow"
},
{
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow"
www/packages/tags/src/tags/payment.ts
-4
View File
@@ -143,10 +143,6 @@ export const payment = [
"title": "capturePaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow"
},
{
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow"
www/packages/tags/src/tags/query.ts
-88
View File
@@ -7,106 +7,22 @@ export const query = [
"title": "Get Variant Price with Taxes",
"path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes"
},
{
"title": "addShippingMethodToCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow"
},
{
"title": "addToCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow"
},
{
"title": "completeCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "listShippingOptionsForCartWithPricingWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow"
},
{
"title": "listShippingOptionsForCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWorkflow"
},
{
"title": "refreshCartItemsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow"
},
{
"title": "refreshCartShippingMethodsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow"
},
{
"title": "refundPaymentAndRecreatePaymentSessionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentAndRecreatePaymentSessionWorkflow"
},
{
"title": "transferCartCustomerWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow"
},
{
"title": "updateCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow"
},
{
"title": "updateLineItemInCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow"
},
{
"title": "useQueryGraphStep",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep"
},
{
"title": "deleteDraftOrdersWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteDraftOrdersWorkflow"
},
{
"title": "calculateShippingOptionsPricesWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/calculateShippingOptionsPricesWorkflow"
},
{
"title": "deleteInventoryItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInventoryItemWorkflow"
},
{
"title": "deleteLineItemsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow"
},
{
"title": "acceptOrderTransferWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptOrderTransferWorkflow"
},
{
"title": "cancelOrderTransferRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderTransferRequestWorkflow"
},
{
"title": "cancelOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow"
},
{
"title": "createOrderCreditLinesWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderCreditLinesWorkflow"
},
{
"title": "declineOrderTransferRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderTransferRequestWorkflow"
},
{
"title": "maybeRefreshShippingMethodsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/maybeRefreshShippingMethodsWorkflow"
},
{
"title": "updateOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderWorkflow"
},
{
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow"
},
{
"title": "batchProductVariantsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow"
@@ -122,9 +38,5 @@ export const query = [
{
"title": "deleteShippingProfileWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingProfileWorkflow"
},
{
"title": "updateStockLocationsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStockLocationsWorkflow"
}
]
www/packages/tags/src/tags/remote-query.ts
-136
View File
@@ -15,10 +15,6 @@ export const remoteQuery = [
"title": "addToCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow"
},
{
"title": "completeCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow"
},
{
"title": "createCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow"
@@ -27,30 +23,14 @@ export const remoteQuery = [
"title": "createPaymentCollectionForCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentCollectionForCartWorkflow"
},
{
"title": "listShippingOptionsForCartWithPricingWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow"
},
{
"title": "listShippingOptionsForCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWorkflow"
},
{
"title": "refreshCartItemsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow"
},
{
"title": "refreshCartShippingMethodsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow"
},
{
"title": "refreshPaymentCollectionForCartWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow"
},
{
"title": "refundPaymentAndRecreatePaymentSessionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentAndRecreatePaymentSessionWorkflow"
},
{
"title": "transferCartCustomerWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow"
@@ -83,82 +63,26 @@ export const remoteQuery = [
"title": "addDraftOrderItemsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow"
},
{
"title": "addDraftOrderPromotionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderPromotionWorkflow"
},
{
"title": "addDraftOrderShippingMethodsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderShippingMethodsWorkflow"
},
{
"title": "beginDraftOrderEditWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginDraftOrderEditWorkflow"
},
{
"title": "cancelDraftOrderEditWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelDraftOrderEditWorkflow"
},
{
"title": "confirmDraftOrderEditWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmDraftOrderEditWorkflow"
},
{
"title": "convertDraftOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/convertDraftOrderWorkflow"
},
{
"title": "removeDraftOrderActionItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderActionItemWorkflow"
},
{
"title": "removeDraftOrderActionShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderActionShippingMethodWorkflow"
},
{
"title": "removeDraftOrderPromotionsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderPromotionsWorkflow"
},
{
"title": "removeDraftOrderShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderShippingMethodWorkflow"
},
{
"title": "requestDraftOrderEditWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestDraftOrderEditWorkflow"
},
{
"title": "updateDraftOrderActionItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderActionItemWorkflow"
},
{
"title": "updateDraftOrderActionShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderActionShippingMethodWorkflow"
},
{
"title": "updateDraftOrderItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderItemWorkflow"
},
{
"title": "updateDraftOrderShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderShippingMethodWorkflow"
},
{
"title": "updateDraftOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderWorkflow"
},
{
"title": "setShippingOptionsPricesStep",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setShippingOptionsPricesStep"
},
{
"title": "createFulfillmentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createFulfillmentWorkflow"
},
{
"title": "createReturnFulfillmentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnFulfillmentWorkflow"
},
{
"title": "markFulfillmentAsDeliveredWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow"
@@ -223,10 +147,6 @@ export const remoteQuery = [
"title": "cancelBeginOrderClaimWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderClaimWorkflow"
},
{
"title": "cancelBeginOrderEditWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderEditWorkflow"
},
{
"title": "cancelBeginOrderExchangeWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderExchangeWorkflow"
@@ -315,18 +235,10 @@ export const remoteQuery = [
"title": "createReturnShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow"
},
{
"title": "deleteOrderPaymentCollections",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderPaymentCollections"
},
{
"title": "dismissItemReturnRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/dismissItemReturnRequestWorkflow"
},
{
"title": "fetchShippingOptionForOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/fetchShippingOptionForOrderWorkflow"
},
{
"title": "getOrderDetailWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/getOrderDetailWorkflow"
@@ -347,30 +259,14 @@ export const remoteQuery = [
"title": "orderClaimAddNewItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow"
},
{
"title": "orderClaimItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimItemWorkflow"
},
{
"title": "orderClaimRequestItemReturnWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimRequestItemReturnWorkflow"
},
{
"title": "orderEditAddNewItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow"
},
{
"title": "orderEditUpdateItemQuantityWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow"
},
{
"title": "orderExchangeAddNewItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow"
},
{
"title": "orderExchangeRequestItemReturnWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow"
},
{
"title": "receiveAndCompleteReturnOrderWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/receiveAndCompleteReturnOrderWorkflow"
@@ -399,10 +295,6 @@ export const remoteQuery = [
"title": "removeItemExchangeActionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemExchangeActionWorkflow"
},
{
"title": "removeItemOrderEditActionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemOrderEditActionWorkflow"
},
{
"title": "removeItemReceiveReturnActionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReceiveReturnActionWorkflow"
@@ -411,10 +303,6 @@ export const remoteQuery = [
"title": "removeItemReturnActionWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReturnActionWorkflow"
},
{
"title": "removeOrderEditShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeOrderEditShippingMethodWorkflow"
},
{
"title": "removeReturnShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeReturnShippingMethodWorkflow"
@@ -423,10 +311,6 @@ export const remoteQuery = [
"title": "requestItemReturnWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestItemReturnWorkflow"
},
{
"title": "requestOrderEditRequestWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow"
},
{
"title": "requestOrderTransferWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderTransferWorkflow"
@@ -451,14 +335,6 @@ export const remoteQuery = [
"title": "updateExchangeShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeShippingMethodWorkflow"
},
{
"title": "updateOrderEditAddItemWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditAddItemWorkflow"
},
{
"title": "updateOrderEditItemQuantityWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditItemQuantityWorkflow"
},
{
"title": "updateOrderEditShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditShippingMethodWorkflow"
@@ -487,18 +363,10 @@ export const remoteQuery = [
"title": "capturePaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow"
},
{
"title": "processPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow"
},
{
"title": "refundPaymentWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow"
},
{
"title": "createPaymentSessionsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentSessionsWorkflow"
},
{
"title": "validateVariantPriceLinksStep",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateVariantPriceLinksStep"
@@ -547,10 +415,6 @@ export const remoteQuery = [
"title": "upsertVariantPricesWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/upsertVariantPricesWorkflow"
},
{
"title": "updatePromotionsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsWorkflow"
},
{
"title": "setRegionsPaymentProvidersStep",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setRegionsPaymentProvidersStep"
www/packages/tags/src/tags/server.ts
+8
View File
@@ -7,6 +7,10 @@ export const server = [
"title": "Handle Password Reset Event",
"path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password"
},
{
"title": "Retrieve Cart Totals using Query",
"path": "https://docs.medusajs.com/resources/commerce-modules/cart/cart-totals"
},
{
"title": "Extend Cart",
"path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend"
@@ -15,6 +19,10 @@ export const server = [
"title": "Extend Customer",
"path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend"
},
{
"title": "Retrieve Order Totals Using Query",
"path": "https://docs.medusajs.com/resources/commerce-modules/order/order-totals"
},
{
"title": "Extend Product",
"path": "https://docs.medusajs.com/resources/commerce-modules/product/extend"
www/packages/tags/src/tags/tax.ts
-4
View File
@@ -55,10 +55,6 @@ export const tax = [
"title": "addDraftOrderShippingMethodsWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderShippingMethodsWorkflow"
},
{
"title": "removeDraftOrderShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderShippingMethodWorkflow"
},
{
"title": "updateDraftOrderShippingMethodWorkflow",
"path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderShippingMethodWorkflow"