Medusa Recipes

https://docs.medusajs.com/resources/recipes
Admin
Medusa Recipes provides practical guides and example implementations for common e-commerce use...
Tokens:170,033
Snippets:1,340
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Moment.js

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

Install the Moment.js library to assist with date manipulation and formatting. This is a prerequisite for the custom date logic.

```bash
yarn add moment
```

--------------------------------

### Install Medusa Ecommerce App with Next.js Starter

Source: https://docs.medusajs.com/resources/recipes/ecommerce

Use this command to install a Medusa ecommerce store with a Next.js Starter storefront. This includes the Medusa application server and admin dashboard, as well as a storefront for customer interaction.

```bash
yarn dlx create-medusa-app@latest --with-nextjs-starter
```

--------------------------------

### Start Medusa Application

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Command to start the Medusa application in development mode.

```bash
npm run dev
```

--------------------------------

### Install Medusa Application

Source: https://docs.medusajs.com/resources/recipes/erp

Use this command to create a new Medusa application. You can optionally choose to install the Next.js Starter Storefront.

```bash
yarn dlx create-medusa-app@latest
```

--------------------------------

### Navigate to Storefront Directory

Source: https://docs.medusajs.com/resources/recipes/ticket-booking/example/storefront

Change to the Next.js Starter Storefront directory. Adjust the directory name based on your project setup.

```bash
cd ../medusa-ticketing-storefront # change based on your project name
```

--------------------------------

### Start Medusa Application

Source: https://docs.medusajs.com/resources/recipes/erp/odoo

Start the Medusa application using your preferred package manager (yarn, pnpm, or npm). This command initiates the Medusa server, allowing the scheduled jobs to run.

```bash
yarn dev
```

--------------------------------

### Install Medusa CLI

Source: https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard

Install the Medusa CLI using your preferred package manager.

```bash
yarn
```

```bash
pnpm
```

```bash
npm
```

--------------------------------

### Install QR Code Package

Source: https://docs.medusajs.com/resources/recipes/ticket-booking/example

Installs the 'qrcode' package and its types for use in the Medusa application.

```bash
yarn add qrcode
yarn add --dev @types/qrcode
```

--------------------------------

### Start Medusa Application

Source: https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard

Command to start the Medusa application using yarn.

```bash
❯yarn dev
```

--------------------------------

### Await Start Preparation Step

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

An asynchronous step that waits for the restaurant to mark the delivery as 'restaurant_preparing'. It logs a message indicating it's waiting.

```typescript
1import { createStep } from "@medusajs/framework/workflows-sdk"

3export const awaitStartPreparationStepId = "await-start-preparation-step"
4export const awaitStartPreparationStep = createStep(
5  { name: awaitStartPreparationStepId, async: true, timeout: 60 * 15 },
6  async function (_, { container }) {
7    const logger = container.resolve("logger")
8    logger.info("Awaiting start of preparation...")
  }
)

```

--------------------------------

### Pricing Step Component Setup (React)

Source: https://docs.medusajs.com/resources/recipes/ticket-booking/example

Sets up the pricing step component, which requires venue and currency information. It displays a message if no venue is selected.

```tsx
import { Text } from "@medusajs/ui"
import { RowType, Venue } from "../types"

export interface CurrencyRegionCombination {
  currency: string
  region_id?: string
  region_name?: string
  is_store_currency: boolean
}

interface PricingStepProps {
  selectedVenue: Venue | undefined
  currencyRegionCombinations: CurrencyRegionCombination[]
  prices: Record<string, Record<string, number>>
  setPrices: (prices: Record<string, Record<string, number>>) => void
}

export const PricingStep = ({
  selectedVenue,
  currencyRegionCombinations,
  prices,
  setPrices,
}: PricingStepProps) => {
  if (!selectedVenue) {
    return (
      <div className="text-center py-8">
        <Text>Please select a venue in the previous step</Text>
      </div>
    )
  }

  // TODO add price and row type functions
}
```

--------------------------------

### Get Customer Subscriptions Request

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

