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

docs: Added "Manage a Gift Card" user guide (#2089)

Browse Source 
* docs: Added "Gift Cards" user guide

* fixed images quality
This commit is contained in:
Shahed Nasser
2022-08-24 15:42:16 +03:00
committed by GitHub
parent d3c6fd7004
commit da77a714fa
7 changed files with 294 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/user-guide/gift-cards/index.mdx
+240
View File
@@ -0,0 +1,240 @@
import UiIcon from '@site/src/components/UiIcon';
# Manage a Gift Card
In this document, you’ll learn about how Gift Cards in Medusa work. This includes how to create, edit, and delete them.
## Overview
In Medusa, there’s 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.
:::info
Medusa also supports custom gift cards, which can be sent to a specific customer.
:::
## Create Gift Card
:::info
You can only create one gift card per store.
:::
Click on Gift Cards in the sidebar menu. If you don’t have any gift cards you should see a prompt to create your first gift card. Click on Create Gift Card.
![Click on Create Gift Card in Gift Cards page](https://i.imgur.com/KjfMARd.png)
In the new window that opens:
- Enter a name for the gift card
- You can optionally enter a description and a thumbnail.
- Click on Add Denomination. You must at least add one denomination
- For each denomination, choose the currency and amount.
- If you want to delete a denomination, you can click the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
- Once you’re done, click Create & Publish.
:::tip
If you want to add more than one currency value for a denomination, you can do that when you [edit a denomination](#edit-a-denomination).
:::
![Example of fields in Create Gift Card window](https://i.imgur.com/xftW9bj.png)
## Edit Gift Card
To edit a Gift Card:
- Go to the Gift Cards page from the sidebar menu.
- Next to the main gift card, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Edit from the dropdown.
![Edit link is the first one in the dropdown](https://i.imgur.com/2PM0tBO.png)
This opens a form to edit the gift card details and denominations.
### Edit Gift Card Information
You can edit the name, subtitle, and description of a Gift card.
You can also click on “Show additional details”. Here, you can change the handle of the gift card, tags, and product type.
After making the edits, click Save at the bottom right of the page.
:::info
The handle is the URL used on the storefront to view the Gift Card.
:::
![Example of Gift Card Information form](https://i.imgur.com/x2PMJum.png)
### Add a Denomination
On the Denominations section, click on Add Denomination at the top right of the section.
![Click on Add Denomination at the top right of the section](https://i.imgur.com/bDlqOCS.png)
In the window that opens:
- Choose the currency of the denomination
- Enter the amount of the denomination
- Optionally, you can enter other values for the denominations. This is useful if you want to enter an amount in another currency. To do that:
- Click on “Add a price” under Other Values.
- Choose the currency and amount.
- To delete a price under Other Values, click on the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
- Once you’re done, click Save.
![Example of Add Denomination form](https://i.imgur.com/5fAosFQ.png)
### Edit a Denomination
To edit a denomination:
- In the Denominations section, find the denomination you want to edit.
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon in the same row as the denomination you want to edit.
- Click on Edit Denomination from the dropdown.
![Edit denomination is the first link in the dropdown](https://i.imgur.com/F4lBLkW.png)
This opens a new window to edit the denomination. You can then:
- Edit the currency or amount of existing prices of the denomination.
- Add prices for other currencies by clicking “Add a price”
- Delete prices by clicking the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
Once you’re done, click Save.
![Example of Edit Denomination form](https://i.imgur.com/qPNXCI6.png)
### Delete a Denomination
:::warning
If you delete a denomination, customers won’t be able to find it in the storefront, purchase it, or use it.
:::
To delete a denomination:
- In the Denominations section, find the denomination you want to edit.
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon in the same row as the denomination you want to delete.
- Click on Delete Denomination from the dropdown.
- Confirm deleting the denomination by clicking the “Yes, delete” button in the pop-up.
![Delete denomination link is the second link in the dropdown](https://i.imgur.com/OrgV3wb.png)
### Add Images
:::info
You can add up to 10 images for a Gift Card.
:::
To add images to the Gift Card:
- Go to the Images section.
- Either drag and drop your image to the dashed box or click on the box and choose the image you want to add.
- Click Save at the bottom right of the page.
:::note
If you face any errors or difficulties while uploading an image, please contact your technical support team as this could be an issue in the storage integration used.
:::
![The save button is at the bottom right of the page](https://i.imgur.com/lwyxPnz.png)
### Change Thumbnail Image
:::note
You must have more than one image for a gift card to change the thumbnail image.
:::
To change the thumbnail image:
- Go to the Images section.
- Check the radio button under the Thumbnail column for the image you want to make the thumbnail.
- Click Save at the bottom right of the page.
![Check the radio button and click save at the bottom right](https://i.imgur.com/2Cz6s21.png)
### Delete Gift Card Image
:::warning
If you delete an image, you won’t be able to restore it.
:::
To delete a gift card image:
- Go to the Images section.
- Click on the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon at the right of the image you want to delete.
- Click Save at the bottom right of the page.
## Unpublish Gift Card
:::caution
Unpublishing a gift card prevents customers from seeing the gift card in the storefront, purchasing it, or using it.
:::
### On Gift Cards Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the main gift card.
- Choose Unpublish.
![Unpublish link is the second link in the dropdown](https://i.imgur.com/jF1vwyO.png)
### On Edit Gift Card Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the Product Information section.
- Choose Unpublish Gift Card from the dropdown.
![Unpublish Gift Card link is the first link in the dropdown](https://i.imgur.com/L09A4Pr.png)
## Publish Gift Card
:::note
Publishing a gift card allows customers to see the gift card on the storefront, purchase it, and use it.
:::
### On Gift Cards Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the main gift card.
- Choose Publish.
![Publish link is the second link in the dropdown](https://i.imgur.com/PfaDRqr.png)
### On Edit Gift Card Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the Product Information section.
- Choose Publish Gift Card from the dropdown.
![Publish Gift Card link is the first link in the dropdown](https://i.imgur.com/9AwA8wH.png)
## Delete Gift Card
:::warning
If you delete a gift card, you can’t restore it or its settings. Customers also can’t use the gift card if they had previously purchased it.
:::
To delete a gift card:
- Go to the Gift Cards page from the sidebar menu.
- Next to the main gift card, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Delete from the dropdown.
- Confirm deleting the gift card by clicking the “Yes, delete” button in the pop-up.
![Delete link is the third link in the dropdown](https://i.imgur.com/Ue1zeUm.png)