ContextQMD
Back to Medusa

{metadata.title}

www/apps/user-guide/app/price-lists/manage/page.mdx

2.15.26.9 KB
Original Source

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

export const metadata = { title: Manage Price Lists in Medusa Admin, }

{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 Status

In the first section's header, 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 section.

</Note>
  1. Go to the price list's details page.
  2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
  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 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 in the "Configuration" section's header.
  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.

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 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.

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 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.

Manage Price List Metadata

<Note>

The Metadata section is available since Medusa v2.15.0. If you don't see the Metadata section in your Medusa Admin, request your technical team to upgrade your Medusa application.

</Note>

Metadata is custom data that can be associated with the price list in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the price list.

To edit the price list's metadata:

  1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon in the "Metadata" section.
  2. In the side window that opens:
    • Manage the key-value pairs in the table.
    • To add a new row of key-value pairs before or after a row:
      • Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
      • Choose "Insert row above" or "Insert row below" from the dropdown.
    • To delete a row of key-value pairs:
      • Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its end.
      • Choose "Delete row" from the dropdown.
  3. Once you're done, click the Save button.

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 in the first section's header.
  3. Choose Delete from the dropdown.
  4. In the pop-up, enter the price list's title and click the "Delete" button.