Example cURL command to retrieve a customer's subscriptions using their authentication token.

```curl
curl 'http://localhost:9000/store/customers/me/subscriptions' \
-H 'Authorization: Bearer {token}' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
```

--------------------------------

### Get Digital Product Preview Links

Source: https://docs.medusajs.com/resources/recipes/digital-products/examples/standard

Fetches the preview links for a digital product. Ensure the necessary SDK and authentication headers are set up.

```typescript
import { DigitalProductPreview } from "../../types/global"

export const getDigitalProductPreview = async function ({id}: {id: string}) {
  const headers = {
    ...(await getAuthHeaders()),
  }
  const next = {
    ...(await getCacheOptions("products")),
  }
  const { previews } = await sdk.client.fetch<{
    previews: DigitalProductPreview[]
  }>(`/store/digital-products/${id}/preview`, {
    headers,
    next,
    cache: "force-cache",
  })
  // for simplicity, return only the first preview url
  // instead you can show all the preview media to the customer
  return previews.length ? previews[0].url : ""
}
```

--------------------------------

### Customer Login Request

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

Example cURL command to log in a customer using email and password to obtain an authentication token.

```curl
curl -X POST 'http://localhost:9000/auth/customer/emailpass' \
-H 'Content-Type: application/json' \
--data-raw '{ \
    "email": "customer@gmail.com", \
    "password": "supersecret" \
}'
```

--------------------------------

### Test Create Restaurant API Route

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Example cURL command to send a POST request to the /restaurants endpoint to create a new restaurant.

```bash
curl -X POST 'http://localhost:9000/restaurants' \
-H 'Content-Type: application/json' \
--data-raw '{ \
    "name": "Acme", \
    "handle": "acme", \
    "address": "1st street", \
    "phone": "1234567", \
    "email": "acme@restaurant.com" \
}'
```

--------------------------------

### Integrate Delivery Middlewares

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

This example shows how to import and integrate the defined delivery middlewares into the main `src/api/middlewares.ts` file to apply them to the API routes.

```typescript
// other imports...
import deliveriesMiddlewares from "./deliveries/[id]/middlewares"

export default defineMiddlewares({
  routes: [
    // ...
	  ...deliveriesMiddlewares.routes!,
  ],
})
```

--------------------------------

### Register Restaurant Admin User

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Example cURL command to register a new restaurant admin user. Requires email and password to obtain an authentication token.

```bash
curl -X POST 'http://localhost:9000/auth/restaurant/emailpass/register' \
--data-raw '{ \
    "email": "admin@restaurant.com", \
    "password": "supersecret" \
}'
```

--------------------------------

### Test List Restaurants API Route

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Send a GET request to the `/restaurants` endpoint to test the API route and retrieve the list of restaurants.

```bash
curl 'http://localhost:9000/restaurants'
```

--------------------------------

### Test POST Request for Order Preparation

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Example cURL command to test the POST API route for indicating order preparation. Replace placeholders with actual delivery ID and authentication token.

```bash
curl -X POST 'http://localhost:9000/deliveries/01J67MSXQE59KRBA3C7CJSQM0A/prepare' \
-H 'Authorization: Bearer {token}'
```

--------------------------------

### Test POST Request for Delivery Ready

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Example cURL command to test the POST API route for indicating delivery is ready for pickup. Replace placeholders with actual delivery ID and authentication token.

```bash
curl -X POST 'http://localhost:9000/deliveries/01J67MSXQE59KRBA3C7CJSQM0A/ready' \
-H 'Authorization: Bearer {token}'
```

--------------------------------

### Bundle Actions Component Setup

Source: https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard

Initializes the BundleActions component, defining state for selected product options and adding status. It includes a helper function to format variant options for easier comparison.

