From 907f7f83d8fdc63154a8a8fee11eb902a16efdf5 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 20 Dec 2022 17:51:06 +0200 Subject: [PATCH] docs: added user guide for custom gift cards (#2862) --- docs/content/user-guide/gift-cards/custom.md | 12 --- docs/content/user-guide/gift-cards/custom.mdx | 83 +++++++++++++++++++ docs/content/user-guide/gift-cards/index.md | 10 ++- 3 files changed, 92 insertions(+), 13 deletions(-) delete mode 100644 docs/content/user-guide/gift-cards/custom.md create mode 100644 docs/content/user-guide/gift-cards/custom.mdx diff --git a/docs/content/user-guide/gift-cards/custom.md b/docs/content/user-guide/gift-cards/custom.md deleted file mode 100644 index 3e360297ac..0000000000 --- a/docs/content/user-guide/gift-cards/custom.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_position: 3 -hide_footer: true ---- - -# Manage Custom Gift Cards - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/gift-cards/custom.mdx b/docs/content/user-guide/gift-cards/custom.mdx new file mode 100644 index 0000000000..d3660ded43 --- /dev/null +++ b/docs/content/user-guide/gift-cards/custom.mdx @@ -0,0 +1,83 @@ +--- +sidebar_position: 3 +--- + +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 new form 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. Enter in the Email field the email of the customer that will receive this gift card. + 4. 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 & Send. + +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 + +### Change Region of Custom Gift Card + +:::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 icon at the top right of the first section. +3. Click on Edit from the dropdown. +4. In the new window that opens: + 1. Select in the Region field the region you want this gift card to work in. +5. Once done, click on the Save 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 icon at the top right of the first section. +3. Click on “Update balance” from the dropdown. +4. In the new window that opens: + 1. Enter in the Price field the new balance. +5. Once done, click on the Save button. + +### Change Custom Gift Card Status + +You can disable or activate a custom gift card. 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. Click on the icon at the top right of the first section. +3. Click on Disable or Activate from the dropdown based on the current status. diff --git a/docs/content/user-guide/gift-cards/index.md b/docs/content/user-guide/gift-cards/index.md index 58a047de8f..70f0cf46c0 100644 --- a/docs/content/user-guide/gift-cards/index.md +++ b/docs/content/user-guide/gift-cards/index.md @@ -10,9 +10,17 @@ In this document, you’ll learn about how Gift Cards in Medusa work. 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. +--- + +## Custom Gift Cards + You can also create custom gift cards in Medusa. These cards can be created and sent directly to a customer’s 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 - [Manage Gift Cards](./manage.mdx) -- [Manage Custom Gift Cards](./custom.md) +- [Manage Custom Gift Cards](./custom.mdx)