Files
medusa-store/www/apps/docs/content/user-guide/gift-cards/index.md
Shahed Nasser bb87db8342 docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00

858 B
Raw Blame History

sidebar_position, description
sidebar_position description
1 Medusa Admin allows merchants to manage gift cards. Merchants can manage main and custom gift cards.

Gift Cards Overview

In this document, youll learn about how Gift Cards in Medusa work.

Overview

In Medusa, theres one main gift card. A gift card can have multiple denominations. For example, a Gift Card can have the amounts of $20 and $50, and customers can buy one of these denominations.


Custom Gift Cards

You can also create custom gift cards in Medusa. These cards can be created and sent directly to a customers email.

To view the list of available custom gift cards, from the sidebar go to Gift Cards. You can find all custom gift cards in the History section.


Learn More About Gift Cards