```typescript
import Thumbnail from "../thumbnail"
import { useState, useMemo, useEffect } from "react"
import { useParams } from "react-router-dom"
import { BundleProduct } from "./types"
import { HttpTypes } from "@medusajs/types"
import isEqual from "lodash/isEqual"

const optionsAsKeymap = (
  variantOptions: HttpTypes.StoreProductVariant["options"]
) => {
  return variantOptions?.reduce((acc: Record<string, string>, varopt: any) => {
    acc[varopt.option_id] = varopt.value
    return acc
  }, {})
}

export default function BundleActions({
  bundle,
}: BundleActionsProps) {
  const [productOptions, setProductOptions] = useState<
    Record<string, Record<string, string>>
  >({})
  const [isAdding, setIsAdding] = useState(false)
  const countryCode = useParams().countryCode as string

  // TODO retrieve and set selected variants and options
}
```

--------------------------------

### Query Parameter Validation Middleware

Source: https://docs.medusajs.com/resources/recipes/ticket-booking/example

Applies middleware to validate and transform query parameters for specific API routes. The `validateAndTransformQuery` middleware uses a provided Zod schema to ensure incoming query parameters conform to the expected structure and types. This example shows how to apply it to the `GET /store/ticket-products/:id/seats` route.

```APIDOC
## Middleware Configuration

### Description
Configures API route middlewares, including query parameter validation. The `validateAndTransformQuery` middleware is used with a Zod schema to validate and transform query parameters before they reach the route handler.

### Usage
In `src/api/middlewares.ts`:

1. Import the Zod schema:
   ```typescript
   import { GetTicketProductSeatsSchema } from "./store/ticket-products/[id]/seats/route"
   ```

2. Add the route configuration to the `routes` array passed to `defineMiddlewares`:
   ```typescript
   export default defineMiddlewares({
     routes: [
       // ... other routes
       {
         matcher: "/store/ticket-products/:id/seats",
         methods: ["GET"],
         middlewares: [validateAndTransformQuery(GetTicketProductSeatsSchema, {})],
       },
     ],
   })
   ```

### Parameters for `validateAndTransformQuery`
- **schema** (ZodSchema) - The Zod schema used for validation and transformation.
- **options** (object) - Optional configuration options for the middleware.
```

--------------------------------

### Create a Product in a Restaurant

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Send a POST request to the /restaurants/[id]/products endpoint to create a new product. Ensure the Authorization header is set and the request body contains product details, including variants and sales channels.

```bash
curl -X POST 'http://localhost:9000/restaurants/res_01J5X704WQTFSZMRC7Z6S3YAC7/products' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {token}' \
--data '{ \
    "products": [ \
        { \
            "title": "Sushi", \
            "status": "published", \
            "variants": [ \
                { \
                    "title": "Default", \
                    "prices": [ \
                        { \
                            "currency_code": "eur", \
                            "amount": 20 \
                        } \
                    ], \
                    "manage_inventory": false, \
                    "options": [ \
                      { \
                        "title": "Default Title", \
                        "values": ["Default Value"] \
                      } \
                    ] \
                } \
            ], \
            "sales_channels": [ \
                { \
                    "id": "sc_01J5ZWK4MKJF85PM8KTW0BWMCK" \
                } \
            ] \
        } \
    ] \
}'
```

--------------------------------

### Generate Restaurant and Delivery Module Migrations

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Run these commands to generate database migrations for the Restaurant and Delivery modules. Migrations will be created in the respective module directories.

```bash
yarn medusa db:generate restaurantModuleService
yarn medusa db:generate deliveryModuleService
```

--------------------------------

### GET API Route for Bundled Products

Source: https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard

This code defines a GET API route handler in TypeScript that retrieves bundled products using the Medusa Query module. It handles authentication and returns bundled products with pagination details.

```typescript
export async function GET(req: AuthenticatedMedusaRequest, res: MedusaResponse) {
  const query = req.scope.resolve("query")

  const { 
    data: bundledProducts, 
    metadata: { count, take, skip } = {},
  } = await query.graph({
    entity: "bundle",
    ...req.queryConfig,
  })

  res.json({
    bundled_products: bundledProducts,
    count: count || 0,
    limit: take || 15,
    offset: skip || 0,
  })
}
```

--------------------------------

### Admin API Route to Get Subscription by ID

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

