docs: update stale information (#4790)
This commit is contained in:
@@ -17,12 +17,9 @@ To create a customer group:
|
||||
1. Go to the Customers page.
|
||||
2. Choose the Groups headline.
|
||||
3. Click on the New Group button.
|
||||
4. In the new window that opens:
|
||||
4. In the pop-up that opens:
|
||||
1. Enter a title for the group.
|
||||
2. Optionally, to add metadata:
|
||||
1. Click on the Add Metadata button.
|
||||
2. Enter a value for the Key and Value Fields.
|
||||
3. To remove a metadata field, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||||
2. Under Metadata, you can optionally attach custom data to the customer group as key-value pairs. This is mostly useful for technical teams and develoeprs.
|
||||
5. Once you’re done, click on the Publish Group button.
|
||||
|
||||
---
|
||||
@@ -42,14 +39,11 @@ To view the details of a customer group:
|
||||
To edit a customer group:
|
||||
|
||||
1. Go to the customer group’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 right of the group’s name.
|
||||
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 in the dropdown.
|
||||
4. In the new window that opens:
|
||||
4. In the pop-up that opens:
|
||||
1. You can change the title and existing metadata of the group.
|
||||
2. To add metadata:
|
||||
1. Click on the Add Metadata button.
|
||||
2. Enter a value for the Key and Value Fields.
|
||||
3. To remove metadata click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||||
2. Under Metadata, you can optionally attach custom data to the customer group as key-value pairs. This is mostly useful for technical teams and develoeprs.
|
||||
5. Once you’re done, click on the Edit Group button.
|
||||
|
||||
---
|
||||
@@ -114,6 +108,6 @@ Deleting a customer group cannot be undone.
|
||||
To delete a customer group:
|
||||
|
||||
1. Go to the customer group’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 right of the group’s name.
|
||||
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 Delete from the dropdown.
|
||||
4. Confirm deleting the price list by clicking the “Yes, delete” button in the pop-up.
|
||||
4. Confirm deleting the customer group by clicking the “Yes, delete” button in the pop-up.
|
||||
@@ -26,8 +26,8 @@ To edit a customer’s details:
|
||||
1. Go to a Customer’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 in the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the new window that opens, you can edit the customer’s details.
|
||||
5. Once you’re done, click on the Save button.
|
||||
4. In the pop-up that opens, you can edit the customer’s details.
|
||||
5. Once you’re done, click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -88,6 +88,10 @@ To delete a condition you already added to the discount:
|
||||
1. 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 next to the condition.
|
||||
2. Click on “Delete condition” from the dropdown.
|
||||
|
||||
### Metadata
|
||||
|
||||
Under the Metadata section, you can attach custom data to the discount as key-value pairs. This is mostly useful for developers and technical teams.
|
||||
|
||||
### Save Discount
|
||||
|
||||
After filling out previous sections, you can save the discount by either clicking the “Save as draft” or “Publish discount” buttons.
|
||||
|
||||
@@ -19,6 +19,8 @@ To view a discount’s details:
|
||||
|
||||
This opens the discount’s details page.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Discount
|
||||
|
||||
### Change Discount Status
|
||||
@@ -42,8 +44,8 @@ To edit a discount’s general information:
|
||||
1. Go to the discount 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 general information” from the dropdown.
|
||||
4. In the new window, you can edit any of the discount information.
|
||||
5. Once done, click on the Save button.
|
||||
4. In the pop-up, you can edit any of the discount information.
|
||||
5. Once done, click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
@@ -56,7 +58,7 @@ To edit a discount’s configuration:
|
||||
1. Go to the discount 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 Configurations section.
|
||||
3. Click on “Edit configurations” from the dropdown.
|
||||
4. In the new window, you can edit any of the configurations.
|
||||
4. In the pop-up, you can edit any of the configurations.
|
||||
5. Once done, click on the Save button.
|
||||
|
||||
### Delete Configurations
|
||||
@@ -77,7 +79,7 @@ To delete a configuration:
|
||||
|
||||
:::info
|
||||
|
||||
You can use a condition type for only one condition. After using a condition type, you will not be able to use it again for another condition. You must edit the condition that you added before of that type if you need to make any changes.
|
||||
You can use a condition type for only one condition. After using a condition type, you will not be able to use it again for another condition. You must [edit the condition](#edit-a-condition) that you added before of that type if you need to make any changes.
|
||||
|
||||
:::
|
||||
|
||||
@@ -86,7 +88,7 @@ To add a condition to a discount:
|
||||
1. Go to the discount details page.
|
||||
2. In the Conditions section, 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.
|
||||
3. Click on “Add condition” from the dropdown.
|
||||
4. Click on the condition type.
|
||||
4. In the pop-up, find the condition type from the list of conditions and click on it.
|
||||
5. In the new list that opens:
|
||||
1. Choose at the top either “In” or “Not In,” where “In” indicates that the discount can be applied to the items selected in this list, and “Not In” indicates that the discount can be applied to all items except those selected in this list.
|
||||
2. Select the items from the list.
|
||||
@@ -99,7 +101,7 @@ To edit a discount’s condition:
|
||||
1. Go to the discount details page.
|
||||
2. In the Conditions section, 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 next to the condition you want to edit.
|
||||
3. Click on “Edit condition” from the dropdown.
|
||||
4. In the new window that opens:
|
||||
4. In the pop-up that opens:
|
||||
1. To add new items to the list:
|
||||
1. Click on the Add button at the top right.
|
||||
2. Choose the items you want to add.
|
||||
|
||||
@@ -16,12 +16,13 @@ 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:
|
||||
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. 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.
|
||||
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.
|
||||
|
||||
@@ -46,7 +47,7 @@ This opens the gift card’s details page.
|
||||
|
||||
## Edit a Custom Gift Card
|
||||
|
||||
### Change Region of Custom Gift Card
|
||||
### Edit Region and Expiry Date
|
||||
|
||||
:::info
|
||||
|
||||
@@ -58,10 +59,11 @@ 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 from the dropdown.
|
||||
4. In the new window that opens:
|
||||
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.
|
||||
5. Once done, click on the Save button.
|
||||
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
|
||||
|
||||
@@ -70,16 +72,22 @@ 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 new window that opens:
|
||||
1. Enter in the Price field the new balance.
|
||||
5. Once done, click on the Save button.
|
||||
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. If you disable a gift card, customers can’t use it during checkout.
|
||||
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. 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 Disable or Activate from the dropdown based on the current status.
|
||||
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.
|
||||
|
||||
@@ -23,13 +23,13 @@ Click on Gift Cards in the sidebar menu. If you don’t have any gift cards you
|
||||
To create a Gift Card:
|
||||
|
||||
1. Click on Create Gift Card.
|
||||
2. In the new window that opens:
|
||||
2. In the new pop-up 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://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||||
3. Once you’re done, click Create & Publish.
|
||||
3. Once you’re done, click the "Create & Publish" button.
|
||||
|
||||
:::tip
|
||||
|
||||
@@ -47,15 +47,16 @@ To edit a Gift Card:
|
||||
2. Next to the main gift card, 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.
|
||||
3. Choose Edit from the dropdown.
|
||||
|
||||
This opens a form to edit the gift card details and denominations.
|
||||
This opens a page with the Gift Card's details.
|
||||
|
||||
### Edit Gift Card Information
|
||||
|
||||
You can edit the name, subtitle, and description of a Gift card.
|
||||
To edit the gift card's information:
|
||||
|
||||
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.
|
||||
1. 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.
|
||||
2. Click on "Edit General Information" from the dropdown.
|
||||
3. In the pop-up that opens, you can edit the gift card's general information such as name or handle. You can also organize the gift card into a product type or product collection, or add product tags. In addition, you can specify if the gift card is Discountable.
|
||||
4. Once you're done, click on the Save button.
|
||||
|
||||
:::info
|
||||
|
||||
@@ -65,30 +66,26 @@ The handle is the URL used on the storefront to view the Gift Card.
|
||||
|
||||
### Add a Denomination
|
||||
|
||||
On the Denominations section, click on Add Denomination at the top right of the section.
|
||||
To add a denomination:
|
||||
|
||||
In the window that opens:
|
||||
|
||||
1. Choose the currency of the denomination
|
||||
2. Enter the amount of the denomination
|
||||
3. 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://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||||
4. Once you’re done, click Save.
|
||||
1. In the Denominations section, 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.
|
||||
2. Click on "Add Denomination" from the dropdown.
|
||||
3. In the pop-up that opens:
|
||||
- Under default currency, enter the denomination's amount for the default store's currency.
|
||||
- The "Use value for all currencies?" field allows you to specify whether the amount entered for the default currency should be applied to all currencies. Toggling this one on will hide the "Other currencies" section.
|
||||
- Under the "Other currencies" section, which is only available if "Use value for all currencies?" is disabled, you can enter the amount for each currency in your store.
|
||||
- Under the Metadata section, you can attach custom data to the denomination in key-value pairs. This is mainly useful for technical teams and developers.
|
||||
4. Once you’re done, click the "Save and close" button.
|
||||
|
||||
### Edit a Denomination
|
||||
|
||||
To edit a denomination:
|
||||
|
||||
1. In the Denominations section, find the denomination you want to edit.
|
||||
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 in the same row as the denomination you want to edit.
|
||||
3. Click on Edit Denomination from the dropdown.
|
||||
4. 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://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||||
5. Once you’re done, click Save.
|
||||
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 right side of the denomination's row.
|
||||
3. Click on Edit from the dropdown.
|
||||
4. This opens a pop-up to edit the denomination. This form is similar to the [Add Denomination](#add-a-denomination) form. You can edit the amount for the default currency. You can also specify or edit the amount for other currencies if the "Use value for all currencies?" field is disabled, and you can add Metadata fields.
|
||||
5. Once you’re done, click on the "Save and close" button.
|
||||
|
||||
### Delete a Denomination
|
||||
|
||||
@@ -100,10 +97,33 @@ If you delete a denomination, customers won’t be able to find it in the storef
|
||||
|
||||
To delete a denomination:
|
||||
|
||||
1. In the Denominations section, find the denomination you want to edit.
|
||||
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 in the same row as the denomination you want to delete.
|
||||
3. Click on Delete Denomination from the dropdown.
|
||||
4. Confirm deleting the denomination by clicking the “Yes, delete” button in the pop-up.
|
||||
1. In the Denominations section, find the denomination you want to delete.
|
||||
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 right side of the denomination's row.
|
||||
3. Click on Delete from the dropdown.
|
||||
4. Confirm deleting the denomination by clicking the “Yes, confirm button in the pop-up.
|
||||
|
||||
### Change Thumbnail Image
|
||||
|
||||
To change the thumbnail image:
|
||||
|
||||
1. Go to the Thumbnail section.
|
||||
2. If you have an existing thumbnail image, you can click the Edit button to change it. Otherwise, you can click the Upload button to add a thumbnail image.
|
||||
3. In the pop-up that opens, either click on the dotted box to upload an image or drag your image from your computer.
|
||||
4. Once you're done, click the "Save and close" button.
|
||||
|
||||
:::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.
|
||||
|
||||
:::
|
||||
|
||||
### Delete Thumbnail Image
|
||||
|
||||
To delete the thumbnail image:
|
||||
|
||||
1. Go to the Thumbnail section.
|
||||
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||||
3. Click on the button again to confirm the deletion.
|
||||
|
||||
### Add Images
|
||||
|
||||
@@ -115,9 +135,10 @@ You can add up to ten images for a Gift Card.
|
||||
|
||||
To add images to the Gift Card:
|
||||
|
||||
1. Go to the Images section.
|
||||
2. Either drag and drop your image to the dashed box or click on the box and choose the image you want to add.
|
||||
3. Click Save at the bottom right of the page.
|
||||
1. Go to the Media section.
|
||||
2. Click on the Edit Media button.
|
||||
3. In the pop-up that opens, either click on the dotted box to upload an image or drag your image from your computer.
|
||||
3. Once you're done, click the "Save and close" button.
|
||||
|
||||
:::note
|
||||
|
||||
@@ -125,20 +146,6 @@ If you face any errors or difficulties while uploading an image, please contact
|
||||
|
||||
:::
|
||||
|
||||
### Change Thumbnail Image
|
||||
|
||||
:::info
|
||||
|
||||
You must have more than one image for a gift card to change the thumbnail image.
|
||||
|
||||
:::
|
||||
|
||||
To change the thumbnail image:
|
||||
|
||||
1. Go to the Images section.
|
||||
2. Check the radio button under the Thumbnail column for the image you want to make the thumbnail.
|
||||
3. Click Save at the bottom right of the page.
|
||||
|
||||
### Delete Gift Card Image
|
||||
|
||||
:::caution
|
||||
@@ -150,8 +157,11 @@ If you delete an image, you won’t be able to restore it.
|
||||
To delete a gift card image:
|
||||
|
||||
1. Go to the Images section.
|
||||
2. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon at the right of the image you want to delete.
|
||||
3. Click Save at the bottom right of the page.
|
||||
2. Click on the Edit Media button.
|
||||
3. In the pop-up, find the image you want to delete from the existing images.
|
||||
4. 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 right side of the image.
|
||||
5. Choose Delete from the dropdown.
|
||||
3. Once you're done, click the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
@@ -166,12 +176,13 @@ Unpublishing a gift card prevents customers from seeing the gift card in the sto
|
||||
### On Gift Cards Page
|
||||
|
||||
1. 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 main gift card.
|
||||
2. Choose Unpublish.
|
||||
2. Choose Unpublish from the dropdown.
|
||||
|
||||
### On Edit Gift Card Page
|
||||
|
||||
1. 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 Product Information section.
|
||||
2. Choose Unpublish Gift Card from the dropdown.
|
||||
1. In the first section, you'll find the status of the 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 published 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 a draft.
|
||||
2. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the gift card is Published, the dropdown will show a Draft status.
|
||||
3. Choose the status in the dropdown, and the status of the gift card will change.
|
||||
|
||||
---
|
||||
|
||||
@@ -190,8 +201,9 @@ Publishing a gift card allows customers to see the gift card on the storefront,
|
||||
|
||||
### On Edit Gift Card Page
|
||||
|
||||
1. 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 Product Information section.
|
||||
2. Choose Publish Gift Card from the dropdown.
|
||||
1. In the first section, you'll find the status of the 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 published 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 a draft.
|
||||
2. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the gift card is Published, the dropdown will show a Draft status.
|
||||
3. Choose the status in the dropdown, and the status of the gift card will change.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -42,8 +42,8 @@ To create a draft order:
|
||||
1. If you want to change the default price of the shipping method, click on the “Set custom price” button and enter the price you want to use.
|
||||
2. If you want to remove the custom price, you can click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||||
4. In the fourth step, enter the customer’s details and shipping address.
|
||||
1. If the customer already exists, you can choose it from the first input. You can search the list of customers by name or email. This fills out the fields under the General section as well.
|
||||
2. If this is a new customer, in the first field, enter the email of the customer to add. Then, fill out the customer’s first name, last name, and phone number in the General section.
|
||||
1. If the customer already exists, you can choose it from the "Find existing customer" input. You can search the list of customers by name or email. This fills out the fields under the General section as well.
|
||||
2. If this is a new customer, in the "Email" field, enter the email of the customer to add. Then, fill out the customer’s first name, last name, and phone number in the General section.
|
||||
3. In the Shipping Address section, enter the customer’s address details such as the Address line, postal code, and more.
|
||||
4. Once you’re done, click on the Next button.
|
||||
5. In the fifth step, specify the billing address details.
|
||||
@@ -76,7 +76,7 @@ To edit the shipping address of a draft order:
|
||||
2. Scroll down to the customer section and 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 in that section.
|
||||
3. Click on Edit Shipping Address in the dropdown.
|
||||
4. This opens a new window to edit the shipping address’s info.
|
||||
5. Once you’re done click on the Save button.
|
||||
5. Once you’re done click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
@@ -91,7 +91,7 @@ Canceling a draft order cannot be undone and the draft order will be removed fro
|
||||
To cancel a draft order:
|
||||
|
||||
1. Open the draft order 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.
|
||||
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 Cancel Draft Order in the dropdown.
|
||||
4. Confirm canceling the draft order by clicking the “Yes, remove” button in the pop-up.
|
||||
|
||||
@@ -110,6 +110,7 @@ To mark a draft order as paid:
|
||||
1. Open the draft order details page.
|
||||
2. Scroll down to the Payment section.
|
||||
3. Click on the “Mark as paid” button.
|
||||
4. Confirm your action by clicking the “Mark paid” button in the pop-up.
|
||||
|
||||
You should see a new order in the Orders list now.
|
||||
|
||||
@@ -126,4 +127,4 @@ This is only available after a draft order is marked as paid.
|
||||
To go to the order associated with the draft order.
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. Click on the “Go to Order” button at the top right.
|
||||
2. Click on the “Go to Order” button at the top right of the first section.
|
||||
@@ -47,8 +47,8 @@ To refund an order’s payment:
|
||||
3. Click on the Refund button.
|
||||
4. In the new window that opens:
|
||||
- Enter the Refund amount. It must be less than the Total Paid amount specified in the Payment section.
|
||||
- Choose a reason for the refund.
|
||||
- Optionally provide a note for the customer to see.
|
||||
- In the Reason field, choose a reason for the refund.
|
||||
- For the Note field, you can optionally provide a note for the customer to see.
|
||||
- If you don’t want the customer to receive an email that the refund has been made, uncheck the “Send notifications” checkbox.
|
||||
5. Once you’re done, click on the Complete button.
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ In this section, you must choose at least one product and specify the prices you
|
||||
6. Click on the “Save and close” button.
|
||||
4. To remove a variant from the price list:
|
||||
1. 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 next to the variant.
|
||||
2. Click on the Remove from List button.
|
||||
2. Click on "Remove from List" from the dropdown.
|
||||
2. To remove products from the prices list:
|
||||
1. Click on the “Add Products Manually” button.
|
||||
2. Uncheck the products you previously added and want to remove.
|
||||
|
||||
@@ -34,7 +34,7 @@ To create a region:
|
||||
|
||||
:::tip
|
||||
|
||||
If you can’t find the currency you want to use in the Currency field, make sure to add the Currency to the store’s currencies in the settings.
|
||||
If you can’t find the currency you want to use in the Currency field, make sure to [add the Currency to the store’s currencies in the settings](../settings/currencies.md#add-a-currency).
|
||||
|
||||
:::
|
||||
|
||||
@@ -48,9 +48,10 @@ To edit a region's basic information:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to edit from the Regions section. This shows sections to the right to edit different information and data related to the region.
|
||||
4. 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 region.
|
||||
5. This opens a new window where you can edit the region's details.
|
||||
6. Once done, click on the "Save and close" button.
|
||||
4. 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.
|
||||
5. Click on "Edit Region Details" from the dropdown.
|
||||
6. This opens a new window where you can edit the region's details.
|
||||
7. Once done, click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
@@ -65,7 +66,7 @@ If you delete a region, you will not be able to restore it or its data. Data rel
|
||||
To delete a region:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Click on the region you want to duplicate from the Regions section.
|
||||
2. Click on the region you want to delete from the Regions section.
|
||||
3. In the first section on the right, 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.
|
||||
4. Choose Delete Region from the dropdown list.
|
||||
5. Confirm deleting the region by clicking the “Yes, confirm" button in the pop-up.
|
||||
5. Confirm deleting the region by entering the name of the region and clicking the “Yes, confirm" button in the pop-up.
|
||||
@@ -29,7 +29,7 @@ To add or remove a payment provider in a region:
|
||||
4. Click on Edit Region Details from the dropdown.
|
||||
5. Under the providers section, select the payment providers you want to add to the region.
|
||||
6. Unselect the payment providers you want to remove from the region.
|
||||
7. Click Save.
|
||||
7. Click the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
@@ -43,4 +43,4 @@ To add or remove a fulfillment provider in a region:
|
||||
4. Click on Edit Region Details from the dropdown.
|
||||
5. Under the providers section, select the fulfillment providers you want to add to the region.
|
||||
6. Unselect the fulfillment providers you want to remove from the region.
|
||||
7. Click Save.
|
||||
7. Click the "Save and close" button.
|
||||
|
||||
@@ -15,11 +15,13 @@ In this document, you’ll learn how to manage a region’s shipping options in
|
||||
|
||||
There are two types of shipping options in a region:
|
||||
|
||||
1. Shipping Options are used when a customer places an order or when an admin creates a draft order.
|
||||
2. Return Shipping Options are used when a customer requests a return or swap for their order, or when an admin registers an exchange, a claim, or a return for an order.
|
||||
1. Shipping Options that are used when a customer places an order or when an admin creates a draft order.
|
||||
2. Return Shipping Options that are used when a customer requests a return or exchange for their order, or when an admin registers an exchange, a claim, or a return for an order.
|
||||
|
||||
A shipping option can’t be used for both cases. In a region, you can create an unlimited amount of shipping options and return shipping options.
|
||||
|
||||
---
|
||||
|
||||
## Manage Shipping Options in a Region
|
||||
|
||||
### Add Shipping Option to a Region
|
||||
@@ -27,24 +29,26 @@ A shipping option can’t be used for both cases. In a region, you can create an
|
||||
To add a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Shipping Options section on the right side.
|
||||
4. Click on the Add Option button.
|
||||
5. A new window will open with a form with the following fields:
|
||||
- **Visible in Store:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
|
||||
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
|
||||
- **Price (Required):** The price of the shipping option.
|
||||
- **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
|
||||
- **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates the price of the shipping option.
|
||||
- **Shipping Profile (Required):** The shipping profile this option belongs to.
|
||||
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
|
||||
- **Visible is Store:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
|
||||
- **Requirements:** You can use this to specify a condition for when this shipping option should be available. The first field indicates the minimum cart subtotal, and the second field indicates the maximum cart subtotal. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
|
||||
6. Once you’re done, click Save.
|
||||
- **Requirements:** You can use this section to specify a condition for when this shipping option should be available during checkout or draft-order creation. The "Min. subtotal" field indicates the minimum cart subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum cart subtotal required to use this shipping option. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
|
||||
- **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
|
||||
6. Once you’re done, click the "Save and close" button.
|
||||
|
||||
### Edit a Shipping Option
|
||||
|
||||
To edit a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and click on the three dots icon at its right.
|
||||
5. Click on Edit in the dropdown.
|
||||
@@ -62,7 +66,7 @@ If you delete a shipping option, you can’t restore it or its data, customers c
|
||||
To delete a shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and 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 its right.
|
||||
5. Click on Delete in the dropdown.
|
||||
@@ -76,16 +80,19 @@ To delete a shipping option:
|
||||
To add a return shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Return Shipping Options section on the right side.
|
||||
4. Click on the Add Option button.
|
||||
5. A new window will open with a form with the following fields:
|
||||
- **Visible in Store:** Whether or not this option should be available on the website. This is useful if you want to create a return shipping option only for use on the Medusa Admin (for example, to create an order return).
|
||||
- **Title (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
|
||||
- **Price (Required):** The price of the shipping option.
|
||||
- **Price Type (Required):** The type of price. It can be either Flat Rate or Calculated. If you choose Flat Rate, this will show a new field **Price**. If you choose Calculated, it's assumed the calculation of the shipping option is handled using custom logic implemented in the Fulfillment provider.
|
||||
- **Price:** This field is only available and required when you set the **Price Type** to Flat Rate. It indicates the price of the shipping option.
|
||||
- **Shipping Profile (Required):** The shipping profile this option belongs to.
|
||||
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
|
||||
- **Visible is Store:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
|
||||
- **Requirements:** You can use this to specify a condition for when this shipping option should be available. The first field indicates the minimum cart subtotal, and the second field indicates the maximum cart subtotal. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
|
||||
- **Requirements:** You can use this section to specify a condition for when this shipping option should be available when creating a return or exchange. The "Min. subtotal" field indicates the minimum subtotal required to use this shipping option, and the "Max. subtotal" field indicates the maximum subtotal required to use this shipping option. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
|
||||
- **Metadata**: This section allows you to add custom data to the shipping option in the form of a key-value pair. This is mostly helpful for technical teams and developers.
|
||||
6. Once you’re done, click the "Save and close" button.
|
||||
6. Once you’re done, click the Save and close button.
|
||||
|
||||
### Edit a Return Shipping Option
|
||||
@@ -93,7 +100,7 @@ To add a return shipping option:
|
||||
To edit a return shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Return Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and 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 its right.
|
||||
5. Click on Edit in the dropdown.
|
||||
@@ -111,7 +118,7 @@ If you delete a return shipping option, you can’t restore it or its data, cust
|
||||
To delete a return shipping option:
|
||||
|
||||
1. Go to Settings → Regions.
|
||||
2. Select a region to edit.
|
||||
2. Select the shipping option's region.
|
||||
3. Scroll down to the Return Shipping Options section on the right side.
|
||||
4. Find the shipping option you want to edit and 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 its right.
|
||||
5. Click on Delete in the dropdown.
|
||||
|
||||
@@ -87,4 +87,4 @@ To delete a sales channel:
|
||||
2. In the sales channels list on the left, choose the sales channel you want to delete.
|
||||
3. At the top right of the right section, 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.
|
||||
4. Choose from the dropdown list “Delete channel”.
|
||||
5. Confirm deleting the tax rate by clicking the “Yes, delete” button in the pop-up.
|
||||
5. Confirm deleting the sales channel by entering the name of the sales channel and clicking the “Yes, delete” button in the pop-up.
|
||||
|
||||
@@ -18,7 +18,7 @@ Return reasons are custom and are created by merchants. For example, you can cre
|
||||
|
||||
:::note
|
||||
|
||||
Creating at least one return reason is required before you can work with order returns and exchanges.
|
||||
Creating at least one return reason is required before you can handle order returns and exchanges.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ In this document, you’ll learn how to view and manage taxes in your Medusa Adm
|
||||
To view taxes:
|
||||
|
||||
1. Click on Settings in the sidebar.
|
||||
2. Choose Tax Settings from the list of settings.
|
||||
2. Choose Taxes from the list of settings.
|
||||
|
||||
This opens the Taxes page where you can find a list of regions. This is because every time you create a region, a default tax rate is associated with that region.
|
||||
|
||||
@@ -26,7 +26,7 @@ To edit a region’s taxes:
|
||||
1. Go to Settings → Taxes.
|
||||
2. Click on the region you want to edit the taxes for in the Regions section.
|
||||
|
||||
This opens a Details form to the right where you can edit the taxes calculation settings and manage the tax rates.
|
||||
This opens a Details form to the right where you can edit the taxes calculation settings and [manage the tax rates](./tax-rates.mdx).
|
||||
|
||||
---
|
||||
|
||||
@@ -44,9 +44,10 @@ The tax provider that you choose defines how taxes are calculated for products a
|
||||
|
||||
If you have integrated a custom tax provider and want to use it to calculate taxes in a region:
|
||||
|
||||
1. Select a region whose taxes you want to edit.
|
||||
2. Change the selected tax provider in the Tax Provider field.
|
||||
3. Click Save at the bottom right.
|
||||
1. Go to Settings → Taxes.
|
||||
2. Select a region whose taxes you want to edit.
|
||||
3. Change the selected tax provider in the Tax Provider field.
|
||||
4. Click Save at the bottom right.
|
||||
|
||||
### Disable Automatic Taxes Calculation
|
||||
|
||||
@@ -62,16 +63,18 @@ If you switch off automatic taxes calculation, the taxes must be calculated manu
|
||||
|
||||
To disable automatic taxes calculation:
|
||||
|
||||
1. Select a region whose tax you want to edit.
|
||||
2. Check off the “Calculate taxes automatically” input.
|
||||
3. Click Save at the bottom right.
|
||||
1. Go to Settings → Taxes.
|
||||
2. Select a region whose tax you want to edit.
|
||||
3. Check off the “Calculate taxes automatically” input.
|
||||
4. Click Save at the bottom right.
|
||||
|
||||
### Disable Taxes for Gift Cards
|
||||
|
||||
To disable applying taxes for Gift Cards:
|
||||
|
||||
1. Select a region whose tax you want to edit.
|
||||
2. Check off the “Apply tax to gift cards” input.
|
||||
3. Click Save at the bottom right.
|
||||
1. Go to Settings → Taxes.
|
||||
2. Select a region whose tax you want to edit.
|
||||
3. Check off the “Apply tax to gift cards” input.
|
||||
4. Click Save at the bottom right.
|
||||
|
||||
Enabling taxes for Gift Cards follows the same process, except you check the input.
|
||||
|
||||
@@ -30,6 +30,7 @@ To add an override while [adding or editing a tax rate](./tax-rates.mdx#create-t
|
||||
|
||||
1. Go to Settings → Taxes
|
||||
2. Select the region that the tax rate you want to edit belongs to.
|
||||
3. Either [add a tax rate](./tax-rates.mdx#create-tax-rate) or [edit an existing one](./tax-rates.mdx#edit-tax-rate). This will open the tax rate form in a pop-up.
|
||||
3. Under the Overrides section, click Add Overrides
|
||||
4. Choose the type of the override, then choose the specific entries in that type that you want to apply the tax rate to. For example, if you chose the Products type, choose at least one product to apply the override to.
|
||||
5. Once done, click on Add.
|
||||
@@ -37,7 +38,7 @@ To add an override while [adding or editing a tax rate](./tax-rates.mdx#create-t
|
||||
|
||||
:::info
|
||||
|
||||
If you already have an override for one of the types, and you choose to add a new override for that same type, the new override replaces the old one. If you want to add new entries to the same type (for example, add more products to the Products override), you should edit the existing override instead.
|
||||
If you already have an override for one of the types, and you choose to add a new override for that same type, the new override replaces the old one. If you want to add new entries to the same type (for example, add more products to the Products override), you should [edit the existing override](#edit-override) instead.
|
||||
|
||||
:::
|
||||
|
||||
@@ -65,7 +66,7 @@ To edit an override:
|
||||
|
||||
:::caution
|
||||
|
||||
If you delete an override you won’t be able to restore it and it won’t be applied during checkout. If you want to, instead, remove some entries from an override type, you should edit the override instead.
|
||||
If you delete an override you won’t be able to restore it and it won’t be applied during checkout. If you want to, instead, remove some entries from an override type, you should [edit the override](#edit-override) instead.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ To add a tax rate:
|
||||
1. Go to Settings → Taxes
|
||||
2. Select a region that you want to add a new tax rate to.
|
||||
3. Click on New Tax Rate at the top right of the Details section.
|
||||
4. This opens the tax rate form in a new window.
|
||||
4. This opens the tax rate form in a new window. You must enter a name, rate, and tax code of the new tax rate.
|
||||
5. You can optionally [add overrides to the tax rate](./tax-overrides.mdx).
|
||||
6. Once done, click Save.
|
||||
|
||||
|
||||
@@ -12,9 +12,9 @@ In this document, you’ll learn how to manage your account including resetting
|
||||
|
||||
To reset your password:
|
||||
|
||||
1. On the login screen, click on the “Reset password” link.
|
||||
1. On the login screen, click on the “Forget your password?” link.
|
||||
2. Enter the email of your account.
|
||||
3. Click on “Send reset instructions”.
|
||||
3. Click on the “Send reset instructions” button.
|
||||
4. You’ll find the instructions to reset your password in the email you receive.
|
||||
|
||||
:::note
|
||||
|
||||
@@ -20,6 +20,12 @@ You can view your team by going to Settings → The Team.
|
||||
|
||||
To add a new user to your team, you must invite them. Invites are sent by email, but you can also copy the invite link and send it personally to the user.
|
||||
|
||||
:::note
|
||||
|
||||
By default, your store doesn't handle sending invites to the user through a notification, such as an email. Your developer team must setup and configure a Notification service that handles this functionality.
|
||||
|
||||
:::
|
||||
|
||||
### Invite a User
|
||||
|
||||
To send an invite to a user:
|
||||
@@ -29,6 +35,12 @@ To send an invite to a user:
|
||||
3. Enter the user’s email and choose their role.
|
||||
4. Once done, click on the Invite button.
|
||||
|
||||
:::tip
|
||||
|
||||
A user's role doesn't actually change the user's privileges. All users have the same admin privileges.
|
||||
|
||||
:::
|
||||
|
||||
### Resend an Invite
|
||||
|
||||
If you want the user to receive a new email with the invite link, you can resend an invite to them.
|
||||
|
||||
Reference in New Issue
Block a user