Skip to content

Commit

Permalink
docs: update price lists user guides
Browse files Browse the repository at this point in the history
  • Loading branch information
shahednasser committed Feb 19, 2025
1 parent 2940b0f commit 58d8db4
Show file tree
Hide file tree
Showing 16 changed files with 333 additions and 293 deletions.
24 changes: 24 additions & 0 deletions www/apps/user-guide/app/customers/manage/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 1
---

import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
import { Table } from "docs-ui"

export const metadata = {
title: `Manage Customers`,
Expand Down Expand Up @@ -36,6 +37,29 @@ To view a customer’s details:

![Customers Detail Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739886949/User%20Guide/Screenshot_2025-02-18_at_3.55.21_PM_omxw5x.png)

### Customer Type

At the top right of the first section, you can see a badge with the customer's type:

<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Customer Type</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>Registered</Table.Cell>
<Table.Cell>A customer that has registered in your store.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Guest</Table.Cell>
<Table.Cell>A customer that has placed an order but hasn't registered in your store, or a customer that you created through the admin dashboard.</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

---

## Edit Customer Details
Expand Down
2 changes: 1 addition & 1 deletion www/apps/user-guide/app/customers/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const metadata = {

The Customers domain allows you to manage customers and customer groups in your commerce store.

You can manage both customers that have registered in your store and guest customers that have placed an order. You can also segment these customers into groups to offer them specific [promotions](../promotions/page.mdx) and [pricing](../pricing/page.mdx).
You can manage both customers that have registered in your store and guest customers that have placed an order. You can also segment these customers into groups to offer them specific [promotions](../promotions/page.mdx) and [price lists](../price-lists/page.mdx).

You can view the list of customers in your commerce store by clicking on Customers from the sidebar menu.

Expand Down
66 changes: 66 additions & 0 deletions www/apps/user-guide/app/price-lists/create/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
sidebar_position: 1
---

import { EllipsisHorizontal } from "@medusajs/icons"

export const metadata = {
title: `Create a Price List`,
}

# {metadata.title}

In this guide, you’ll learn how to create a price list.

To create a price list:

1. Go to Price Lists from the sidebar.
2. Click the Create button at the top right.

This will open the form to create a price, which is made up of three steps: Details, Products, and Prices.

## Step 1: Details

In th first step of creating a price list, you'll enter the general information of the price list:

1. For the Type section, choose either:
- **Sale**: Useful if you're creating a temporary sale on some products.
- **Override**: Useful if you're overriding prices permanently for a segment of customers.
2. In the Title field, enter the price list's title.
3. In the Status field, choose one of the following statuses:
- **Active**: The price list is active and can be used. If you later set a start date, the price list will be active from that date.
- **Draft**: The price list is not active and can't be used.
4. In the Description field, enter a description for your price list.
5. If you want the price list to be active starting from a specific date, choose that date in the "Price list has a start date" field.
6. If you want the price list to automatically expire after a specific date, choose that date in the "Price list has an expiry date" field.
7. In the "Customer availability" section, you can specify the customer groups that this price list applies for. Customers in these groups will see the prices set in this price list. To choose the customer groups:
- Click the Browse button.
- In the list that opens, check the customer groups to apply the price list to.
- Once you're done, click the Save button.
8. Once you're done, click the Continue button to move to the next step.

![Create Price List Details Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739959087/User%20Guide/Screenshot_2025-02-19_at_11.57.54_AM_if1uxe.png)

---

## Step 2: Products

In the second step, you'll choose the products you want to change their prices in the price list.

To do that, check the products you want to include in the price list. You can search, filter, and sort the products to find the specific ones you are looking for.

Once you're done, click the Continue button to go to the next step.

![Create Price List Products Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739959206/User%20Guide/Screenshot_2025-02-19_at_11.59.53_AM_hgmtl4.png)

---

## Step 3: Prices

In the last step, you'll use the [Bulk Editor](../../tips/bulk-editor/page.mdx) to enter the new prices for the variants of each product you selected. You can set the prices for every currency and region in your store.

Once you're done, click the Save button to create the price list.

![Create Price List Pricing Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739959865/User%20Guide/Screenshot_2025-02-19_at_12.10.10_PM_aaxecg.png)

You can now [manage the price list](../manage/page.mdx) you created.
154 changes: 154 additions & 0 deletions www/apps/user-guide/app/price-lists/manage/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
sidebar_position: 2
---

import { EllipsisHorizontal } from "@medusajs/icons"
import { Table } from "docs-ui"

export const metadata = {
title: `Manage Price Lists`,
}

# {metadata.title}

In this guide, 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 Price Lists page from the sidebar.
2. Click on the price list you want to view.

This will open the price list's details page.

![Price List details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739960115/User%20Guide/Screenshot_2025-02-19_at_12.15.02_PM_tdt8zl.png)

### Price List Status

At the top right of the first section, you'll find the price list's status. It can be one of the following:

<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Status</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>Draft</Table.Cell>
<Table.Cell>The price list is not active and can't be used.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Active</Table.Cell>
<Table.Cell>The price list is active and can be used.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Scheduled</Table.Cell>
<Table.Cell>The price list has a start date in the future. Once the start date is reached, the price list becomes active.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Expired</Table.Cell>
<Table.Cell>The price list has an end date that has passed. The price list can't be used.</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

---

## Edit Price List Details

To edit a price list's details:

<Note title="Tip">

To edit a price list's start and expiry dates, or customer availability, refer to the [Edit Price List Configurations](#edit-price-list-configurations) section.

</Note>

1. Go to the price list's details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the price list's type, title, status, and description.
- If you change the price list's status to Active, but the price list has a start date in the future, the price list will have a "Scheduled" status and become active once the start date is reached.
5. Once you're done, click the Save button.

![Edit price list form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739960659/User%20Guide/Screenshot_2025-02-19_at_12.24.08_PM_y333se.png)

---

## Edit Price List Configurations

A price list's configurations include the start and expiry dates, and customer availability.

1. Go to the price list's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Configuration" section.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the start and expiry dates and the customer groups that the price list applies to.
- To change the customer groups, click the Browse button, select the customer groups, and click Save.
5. Once you're done, click the Save button.

![Edit price list configurations form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739960935/User%20Guide/Screenshot_2025-02-19_at_12.28.45_PM_jczlo1.png)

---

## Manage Products in Price List

From the price list's details page, you can manage the products in the price list.

### Add Products to Price List

To add products to a price list:

1. Go to the price list's details page.
2. In the Products section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
3. Choose "Add products" from the dropdown.
4. In the list that opens, check the products you want to add to the price list.
5. Once you’re done, click the Continue button.
6. In the next "Prices" step, use the [Bulk Editor](../../tips/bulk-editor/page.mdx) to set the prices for the variants of the products you added. You can set prices for every currency and region in your store.
7. Once you're done, click the Save button.

### Remove Products from Price List

To remove products from a price list:

1. Go to the price list's details page.
2. In the Products section, check the products you want to remove from the price list.
3. Either press <Kbd>D</Kbd> or click "Delete" at the bottom center of the page.
4. Confirm removing the products by clicking the "Delete" button in the pop-up.

![Remove products from price list](https://res.cloudinary.com/dza7lstvk/image/upload/v1739961185/User%20Guide/Screenshot_2025-02-19_at_12.32.55_PM_sfirfu.png)

---

## Edit Prices in Price List

From the price list's details page, you can manage the price overrides of the products in the price list.

To edit the prices of the products in the price list:

1. Go to the price list's details page.
2. In the Products section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
3. Choose "Edit prices" from the dropdown.
4. This opens the [Bulk Editor](../../tips/bulk-editor/page.mdx) to edit the prices of the products' variants. You can set prices for every currency and region in your store.
5. Once you're done, click the Save button.

![Edit prices in price list](https://res.cloudinary.com/dza7lstvk/image/upload/v1739961309/User%20Guide/Screenshot_2025-02-19_at_12.35.00_PM_kvpnss.png)

---

## Delete Price List

<Note type="warning">

Deleting a price list is irreversible.

</Note>

To delete a price list:

1. Go to the price list's details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
3. Choose Delete from the dropdown.
4. In the pop-up, enter the price list's title and click the "Delete" button.
32 changes: 32 additions & 0 deletions www/apps/user-guide/app/price-lists/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_autogenerate_exclude: true
---

export const metadata = {
title: `Price Lists`,
}

# {metadata.title}

The Price Lists domain allow you to manage custom product pricing for customer groups in your store. These prices can be either for a sale or to override the default prices for specific customer groups.

For example, you can utilize price lists to provide customers in the B2B customer group different pricing, allowing you to support B2B and B2C customers in the same store.

You can view the list of price lists in your commerce store by clicking on Price Lists from the sidebar menu.

In the list, you can see price list details such as title and status. You can also search, filter, and sort the price lists to find the specific one you are looking for.

<Note title="Tip">

Find tips to use lists effectively in [this guide](../tips/lists/page.mdx).

</Note>

![Price Lists list](https://res.cloudinary.com/dza7lstvk/image/upload/v1739958425/User%20Guide/Screenshot_2025-02-19_at_11.46.29_AM_zupks8.png)

---

## Manage Price Lists

- [Create Price List](./create/page.mdx)
- [Manage Price Lists](./manage/page.mdx)
83 changes: 0 additions & 83 deletions www/apps/user-guide/app/pricing/_import/page.mdx

This file was deleted.

Loading

0 comments on commit 58d8db4

Please sign in to comment.