This code defines a GET API route in Medusa to retrieve a single subscription by its ID. It uses the Query module to fetch subscription details along with related orders and customer information.

```typescript
import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
import { ContainerRegistrationKeys } from "@medusajs/framework/utils"

export const GET = async (
  req: AuthenticatedMedusaRequest,
  res: MedusaResponse
) => {
  const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)

  const { data: [subscription] } = await query.graph({
    entity: "subscription",
    fields: [
      "*",
      "orders.*",
      "customer.*",
    ],
    filters: {
      id: [req.params.id],
    },
  })

  res.json({
    subscription,
  })
}
```

--------------------------------

### Get Single Subscription

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

Retrieves a single subscription by its ID. This endpoint is part of the admin API.

```APIDOC
## GET /admin/subscriptions/[id]

### Description
Retrieves a single subscription by its ID.

### Method
GET

### Endpoint
/admin/subscriptions/[id]

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the subscription to retrieve.

### Response
#### Success Response (200)
- **subscription** (object) - The retrieved subscription object, including related orders and customer details.

### Response Example
```json
{
  "subscription": {
    "id": "sub_123",
    "status": "active",
    "interval": "monthly",
    "subscription_date": "2023-01-01T10:00:00Z",
    "last_order_date": "2023-12-01T10:00:00Z",
    "next_order_date": "2024-01-01T10:00:00Z",
    "expiration_date": "2024-12-31T23:59:59Z",
    "metadata": {},
    "orders": [
      {
        "id": "order_456"
      }
    ],
    "customer": {
      "id": "cus_789"
    }
  }
}
```
```

--------------------------------

### Generate Digital Product Migrations

Source: https://docs.medusajs.com/resources/recipes/digital-products/examples/standard

Run this command to generate database migrations for the digital product module. This creates the necessary tables for digital product data models.

```bash
yarn medusa db:generate digitalProductModuleService
```

--------------------------------

### Get Row Type Label

Source: https://docs.medusajs.com/resources/recipes/ticket-booking/example

Formats the row type into a display-friendly label, capitalizing the first letter.

```typescript
const getRowTypeLabel = (type: RowType) => {
  switch (type) {
    case RowType.VIP:
      return "VIP"
    default:
      return type.charAt(0).toUpperCase() + type.slice(1)
  }
}
```

--------------------------------

### Await Preparation Step

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

An asynchronous step that waits for the restaurant to mark the delivery as 'ready_for_pickup'. It logs a message indicating it's waiting.

```typescript
1import { createStep } from "@medusajs/framework/workflows-sdk"

3export const awaitPreparationStepId = "await-preparation-step"
4export const awaitPreparationStep = createStep(
5  { name: awaitPreparationStepId, async: true, timeout: 60 * 15 },
6  async function (_, { container }) {
7    const logger = container.resolve("logger")
8    logger.info("Awaiting preparation...")
  }
)

```

--------------------------------

### Get Row Type Color

Source: https://docs.medusajs.com/resources/recipes/ticket-booking/example

Returns a predefined color string based on the row type, used for visual distinction in the UI.

```typescript
const getRowTypeColor = (type: RowType): "purple" | "orange" | "blue" | "grey" => {
  switch (type) {
    case RowType.VIP:
      return "purple"
    case RowType.PREMIUM:
      return "orange"
    case RowType.BALCONY:
      return "blue"
    default:
      return "grey"
  }
}
```

--------------------------------

### Create Restaurant Admin User Request

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Example cURL command to create a restaurant admin user. It requires the authentication token obtained from the registration step and specific user details including actor_type and restaurant_id.

```bash
curl -X POST 'http://localhost:9000/users' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {token}' \
--data-raw '{ \
    "email": "admin@restaurant.com", \
    "first_name": "admin", \
    "last_name": "restaurant", \
    "phone": "1234566", \
    "actor_type": "restaurant", \
    "restaurant_id": "res_01J5ZWMY48JWFY4W5Y8B3NER7S" \
}'
```

--------------------------------

### Get Driver Authentication Token

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Obtain the authentication token for a registered driver user by sending a POST request with their email and password.

