bb87db8342
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.
94 lines
4.5 KiB
Plaintext
94 lines
4.5 KiB
Plaintext
---
|
||
sidebar_position: 3
|
||
description: 'This user guide explains how to manage custom gift cards on the Medusa Admin. Learn how to create and edit custom gift cards.'
|
||
addHowToData: true
|
||
---
|
||
|
||
import UiIcon from '@site/src/components/UiIcon';
|
||
|
||
# Manage Custom Gift Cards
|
||
|
||
In this document, you’ll learn how to manage custom gift cards, including how to create and update them.
|
||
|
||
## Create Custom Gift Card
|
||
|
||
To create a custom gift card:
|
||
|
||
1. Go to Gift Cards from the sidebar.
|
||
2. Click on the Custom Gift Card button at the top right of the History section.
|
||
3. In the pop-up that opens:
|
||
1. Select in the Region field the region this gift card works in. You can only pick one region. Based on the region you pick, the currency of the gift card will automatically change.
|
||
2. Enter in the Amount field the amount of the gift card.
|
||
3. If the gift card has an expiry date, you can toggle the "Gift Card has an expiry date?" on. This will show an expiry date and time fields that you can use to set the expiry date and time.
|
||
4. Enter in the Email field the email of the customer that will receive this gift card.
|
||
5. You can optionally enter in the Personal Message field any message you want the customer to receive with this gift card.
|
||
4. Once done, click on "Create and send" button.
|
||
|
||
The gift card will be created with a random code. The customer will then receive an email with details about their gift card.
|
||
|
||
:::note
|
||
|
||
If the customer doesn’t receive an email, please get in touch with your technical team to ensure an email service is set up correctly.
|
||
|
||
:::
|
||
|
||
---
|
||
|
||
## View a Custom Gift Card’s Details
|
||
|
||
To view a custom gift card’s details:
|
||
|
||
1. Go to Gift Cards from the sidebar.
|
||
2. In the History section, find the custom gift card and click on it.
|
||
|
||
This opens the gift card’s details page.
|
||
|
||
---
|
||
|
||
## Edit a Custom Gift Card
|
||
|
||
### Edit Region and Expiry Date
|
||
|
||
:::info
|
||
|
||
Changing the region of a custom gift card will change the currency of the gift card to the new region’s currency.
|
||
|
||
:::
|
||
|
||
To change the region of a custom gift card:
|
||
|
||
1. Go to the custom gift card’s details page.
|
||
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the top right of the first section.
|
||
3. Click on "Edit details" from the dropdown.
|
||
4. In the pop-up that opens:
|
||
1. Select in the Region field the region you want this gift card to work in.
|
||
2. You can optionally edit its expiry date by toggling the "Gift Card has an expiry date?" field on and specify the expiry date and time.
|
||
5. Once done, click on the "Save and close" button.
|
||
|
||
### Update Balance of Custom Gift Card
|
||
|
||
To update the balance of a custom gift card:
|
||
|
||
1. Go to the custom gift card’s details page.
|
||
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon at the top right of the first section.
|
||
3. Click on “Update balance” from the dropdown.
|
||
4. In the pop-up that opens, enter in the Amount field the new balance.
|
||
5. Once done, click on the "Save and close" button.
|
||
|
||
### Change Custom Gift Card Status
|
||
|
||
You can disable or activate a custom gift card.
|
||
|
||
:::note
|
||
|
||
If you disable a gift card, customers can’t use it during checkout.
|
||
|
||
:::
|
||
|
||
To change a custom gift card’s status:
|
||
|
||
1. Go to the custom gift card’s details page.
|
||
2. In the first section, you'll find the status of the custom gift card with a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" alt="green" /> icon if it’s active or a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" alt="grey" /> icon if it’s disabled.
|
||
3. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the gift card is Active, the dropdown will show a Disable status.
|
||
4. Choose the status in the dropdown, and the status of the gift card will change.
|