Skip to content

Commit

Permalink
docs: added user guide for import prices (#2268)
Browse files Browse the repository at this point in the history
  • Loading branch information
shahednasser authored Oct 11, 2022
1 parent 7c30c24 commit 8ec89d0
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 2 deletions.
75 changes: 75 additions & 0 deletions docs/content/user-guide/price-lists/import.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
sidebar_position: 3
---

import UiIcon from '@site/src/components/UiIcon';

# Import Prices

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.

:::caution

When you import prices into a price list, it removes existing prices and adds new prices.

:::

---

## 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 <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.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 <UiIcon lightIcon="https://i.imgur.com/fhRqHS3.png" darkIcon="https://i.imgur.com/HdVNMNy.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 <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.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.

:::

### Check Import Status

To check the status of the import:

1. Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.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

:::info

You can only cancel an unfinished prices import.

:::

To cancel a price import:

1. Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.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.
1 change: 1 addition & 0 deletions docs/content/user-guide/price-lists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ In the list, you can see price list details such as the name, description, and s
## Learn More About Price Lists

- [Manage a Price List](./manage.mdx)
- [Import Prices](./import.mdx)
4 changes: 2 additions & 2 deletions docs/content/user-guide/products/import.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To import products:
1. Go to the Products page.
2. Click on Import Products at the top right.
3. 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 <UiIcon lightIcon="https://i.imgur.com/fhRqHS3.png" darkIcon="https://i.imgur.com/HdVNMNy.png" alt="trash" /> icon.
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 <UiIcon lightIcon="https://i.imgur.com/fhRqHS3.png" darkIcon="https://i.imgur.com/HdVNMNy.png" alt="download" /> icon.
2. To upload the CSV file you want to import products 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 products from.
Expand All @@ -32,7 +32,7 @@ To import products:
2. You can remove the file you choose by clicking the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
4. Once you’re done choosing a file to import products from, click on the Import List button.

This starts the import status. Based on the number of products you’re importing, it can take some time.
This starts the import process. Based on the number of products you’re importing, it can take some time.

:::note

Expand Down

0 comments on commit 8ec89d0

Please sign in to comment.