```bash
curl --location 'http://localhost:9000/auth/driver/emailpass' \
--header 'Content-Type: application/json' \
--data-raw '{ \
    "email": "driver@gmail.com", \
    "password": "supersecret" \
}'
```

--------------------------------

### Cancel Subscription Request

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

Example cURL command to cancel a specific subscription by its ID, using the customer's authentication token.

```curl
curl -X POST 'http://localhost:9000/store/customers/me/subscriptions/01J2VB8TVC14K29FREQ2DRS6NA' \
-H 'Authorization: Bearer {token}' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
```

--------------------------------

### Generate Subscription Module Migrations

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

Use this command to generate the necessary migration files for the Subscription module's data model. This command should be run before applying the migrations.

```bash
yarn medusa db:generate subscriptionModuleService
```

--------------------------------

### Create Subscription Step Implementation

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

This step creates a subscription using the SubscriptionModuleService and prepares link definitions for associating the subscription with orders, carts, and customers. It includes metadata for the main order ID.

```typescript
import {
  createStep,
  StepResponse,
  SubscriptionInterval,
  LinkDefinition,
  Modules,
} from "@medusajs/medusa"
import {
  SubscriptionModuleService,
  SUBSCRIPTION_MODULE,
} from "../../../modules/subscription"

type StepInput = {
  cart_id: string
  order_id: string
  customer_id?: string
  subscription_data: {
    interval: SubscriptionInterval
    period: number
  }
}

const createSubscriptionStep = createStep(
  "create-subscription",
  async ({ 
    cart_id, 
    order_id, 
    customer_id,
    subscription_data,
  }: StepInput, { container }) => {
    const subscriptionModuleService: SubscriptionModuleService = 
      container.resolve(SUBSCRIPTION_MODULE)
    const linkDefs: LinkDefinition[] = []

    const subscription = await subscriptionModuleService.createSubscriptions({
      ...subscription_data,
      metadata: {
        main_order_id: order_id,
      },
    })

    // TODO add links

    return new StepResponse({
      subscription: subscription[0],
      linkDefs,
    }, {
      subscription: subscription[0],
    })
  }, async (data, { container }) => {
    // TODO implement compensation
  }
)

export default createSubscriptionStep
```

--------------------------------

### Retrieve Digital Product Previews API Route

Source: https://docs.medusajs.com/resources/recipes/digital-products/examples/standard

Adds a GET API route at `/store/digital-products/[id]/preview`. Retrieves preview media for a digital product and returns their URLs. Requires the digital product ID as a parameter.

```typescript
import {
  MedusaRequest,
  MedusaResponse,
} from "@medusajs/medusa"
import {
  DIGITAL_PRODUCT_MODULE,
  Modules,
} from "@medusajs/utils"
import {
  DigitalProductModuleService,
} from "@medusajs/medusa/dist/modules/digital-product"
import {
  MediaType,
} from "../../../modules/digital-product/types"

export const GET = async (
  req: MedusaRequest,
  res: MedusaResponse
) => {
  const fileModuleService = req.scope.resolve(
    Modules.FILE
  )

  const digitalProductModuleService: DigitalProductModuleService = req.scope.resolve(
    DIGITAL_PRODUCT_MODULE
  )

  const medias = await digitalProductModuleService.listDigitalProductMedias({
    digital_product_id: req.params.id,
    type: MediaType.PREVIEW,
  })

  const normalizedMedias = await Promise.all(
    medias.map(async (media) => {
      const { fileId, ...mediaData } = media
      const fileData = await fileModuleService.retrieveFile(fileId)

      return {
        ...mediaData,
        url: fileData.url,
      }
    })
  )

  res.json({
    previews: normalizedMedias,
  })
}
```

--------------------------------

### Initialize Medusa JS SDK

Source: https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard

Configure the Medusa JS SDK by creating a `sdk.ts` file. This instance is used to send requests to your Medusa server from the admin customization.

```typescript
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: "http://localhost:9000",
  debug: process.env.NODE_ENV === "development",
  auth: {
    type: "session",
  },
})
```

