chore: reorganize docs apps (#7228)
* reorganize docs apps * add README * fix directory * add condition for old docs
This commit is contained in:
1 parent
224ebb2154
commit
4fe28f5a95
6187 files changed
+601447
-598226
No files matched your search
@@ -0,0 +1,83 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Import Prices`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to import prices into your Medusa store.
|
||||
|
||||
## Overview
|
||||
|
||||
To import prices, you must have the prices in a CSV file. You can see a template of the CSV file during the import process.
|
||||
|
||||
<Note>
|
||||
|
||||
For a list of accepted columns, refer to [this guide](../../modules/price-lists/admin/_import-prices.mdx#csv-file).
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
When you import prices into a price list, it removes existing prices and adds new prices.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## Import Prices into a Price List
|
||||
|
||||
To import prices into a price list:
|
||||
|
||||
1. Go to the price list’s details page.
|
||||
2. In the Prices section, click on the <InlineThemeImage light="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" dark="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" alt="three dots" /> icon.
|
||||
3. Click on “Import price list” from the dropdown.
|
||||
4. In the new window:
|
||||
1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the <InlineThemeImage light="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999458/Medusa%20Docs/UI%20Icons/fhRqHS3_kwmafj.png" dark="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999458/Medusa%20Docs/UI%20Icons/fhRqHS3_kwmafj.png" alt="download" /> icon.
|
||||
2. To upload the CSV file you want to import prices from, either:
|
||||
1. Drag and drop the file into the dashed box;
|
||||
2. Or click on the dashed box and choose the file you want to import the prices from.
|
||||
3. After you upload the CSV file:
|
||||
1. You can check the number of prices to be added above the uploaded file’s name.
|
||||
2. You can remove the file you choose by clicking the <InlineThemeImage light="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" dark="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" alt="trash" /> icon.
|
||||
5. Once you’re done choosing a file to import prices from, click on the Import List button.
|
||||
|
||||
This starts the import process. Based on the number of prices you’re importing, it can take some time.
|
||||
|
||||
<Note>
|
||||
|
||||
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
|
||||
|
||||
</Note>
|
||||
|
||||
### Check Import Status
|
||||
|
||||
To check the status of the import:
|
||||
|
||||
1. Click on the <InlineThemeImage light="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" dark="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" alt="bell" /> icon at the top right of the page.
|
||||
2. Find the price import, which should be the latest item on the list.
|
||||
|
||||
If a loading indicator is showing, then the import process is still in progress.
|
||||
|
||||
If the import is done, you should see the text “Import of prices is done.”
|
||||
|
||||
Once the import is done, you should find the news prices on the price list’s details page.
|
||||
|
||||
---
|
||||
|
||||
## Cancel Import
|
||||
|
||||
<Note>
|
||||
|
||||
You can only cancel an unfinished prices import.
|
||||
|
||||
</Note>
|
||||
|
||||
To cancel a price import:
|
||||
|
||||
1. Click on the <InlineThemeImage light="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" dark="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" alt="bell" /> icon at the top right of the page.
|
||||
2. Find the import you want to cancel.
|
||||
3. Click on the cancel button.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Create a Price List`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to create a price list.
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
To create a price list:
|
||||
|
||||
1. Go to the Pricing page.
|
||||
2. Click on the Create button.
|
||||
3. A form opens to create a price list. The form is split into three steps:
|
||||
1. In the first step:
|
||||
1. Under the Type section, choose the price list's type. It can be either Sale or Override.
|
||||
2. Enter the title and description of the price list in their respective fields.
|
||||
3. If the prices in the price list include taxes, enable the "Tax inclusive prices" field.
|
||||
4. If the price list has a start or end date, set those in their respective fields.
|
||||
5. To limit which customer groups can use the price list, enable the "Customer availability" field and check the checkbox next to the customer groups allowed to use the price list.
|
||||
6. Once you're done, click the Continue button.
|
||||
2. In the second step, choose the products that the price list applies to. Once you're done, click the Continue button.
|
||||
3. In the third step, enter the price of each product variant. The price editor uses the [bulk editor](../../tips/bulk-editor/page.mdx).
|
||||
- To add a currency, click on the "Add currency" button and select the currency.
|
||||
4. Once you're done, click the Save button.
|
||||
@@ -0,0 +1,121 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Price Lists`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage price lists and their related information.
|
||||
|
||||
## View Price List Details
|
||||
|
||||
To view a price list’s details:
|
||||
|
||||
1. Go to the Pricing page.
|
||||
2. Click on the price list you want to view.
|
||||
|
||||
---
|
||||
|
||||
## Change Price List Status
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
<Note>
|
||||
|
||||
Publishing a price list makes it and its prices available to customers. Unpublishing a price list makes it and its prices unavailable to customers.
|
||||
|
||||
</Note>
|
||||
|
||||
To change a price list’s status:
|
||||
|
||||
1. Go to the Pricing page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon next to the price list.
|
||||
3. If the price list is a draft, click on "Mark as active" in the dropdown to publish it. Otherwise, if the price list is active or published, click on the "Mark as draft" in the dropdown to unpublish it.
|
||||
|
||||
---
|
||||
|
||||
## Edit Price List’s Details
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
To edit a price list’s details:
|
||||
|
||||
1. Go to the price list’s details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the drawer that opens, edit the price list's details.
|
||||
5. Once you’re done , click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Manage Prices
|
||||
|
||||
### Add Products
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
To add new products to the price list:
|
||||
|
||||
1. Go to the price list’s details page.
|
||||
2. Under the Prices section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
3. Choose “Add products" in the dropdown.
|
||||
4. This opens a form with two steps:
|
||||
1. In the first step, choose the products to add to the price list. Once you're done, click the Continue button.
|
||||
2. In the second step, enter the prices of each product variant. The prices editor is based on the [bulk editor](../../tips/bulk-editor/page.mdx).
|
||||
- To add a currency, click on the "Add currency" button and select the currency.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
### Edit a Product’s Prices
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
To edit the prices of a product in the price list:
|
||||
|
||||
1. Go to the price list’s details page.
|
||||
2. In the Prices section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
3. Choose “Edit prices" from the dropdown.
|
||||
4. This opens the prices editor, which is based on the [bulk editor](../../tips/bulk-editor/page.mdx).
|
||||
- To add a currency, click on the "Add currency" button and select the currency.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
### Remove a Product From Price List
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Removing a product from a price list is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To remove a product from a price list:
|
||||
|
||||
1. Go to the price list’s details page.
|
||||
2. Find the product you want to delete in the Prices section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon to its right.
|
||||
4. Choose Remove from the dropdown.
|
||||
5. Confirm deleting the product's prices by clicking the “Confirm” button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Delete Price List
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a price list is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a price list:
|
||||
|
||||
1. Go to the Pricing page.
|
||||
2. Find the price list to delete and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon to its right.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the price list by entering the price list's name, then clicking the Confirm button.
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
sidebar_autogenerate_exclude: true
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Pricing`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you learn about what price lists are and get an overview of the Pricing page.
|
||||
|
||||
## Overview
|
||||
|
||||
Price lists are used to create a sale or override the pricing of one or more products based on specific conditions.
|
||||
|
||||
Adding a price list on a set of products changes the prices of these products to the amount you set. You can set the start and end dates of these prices.
|
||||
|
||||
You can also specify customer groups to which these prices will be applied. For example, you may apply reduced pricing for VIP customers.
|
||||
|
||||
---
|
||||
|
||||
## View List of Price Lists
|
||||
|
||||
The Pricing page includes a list of price lists.
|
||||
|
||||
In the list, you can see price list details such as the title, description, and status of the price list.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Price Lists
|
||||
|
||||
- [Manage a Price List](./manage/page.mdx)
|
||||
Reference in new issue
Block a user