--------------------------------

### Get Customer Digital Products

Source: https://docs.medusajs.com/resources/recipes/digital-products/examples/standard

Retrieves a logged-in customer's purchased digital products. This function sends a request to the appropriate API route.

```typescript
"use server"

import { DigitalProduct } from "../../types/global"
import { sdk } from "../config"
import { getAuthHeaders, getCacheOptions } from "./cookies"

export const getCustomerDigitalProducts = async () => {
  const headers = {
    ...(await getAuthHeaders()),
  }
  const next = {
    ...(await getCacheOptions("products")),
  }
  const { digital_products } = await sdk.client.fetch<{
    digital_products: DigitalProduct[]
  }>(`/store/customers/me/digital-products`, {
    headers,
    next,
   cache: "no-cache",
  })
  return digital_products as DigitalProduct[]
}
```

--------------------------------

### Create Restaurant Admin Step

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

This step creates a restaurant admin user in the database. It accepts restaurant and user details as input. The compensation function deletes the admin if an error occurs.

```typescript
import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
import { RESTAURANT_MODULE } from "../../../modules/restaurant"
import RestaurantModuleService from "../../../modules/restaurant/service"

export type CreateRestaurantAdminInput = {
  restaurant_id: string;
  email: string;
  first_name: string;
  last_name: string;
};

export const createRestaurantAdminStep = createStep(
  "create-restaurant-admin-step",
  async (
    data: CreateRestaurantAdminInput,
    { container } 
  ) => {
    const restaurantModuleService: RestaurantModuleService = container.resolve(
      RESTAURANT_MODULE
    )
    const restaurantAdmin = await restaurantModuleService.createRestaurantAdmins(
      data
    )

    return new StepResponse(restaurantAdmin, restaurantAdmin.id)
  },
  async (id, { container }) => {
    if (!id) {
      return
    }

    const restaurantModuleService: RestaurantModuleService = 
      container.resolve(RESTAURANT_MODULE)

    await restaurantModuleService.deleteRestaurantAdmins(id)
  }
)
```

--------------------------------

### Handle Digital Product Preview Download

Source: https://docs.medusajs.com/resources/recipes/digital-products/examples/standard

Handles the logic for downloading a digital product preview. It calls getDigitalProductPreview and opens the returned URL in a new window if available.

```typescript
// other imports...
import { getDigitalProductPreview } from "../../../../lib/data/products"

export default function ProductActions({
  product,
  region,
  disabled,
}: ProductActionsProps) {
  // ...
  const handleDownloadPreview = async () => {
    if (!selectedVariant?.digital_product) {
      return
    }
    const downloadUrl = await getDigitalProductPreview({
      id: selectedVariant?.digital_product.id,
    })
    if (downloadUrl.length) {
      window.open(downloadUrl)
    }
  }
  // ...
}
```

--------------------------------

### Add getExpirationDate Method to SubscriptionModuleService

Source: https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard

This method calculates and returns the expiration date of a subscription. It uses the subscription's start date, interval, and period for the calculation.

```typescript
class SubscriptionModuleService extends MedusaService({
  Subscription,
}) {
  // ...
  getExpirationDate({
    subscription_date,
    interval,
    period,
  }: {
    subscription_date: Date,
    interval: SubscriptionInterval,
    period: number
  }) {
    return moment(subscription_date)
      .add(
        period,
        interval === SubscriptionInterval.MONTHLY ?
          "month" : "year"
      ).toDate()
  }
}
```

--------------------------------

### Install JSONRPC Package for Odoo

Source: https://docs.medusajs.com/resources/recipes/erp/odoo

Adds the json-rpc-2.0 package to your Medusa application using yarn. This package is required for connecting to Odoo's JSON-RPC APIs.

```bash
yarn add json-rpc-2.0
```

--------------------------------

### Add Creation Logic for Bundled Product

Source: https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard

This code implements the mutation to create a bundled product. It uses `useMutation` to send a POST request to the `/admin/bundled-products` endpoint with the bundle details, including title, product information, and items. It also includes success and error handling with toasts and invalidates the 'bundled-products' query cache.

```typescript
const { 
  mutateAsync: createBundledProduct, 
  isPending: isCreating,
} = useMutation({
  mutationFn: async (data: Record<string, any>) => {
    await sdk.client.fetch("/admin/bundled-products", {
      method: "POST",
      body: data,
    })
  },
})

const handleCreate = async () => {
  try {
    await createBundledProduct({
      title,
      product: {
        title,
        options: [
          {
            title: "Default",
            values: ["default"],
          },
        ],
        status: "published",
        variants: [
          {
            title,
            // You can set prices in the product's page
            prices: [],
            options: {
              Default: "default",
            },
            manage_inventory: false,
          },
        ],
      },
      items: items.map((item) => ({
        product_id: item.product_id,
        quantity: item.quantity,
      })),
    })
    setOpen(false)
    toast.success("Bundled product created successfully")
    queryClient.invalidateQueries({
      queryKey: ["bundled-products"],
    })
    setTitle("")
    setItems([{ product_id: undefined, quantity: 1 }])
  } catch (error) {
    toast.error("Failed to create bundled product")
  }
}
```

--------------------------------

### Register Driver

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery

Use this endpoint to register a new driver by providing their email and password. This is the first step in creating a driver account.

```bash
curl -X POST 'http://localhost:9000/auth/driver/emailpass/register' \
-H 'Content-Type: application/json' \
--data-raw '{ \
    "email": "driver@gmail.com", \
    "password": "supersecret" \
}'
```

--------------------------------

### Import QR Code Library

Source: https://docs.medusajs.com/resources/recipes/ticket-booking/example

Imports necessary utilities and the QRCode library at the top of the service file.

```typescript
import { promiseAll } from "@medusajs/framework/utils"
import QRCode from "qrcode"
```

--------------------------------

### Retrieve Bundles API Route

Source: https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard

This section details the GET API route for retrieving bundles. It explains how to access the route, the underlying query mechanism, and the structure of the response.

```APIDOC
## GET /admin/bundled-products

### Description
Retrieves a list of bundled products with pagination support.

### Method
GET

### Endpoint
/admin/bundled-products

### Parameters
#### Query Parameters
- **fields** (string) - Optional - The fields to retrieve in a bundle.
- **limit** (number) - Optional - The maximum number of bundles to retrieve.
- **offset** (number) - Optional - The number of bundles to skip before retrieving the bundles.
- **order** (string) - Optional - The fields to sort the result by.

### Response
#### Success Response (200)
- **bundled_products** (array) - The list of bundled products.
- **count** (number) - The total number of bundles available.
- **limit** (number) - The limit of bundles returned in the current response.
- **offset** (number) - The offset used for pagination.

#### Response Example
```json
{
  "bundled_products": [
    {
      "id": "bundle_1",
      "title": "Example Bundle",
      "product": { ... },
      "items": [
        {
          "product": { ... }
        }
      ]
    }
  ],
  "count": 10,
  "limit": 15,
  "offset": 0
}
```
```

--------------------------------

### Retrieve Vendor Products cURL Request

Source: https://docs.medusajs.com/resources/recipes/marketplace/examples/vendors

This is a cURL command to test the API route for retrieving a vendor's products. It sends a GET request with an authorization token.

```bash
curl 'http://localhost:9000/vendors/products' \
-H 'Authorization: Bearer {token}'
```

--------------------------------

### Update Next.js Starter Storefront to Use Custom Completion Route

Source: https://docs.medusajs.com/resources/recipes/digital-products/examples/standard

Replaces the default SDK call for completing a cart with a custom POST request to the new `/store/carts/[id]/complete-digital` endpoint. This ensures the custom workflow is triggered.

```typescript
const cartRes = await sdk.client.fetch<HttpTypes.StoreCompleteCartResponse>(
  `/store/carts/${id}/complete-digital`,
    {
      method: "POST",
      headers,
    }
  )
```
Tokens:
Raw