asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update products user guide (#11506)

Browse Source 
* docs: update products user guide

* fix broken link
This commit is contained in:
Shahed Nasser
2025-02-18 15:55:42 +02:00
committed by GitHub
parent 448dbcb596
commit 084f76b73f
18 changed files with 1140 additions and 751 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
www/apps/user-guide/app/inventory/page.mdx
View File

@@ -21,7 +21,6 @@ An inventory item has different quantities for each [location](../settings/locat
The following aren't explained within this section of the user guide:
- Item allocation and locations in orders: this is explained in the [Manage Orders guide](../orders/manage/page.mdx).
- Managing general inventory of a product variant: this is explained in the [Manage Products guide](../products/manage/page.mdx).
</Note>

107
www/apps/user-guide/app/products/categories/page.mdx
View File

@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 5
---
import { DotsSix, TriangleRightMini, EllipsisHorizontal } from "@medusajs/icons"
@@ -10,33 +10,59 @@ export const metadata = {
# {metadata.title}
In this document, you’ll learn how to create a category, edit existing categories, delete a category, and more.
In this guide, you’ll learn how to create and manage product categories.
## Create a Category
## Product Categories to Organize Products
{/* TODO check for correctness */}
A product category is a group of products that belong to a similar type or theme. For example, a "Shoes" category can include products like sneakers, boots, and sandals. Categories help customers find products that are relevant to them and make it easier to browse your store.
Categories can be nested within other categories to create a hierarchy. For example, you can have a "Shoes" category nested within a "Women's" category.
A product can be in multiple categories. You can learn how to set the categories of a product in [this guide](../edit/page.mdx#manage-product-organization).
### Product Categories List
To view all product categories, go to the Product → Categories page. From here, you can see a list, filter, and search through all categories.
![Product Categories List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739874267/User%20Guide/Screenshot_2025-02-18_at_12.24.12_PM_y9ua61.png)
---
## Create a Product Category
To create a product category:
1. Go to the Product → Categories page.
2. Click on the “Create” button at the top right.
2. Click on the "Create" button at the top right.
3. In the form that opens, there are two steps:
1. In the first step:
1. Details Step:
1. Enter the category's name in the Title field. This is the only required field.
2. In the Handle field, enter a dash (`-`) separated string that's used as part of the category's URL when the customer views it on the storefront. If not specified, the handle is generated from the Title field's value.
2. The value of the Handle field is used in the category's URL on the storefront. It allows you to create a human-readable URL for the category. The handle must be unique across all categories, and it must contain lowercase letters, numbers, and hyphens (`-`). If not specified, Medusa will generate a handle from the title.
3. Optionally set the category's description in the Description field.
4. In the Status field, you can change the status to “Inactive” if you’re creating the category, but you’re still not ready to use it.
5. In the Visibility field, you can change the visibility to “Private” if you’re creating an internal category that shouldn’t be shown to the customer.
6. Optionally, you can add under the Metadata section additional information in key-value pairs.
7. Once you're done, click the "Continue" button.
2. In the second step, you can nest the new category within other categories. To move categories around, use the <InlineIcon Icon={DotsSix} alt="drag" /> icon to drag categories to their correct position.
4. In the Status field, you can change the status to "Inactive" if you don't want the category to be shown on the storefront.
5. In the Visibility field, you can change the visibility to "Private" if you’re creating an internal category that shouldn’t be shown to the customer.
6. Once you're done, click the "Continue" button.
2. In the second step, you can organize the category's ranking among other categories:
- To move the category around, use the <InlineIcon Icon={DotsSix} alt="drag" /> icon to drag categories to their correct position.
- To nest the category, drag it under another category and move it slightly to the right.
4. Once you’re done, click the Save button.
![Create Category Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739874884/User%20Guide/Screenshot_2025-02-18_at_12.30.06_PM_z53wwi.png)
---
## Edit a Category
## View Product Category Details
{/* TODO check for correctness */}
To view a category's details:
1. Go to the Product → Categories page.
2. From the list, choose the category you want to view.
![Category details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739874959/User%20Guide/Screenshot_2025-02-18_at_12.35.43_PM_wfijxl.png)
---
## Edit Product Category's Details
To edit a product category:
@@ -44,36 +70,55 @@ To edit a product category:
2. Click on the category to edit. If the category is nested in another, you may need to expand the parent category by clicking the <InlineIcon Icon={TriangleRightMini} alt="expand" /> icon.
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section of the category page.
4. Choose Edit from the dropdown.
4. In the drawer that opens, edit any of the fields of the category.
4. In the side window that opens, you can edit the category's title, handle, description, status, and visibility.
5. Once you’re done, click the Save button.
![Edit category details](https://res.cloudinary.com/dza7lstvk/image/upload/v1739875051/User%20Guide/Screenshot_2025-02-18_at_12.37.20_PM_onbpgn.png)
---
## Change Products in a Category
## Manage Category's Products
{/* TODO check for correctness */}
From the product category's details page, you can manage the products in the category.
To add or remove products from a category:
### Add Products to a Category
1. Go to the Product → Categories page.
2. Click on the category to edit. If the category is nested in another, you may need to expand the parent category by clicking the <InlineIcon Icon={TriangleRightMini} alt="expand" /> icon.
3. In the Products section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
4. Choose "Edit Products" from the dropdown.
5. In the drawer that opens, check or uncheck the products based on what you're adding or removing.
To add products to a category:
1. Go to the category's details page.
2. In the Products section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
3. Choose "Add" from the dropdown.
4. In the list that opens, check the products you want to add to the category.
5. Once you’re done, click the Save button.
![Add products to category form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739875239/User%20Guide/Screenshot_2025-02-18_at_12.40.28_PM_ffenap.png)
### Remove Products from a Category
To remove products from a category:
1. Go to the category's details page.
2. In the Products section, check the products you want to remove from the category.
3. Once you're done, either press <Kbd>R</Kbd> or click "Remove" at the bottom center of the page.
4. Confirm removing the products by clicking the "Remove" button in the pop-up.
![Remove products from category](https://res.cloudinary.com/dza7lstvk/image/upload/v1739875474/User%20Guide/Screenshot_2025-02-18_at_12.44.16_PM_vji2v1.png)
---
## Edit Categories Ranking
{/* TODO check for correctness */}
To edit the categories' ranking or hierarchy:
To change the categories' ranking and hierarchy:
1. Go to the Product → Categories page.
2. Click on the "Edit ranking" button.
3. In the form that opens, change the ranking of the categories. To move categories around, use the <InlineIcon Icon={DotsSix} alt="drag" /> icon to drag categories to their correct position.
4. Once done, click the Save button.
3. In the form that opens, you can change the ranking and hierarchy of the categories:
- Changes are saved every time you move a category.
- To move categories around, use the <InlineIcon Icon={DotsSix} alt="drag" /> icon to drag categories to their new position.
- To nest a category in another, drag it under the other category and move it slightly to the right.
4. Once done, you can close the form as the changes have been saved.
![Edit categories ranking form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739875802/User%20Guide/Screenshot_2025-02-18_at_12.49.47_PM_s3lnpc.png)
---
@@ -86,6 +131,6 @@ Deleting a category is irreversible.
</Note>
1. Go to the Product → Categories page.
2. Click on the category to edit. If the category is nested in another, you may need to expand the parent category by clicking the <InlineIcon Icon={TriangleRightMini} alt="expand" /> icon.
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section of the category page.
4. Choose Delete from the dropdown.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the category to delete.
3. Choose Delete from the dropdown.
4. Confirm deleting the category by clicking the "Delete" button in the pop-up.

53
www/apps/user-guide/app/products/collections/page.mdx
View File

@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 4
---
import { EllipsisHorizontal } from "@medusajs/icons"
@@ -10,52 +10,77 @@ export const metadata = {
# {metadata.title}
In this document, you’ll learn how to create a new product collection, edit an existing collection, delete a collection, and more.
In this guide, you’ll learn how to create and manage product collections.
## Create a Collection
## Product Collections to Organize Products
A product collection is a group of products that share a common theme or purpose. For example, a summer collection can include products like swimsuits, sunglasses, and beach towels. Collections help customers find products that are relevant to them and make it easier to browse your store.
A product can be in a single collection. You can learn how to set the collection of a product in [this guide](../edit/page.mdx#manage-product-organization).
### Product Collections List
To view all product collections, go to the Products → Collections page. From here, you can see a list, filter, and search through all collections.
![Product Collections List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739871944/User%20Guide/Screenshot_2025-02-18_at_11.45.27_AM_ca1kie.png)
---
## Create Product Collection
To create a collection:
1. Go to the Products → Collections page.
2. Click on the Create button.
2. Click on the Create button at the top right.
3. In the form that opens:
1. Enter the collection's name in the Title field.
2. In the Handle field, enter a dash (`-`) separated string that's used as part of the collection's URL when the customer views it on the storefront. If not specified, the handle is generated from the Title field's value.
5. Once done, click the Create button.
2. The value of the Handle field is used in the collection's URL on the storefront. It allows you to create a human-readable URL for the collection. The handle must be unique across all collections, and it must contain lowercase letters, numbers, and hyphens (`-`). If not specified, Medusa will generate a handle from the title.
4. Once done, click the Create button.
![Create Collection Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739872385/User%20Guide/Screenshot_2025-02-18_at_11.50.24_AM_mqznbe.png)
---
## View a collection's details
## View Product Collection's Details
To view a collection's details:
1. Go to the Products → Collections page.
2. From the table, choose the collection you want to view.
2. From the list, choose the collection you want to view.
![Collection details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739873635/User%20Guide/Screenshot_2025-02-18_at_12.13.43_PM_xaicy4.png)
---
## Edit a Collection
## Edit Product Collection
To edit a collection:
1. Go to the collection'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 drawer that opens, edit any of the collection details.
4. In the side window that opens, you can edit the collection's title and handle.
5. Once done, click the Save button.
![Edit collection form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739873760/User%20Guide/Screenshot_2025-02-18_at_12.15.46_PM_mze7zv.png)
---
## Manage a Collection’s Products
## Manage Collection’s Products
From the product collection's details page, you can manage the products in the collection.
### Add Products to a Collection
To add products to a collection:
1. Go to the collection's details page.
2. In the Products section, click the Add button.
3. From the list of products, check the box next to the products you want to add to the collection.
4. Once done, click on the Save button.
2. In the Products section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at the top right.
3. Choose Add from the dropdown.
4. From the list of products, check the products you want to add to the collection.
5. Once done, click on the Save button.
![Add products to collection form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739873949/User%20Guide/Screenshot_2025-02-18_at_12.18.55_PM_q6lgsk.png)
### Remove a Product from a Collection

33
www/apps/user-guide/app/products/create/bundle/page.mdx Normal file
View File

@@ -0,0 +1,33 @@
---
sidebar_label: "Bundle Product"
---
export const metadata = {
title: `Create Bundle Product`,
}
# {metadata.title}
In this guide, you'll learn how to create a product whose variants make up a bundle of products.
## Bundle Products with Inventory Kits
Consider you separately sell a camera, a lens, and a camera bag, but you want to sell these products as a bundle for a different price.
Medusa supports variants with inventory kits, which is a collection of inventory items that make up the variant. To create a bundle product, you create a product with a variant that has an inventory kit of each product variant's inventory items.
So, the camera bundle would be a variant having the inventory items of the camera, lens, and camera bag. You can then manage the bundle product separately, including its price. When the variant is purchased, the inventory items are automatically deducted from the stock based on the required quantity.
![Bundle product diagram](https://res.cloudinary.com/dza7lstvk/image/upload/v1739870226/User%20Guide/bundle_product_oxdibk.jpg)
---
## How to Create a Bundle Product
You create a product with bundle variants as explained in the [Create Product](../page.mdx) guide. For the variants that make up the bundle, you enable the "Has inventory kit" toggle in the "Variants" step.
![Enable has inventory kit](https://res.cloudinary.com/dza7lstvk/image/upload/v1739865469/User%20Guide/Screenshot_2025-02-18_at_9.57.05_AM_j7cugr.png)
This opens a new step in the product-creation form, where you can add inventory items of the product variants that make up the bundle. For each inventory item, you can specify the quantity required for the variant to be purchasable.
![Create Product Fourth Step](https://res.cloudinary.com/dza7lstvk/image/upload/v1739866189/User%20Guide/Screenshot_2025-02-18_at_10.09.37_AM_lnd8jj.png)

33
www/apps/user-guide/app/products/create/multi-part/page.mdx Normal file
View File

@@ -0,0 +1,33 @@
---
sidebar_label: "Multi-Part Product"
---
export const metadata = {
title: `Create Multi-Part Product`,
}
# {metadata.title}
In this guide, you'll learn how to create a product whose variants are made up of multiple inventory parts.
## Multi-Part Products with Inventory Kits
Consider a bicycle that consists of a frame, wheels, and handlebars. Each of these parts is an inventory item that makes up the bicycle. When you create a product with multi-part variants, you're creating a product that consists of multiple inventory items.
Medusa supports variants with inventory kits, which is a collection of inventory items that make up the variant's part. In addition, the variant can require a specific quantity of each inventory item to be available in stock.
For example, a bicycle product variant needs two wheels, one frame, and one handlebar to be available in stock. If any of these inventory items are out of stock, the variant is not purchasable. Also, when the variant is purchased, the inventory items are automatically deducted from the stock based on the required quantity.
![Multi-part Product Diagram](https://res.cloudinary.com/dza7lstvk/image/upload/v1739868032/User%20Guide/multi-part_product_lgnymo.jpg)
---
## How to Create a Multi-Part Product
You create a product with multi-part variants as explained in the [Create Product](../page.mdx) guide. For the variants with multi-parts, you enable the "Has inventory kit" toggle in the "Variants" step.
![Enable has inventory kit](https://res.cloudinary.com/dza7lstvk/image/upload/v1739865469/User%20Guide/Screenshot_2025-02-18_at_9.57.05_AM_j7cugr.png)
This opens a new step in the product-creation form, where you can add inventory items that make up the variant. For each inventory item, you can specify the quantity required for the variant to be purchasable.
![Create Product Fourth Step](https://res.cloudinary.com/dza7lstvk/image/upload/v1739808931/User%20Guide/Screenshot_2025-02-17_at_6.15.16_PM_hofawf.png)

117
www/apps/user-guide/app/products/create/page.mdx Normal file
View File

@@ -0,0 +1,117 @@
---
sidebar_position: 1
---
import { DotsSix, EllipsisHorizontal, XMark, TaxExclusive, TaxInclusive } from "@medusajs/icons"
export const metadata = {
title: `Create Product`,
}
# {metadata.title}
In this guide, you’ll learn how to create a new product using the Medusa Admin.
## Types of Products to Create
You can create different types of products in Medusa:
- A simple product without variants, such as a painting.
- A product with variants, such as a t-shirt with different colors and sizes.
- A product that has [multi-part variants](./multi-part/page.mdx), such as a bicycle that consists of a frame, wheels, and handlebars. Each variant has an inventory kit that makes up the product's parts.
- A product that is sold as a [bundle](./bundle/page.mdx), such as a camera bundle that consists of a camera, a lens, and a camera bag. Each variant has an inventory kit of each product variant's inventory items.
This guide covers the general steps to create any of these products. You can also refer to the specific guides for creating [multi-part products](./multi-part/page.mdx) and [bundle products](./bundle/page.mdx).
---
## How to Create a Product
To create a new product:
1. Go to the Products page from the sidebar.
2. Click on the Create button at the top right.
This opens a form with three steps: Details, Organize, and Variants. There's a fourth optional step "Inventory Kits" that's only shown if you enable the "Has inventory kit" toggle for a variant, as explained in the [third step](#3-variants-step).
### 1. Details Step
In the first "Details" step, you can enter the product's general information and specify their variants and options:
1. Enter the product's name in the Title field. This is the only required field in the form.
2. Optionally enter a Subtitle, Handle, and Description.
- The value of the Handle field is used in the product's URL on the storefront. It allows you to create a human-readable URL for the product. The handle must be unique across all products, and it must contain lowercase letters, numbers, and hyphens (`-`). If not specified, Medusa will generate a handle from the title.
3. Optionally upload images of the product under the Medusa section.
- To set an image as the thumbnail:
- Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the image's right.
- Choose "Make thumbnail" from the dropdown.
4. If the product has variants, such as different colors or sizes, enable the "Yes, this is a product with variants" toggle. This will show new fields to enter product options.
- Each product option has a title (for example, `Color`) and a list of values (for example, `Black, White`). You can separate values by a comma.
- To add a new product option, click the "Add" button.
- After adding the options, product variants are created automatically from these options. You can disable creating a product variant by unchecking its checkbox.
Once you're done, click the "Continue" button.
![Create Product First Step](https://res.cloudinary.com/dza7lstvk/image/upload/v1739806746/User%20Guide/Screenshot_2025-02-17_at_5.38.51_PM_eto1rg.png)
### 2. Organize Step
In the second "Organize" step, you can organize the product by adding it to collections, categories, and other organization details:
{/* TODO add links later */}
1. If you don't want to allow applying discounts to the product, disable the "Discountable" toggle.
2. You can optionally choose a type for the products. You can create product types in [Settings](#).
3. You can optionally choose a collection for the product. You can create collections under the [Product domain](../collections/page.mdx).
4. You can optionally choose categories for the product. You can create categories under the [Product domain](../categories/page.mdx).
5. You can optionally add tags to the product. You can create product tags in [Settings](#).
6. You must enter a shipping profile for the product. A shipping profile defines how a product can be shipped. You can create shipping profiles in [Settings](#).
7. You can optionally set the sales channels a product is available in. In the storefront, only the products that are in the storefront's sales channel can be purchased. To add the product to a sales channel:
- Click the "Add" button next to the "Sales channels" section.
- In the list that opens, check the sales channels you want to add the product to.
- Once you're done, click the "Save" button.
Once you're done with this step, click the "Continue" button.
![Create Product Second Step](https://res.cloudinary.com/dza7lstvk/image/upload/v1739807251/User%20Guide/Screenshot_2025-02-17_at_5.47.03_PM_ke1xtb.png)
### 3. Variants Step
In the third "Variants" step, you can manage the product's variants you added in the first step. The step shows a [bulk editor](../../tips/bulk-editor/page.mdx) with a row for each variant:
1. In the column "Title", you can change the variant's title.
2. In the column "SKU", you can set the variant's SKU.
3. In the column "Managed Inventory", you can enable inventory management for the variant. If disabled, the variant is always considered in stock. Otherwise, you can set the inventory quantity in different stock locations, and Medusa will manage that inventory, such as decrementing it when the variant is purchased.
4. In the column "Allow backorder", you can enable backorders for the variant. If enabled, customers can purchase the variant even if it's out of stock.
5. In the column "Has inventory kit", you can enable inventory kits for the variant, allowing you to add multi-part or bundled products. If enabled, you'll see a [fourth step "Inventory Kits"](#4-inventory-kits-step-optional) after this step.
6. The next columns are price columns for all the currencies and regions you have set up in Medusa. You can set the price for each variant in each currency and region. You can also add the prices after creating the product.
<Note title="Tips">
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx) or [region's](../../settings/regions/page.mdx) settings.
</Note>
Once you're done, either click the "Publish" button if there are no more steps, or click the "Continue" button to go to the next step.
![Create Product Third Step](https://res.cloudinary.com/dza7lstvk/image/upload/v1739807921/User%20Guide/Screenshot_2025-02-17_at_5.58.27_PM_i708en.png)
### 4. Inventory Kits Step (Optional)
If you enabled the "Has inventory kit" checkbox for a variant in the third step, you'll see a fourth optional step "Inventory Kits". Inventory kits allow you to create:
- A multi-part product, where a product is made up of multiple parts. For example, if you're selling a bicycle that consists of a frame, wheels, and handlebars, you can add the frame, wheels, and handlebars as inventory items in the variant's inventory kit.
- A bundled product, where products are sold as a bundle. For example, if you're selling a camera bundle that consists of a camera, a lens, and a camera bag, you can add the inventory items of each of these product variants in the variant's inventory kit.
To manage the inventory kit of variants in the fourth step, for each variant:
1. Select an inventory item from the dropdown.
2. In the Quantity field, enter the quantity required for a single item of the variant. For example, if the variant is a bicycle and the inventory item is a wheel, you can enter `2` in the Quantity field to indicate that the variant requires two wheels.
3. To add more inventory items, click the Add button.
Once you're done, click the "Publish" button.
![Create Product Fourth Step](https://res.cloudinary.com/dza7lstvk/image/upload/v1739808931/User%20Guide/Screenshot_2025-02-17_at_6.15.16_PM_hofawf.png)

288
www/apps/user-guide/app/products/edit/page.mdx Normal file
View File

@@ -0,0 +1,288 @@
---
sidebar_position: 2
---
import { ArrowUpRightOnBox, EllipsisHorizontal, EllipsisVertical, ThumbnailBadge } from "@medusajs/icons"
import { Table } from "docs-ui"
export const metadata = {
title: `Edit Product`,
}
# {metadata.title}
In this guide, you'll learn about editing a product's details in the Medusa Admin.
## Open Product's Details
To open a product's details:
1. Go to the Products page from the sidebar.
2. Select one of the products to open its details page.
![Product Details Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739809615/User%20Guide/Screenshot_2025-02-17_at_6.26.42_PM_cqesbi.png)
---
## Manage General Product Details
The first section, which has the product's title as a header, includes the product's general information and options. Use this section to view and edit the product's details.
![Product Details Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739809977/User%20Guide/Screenshot_2025-02-17_at_6.32.31_PM_a3lsnl.png)
### Product Statuses
A product can have one of the following statuses:
<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>Published</Table.Cell>
<Table.Cell>The product is available on the storefront and can be purchased.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Draft</Table.Cell>
<Table.Cell>A product whose details you're still working on. It's not available on the storefront.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Proposed</Table.Cell>
<Table.Cell>A product that is not yet approved for publishing. It's not available on the storefront.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>Rejected</Table.Cell>
<Table.Cell>A product that has been rejected and is not available on the storefront.</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Edit Product Details
To edit the product's general details:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the section.
2. Choose "Edit" from the dropdown.
3. In the side window that opens, you can edit the product's status, title, subtitle, handle, material, description, and whether it's discountable.
4. Once you're done, click the "Save" button.
### Delete Product
In this section, you can also delete the product.
<Note type="warning">
Deleting a product is irreversible.
</Note>
To delete the product:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the section.
2. Choose "Delete" from the dropdown.
3. Confirm deleting the product by clicking the "Delete" button in the pop-up.
---
## Manage Product Media
The Media section includes the product's images. Use this section to view and edit the product's images.
![Media Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739810036/User%20Guide/Screenshot_2025-02-17_at_6.33.44_PM_rq9wud.png)
### Add Images
To add images to the product:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Media" section.
2. Choose "Edit" from the dropdown.
3. In the form that opens, upload images either by dragging and dropping them or by clicking the "Upload images" box.
4. Once you're done, click the Save button.
### Edit Images Order
You can edit the order that images are shown in. To do this:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Media" section.
2. Choose "Edit" from the dropdown.
3. In the form that opens, drag and drop images to change their order.
4. Once you're done, click the Save button.
### Set Thumbnail Image
The product's thumbnail image has the <InlineIcon Icon={ThumbnailBadge} alt="thumbnail" /> icon at its top left.
To set an image as the thumbnail:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Media" section.
2. Choose "Edit" from the dropdown.
3. Hover over the image you want to make as a thumbnail, then click on its checkbox.
4. Press <Kbd>T</Kbd> or click the "Make thumbnail" button at the bottom of the page.
5. Once you're done, click the Save button.
### Delete Images
You can delete the images from the product's page or from the images form.
To delete product images:
1. Hover over the product images you want to delete and click their checkbox.
2. Press <Kbd>D</Kbd> or click the "Delete" button at the bottom of the page.
3. Confirm deleting the images by clicking the "Delete" button in the pop-up.
---
## Manage Product Options
The Options section includes the product's options. Use this section to view and edit the product's options.
![Options Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739810071/User%20Guide/Screenshot_2025-02-17_at_6.34.21_PM_y5eiwe.png)
### Create Options
<Note>
Unlike the product-creation form, when you create an option for an existing product you must create the variants manually.
</Note>
To add a new option to the product:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Options" section.
2. Choose Create from the dropdown.
3. In the side window that opens:
- In the Option title field, enter the option's title, such as "Color".
- In the Values field, enter the option's values, such as "Red, Blue, Green". Values are separated by a comma.
4. Once you're done, click the Save button.
### Edit Option
To edit an option:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the option.
2. Choose Edit from the dropdown.
3. In the side window that opens, you can edit the option's title and values.
4. Once you're done, click the Save button.
### Delete Option
<Note type="warning">
Deleting an option is irreversible.
</Note>
To delete an option:
1. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the right of the option.
2. Choose Delete from the dropdown.
3. Confirm deleting the option by clicking the Delete button in the pop-up.
---
## Variants Section
The Variants section includes the product's variants. You can view, search, and filter variants. You can also edit a variant's informtion, or click on it to edit more of its details.
Refer to [this guide](../variants/page.mdx) to learn about managing product variants.
![Variants Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739810147/User%20Guide/Screenshot_2025-02-17_at_6.35.01_PM_jkflov.png)
---
## Manage Product Metadata
Metadata is custom data that can be associated with the product in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the product.
To edit the product's metadata:
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of 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 right.
- 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 right.
- Choose "Delete row" from the dropdown.
3. Once you're done, click the Save button.
---
## Manage Product's Sales Channels
The Sales Channels section includes the sales channels the product is available in. Use this section to view and edit the product's sales channels.
![Sales Channels Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739810276/User%20Guide/Screenshot_2025-02-17_at_6.37.44_PM_hwvbrl.png)
To manage the sales chanels a product is available in:
<Note type="warning">
Removing a product from a sales channel will make it unavailable for purchase in that sales channel.
</Note>
1. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Sales Channels" section.
2. Choose Edit from the dropdown.
3. In the list that shows, check the sales channels you want to add the product to, or unchecked the ones you want to remove the product from.
4. Once you're done, click the Save button.
---
## Manage Product's Shipping Configuration
The Shipping Configuration section includes the product's shipping profile. Use this section to view and edit the product's shipping profile.
![Shipping Configuration Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739810310/User%20Guide/Screenshot_2025-02-17_at_6.38.17_PM_ko3a9x.png)
### Edit Product's Shipping Profile
To edit the product's shipping profile:
1. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Shipping Configuration" section.
2. Choose Edit from the dropdown.
3. In the side window that opens, choose the shipping profile from the dropdown.
4. Once you're done, click the Save button.
---
## Manage Product Organization
The Organize section includes the product's organization details. Use this section to view and edit the product's organization details, such as categories and collection.
![Organize Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739810358/User%20Guide/Screenshot_2025-02-17_at_6.39.07_PM_maztxs.png)
To edit the product's organization details:
1. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Organize" section.
2. Choose Edit from the dropdown.
3. In the side window that opens, you can set the product's type, collection, categories, and tags.
4. Once you're done, click the Save button.
---
## Manage Product Attributes
The Attributes section includes the product's attributes, such as height and weight. Use this section to view and edit the product's attributes.
![Attributes Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739810408/User%20Guide/Screenshot_2025-02-17_at_6.39.56_PM_lszje2.png)
To edit the product's attributes:
1. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the "Attributes" section.
2. Choose Edit from the dropdown.
3. In the side window that opens, you can set the product's width, height, length, weight, MID code, HS code, and country of origin.
4. Once you're done, click the Save button.
---
## JSON Section
The JSON section is useful for developers to view the raw produt data in JSON structure. Developers can use this section to debug and troubleshoot issues related to the product.
To view the JSON structure, click on the <InlineIcon Icon={ArrowUpRightOnBox} alt="Expand" /> icon.

46
www/apps/user-guide/app/products/export/page.mdx
View File

@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
---
import { BellAlert, ArrowDownTray } from "@medusajs/icons"
@@ -10,48 +10,28 @@ export const metadata = {
# {metadata.title}
In this document, you’ll learn how to export all products in your Medusa store.
In this guide, you’ll learn how to export all products in your Medusa store.
When you export your products, you download a CSV with the products' details.
## Export Products as CSV
When you export your products, you download a CSV with the products' details. This is useful to import into external systems, or for creating backups.
---
## Export Products
{/* TODO check info for correctness */}
To export products:
1. Go to the Products page.
2. Click on the Export button at the top right.
3. Click Export in the window that opens.
4. To check the export's status, click the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the page. You should see your new export loading.
5. Once the export is ready, click the <InlineIcon Icon={ArrowDownTray} alt="download" /> icon.
2. If you want to export a subset of products matching filters, apply the filters first to the products list.
3. Click on the Export button at the top right.
4. In the side window that opens, you can see any filters you've applied.
5. Click on the Export button to start the export.
6. To check the export's status, click the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the page. You should see your new export loading.
7. Once the export is ready, click the <InlineIcon Icon={ArrowDownTray} alt="download" /> icon.
<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>
---
## Cancel a Product Export
{/* TODO check for correctness and if feature is still available */}
To cancel a product export:
1. Click on the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the page.
2. Find the export you want to cancel.
3. Click on the cancel button.
---
## Delete a Product Export
{/* TODO check for correctness and if feature is still available */}
To delete a product export:
1. Click on the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the page.
2. Find the export you want to delete.
3. Click on the Delete button.

66
www/apps/user-guide/app/products/gift-cards/customer-gift-card/page.mdx
View File

@@ -1,66 +0,0 @@
---
sidebar_position: 2
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage a Customer Gift Card`,
}
# {metadata.title}
In this document, you’ll learn about managing customer gift cards, including how to create, edit, and delete them.
## Create Customer Gift Card
To create a customer gift card:
1. Go to Products → Gift Cards.
2. Click on the Create button.
3. In the form that opens:
1. In the Region field, choose the region that the gift card can be used in.
2. In the Balance field, specify the gift card's balance.
3. Enable or disable the gift card by toggling the Enabled field.
4. To set an expiry date, toggle the "Expiry date" field and enter the date in the field shown.
5. In the Email field, specify the email of the customer that the gift card belongs to.
6. Optionally enter in the "Personal message" field a message that the customer sees when they receive the gift card.
4. Once you're done, click the Save button.
---
## View Customer Gift Card Details
To view a customer gift card:
1. Go to Products → Gift Cards.
2. Click on the gift card to view its details.
---
## Edit Customer Gift Card
To edit a customer gift card:
1. Go to the gift card's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top of the first section.
3. Choose Edit from the dropdown.
3. In the drawer that opens, edit the gift card's details.
4. Once you're done, click the Save button.
---
## Delete Customer Gift Card
<Note type="warning">
Deleting a customer gift card is irreversible.
</Note>
To delete a customer gift card:
1. Go to the gift card's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top of the first section.
3. Choose Delete from the dropdown.
4. Confirm deleting the gift card by clicking the Delete button in the pop-up.

40
www/apps/user-guide/app/products/gift-cards/page.mdx
View File

@@ -1,40 +0,0 @@
---
sidebar_position: 4
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Gift Cards`,
}
# {metadata.title}
In this document, you'll learn about the types of gift cards and get an overview of the Gift Cards page.
## Types of Gift Cards
In the Medusa Admin, there are two types of gift cards:
- **Product gift card**: A gift card that customers can purchase in your store.
- **Customer gift card**: A gift card that admin users create for a specific customer email. This gift card can't be purchased by other customers.
---
## Gift Cards Page
The Gift Cards page shows you the list of customer gift cards and allows you to create both types of Gift Cards.
As for product gift cards, they're displayed in the Products page. You can view them either by:
{/* TODO check filter name */}
- Clicking the "View gift card products" button in the Gift Cards page.
- Applying the Gift Card filter on the Gift Cards page.
---
## Learn More About Gift Cards
- [Manage product gift cards](./product-gift-card/page.mdx)
- [Manage customer gift cards](./customer-gift-card/page.mdx)

115
www/apps/user-guide/app/products/gift-cards/product-gift-card/page.mdx
View File

@@ -1,115 +0,0 @@
---
sidebar_position: 1
---
import { EllipsisHorizontal } from "@medusajs/icons"
export const metadata = {
title: `Manage a Product Gift Card`,
}
# {metadata.title}
In this document, you’ll learn about managing product gift cards, including how to create, edit, and delete them.
## Create Product Gift Card
{/* TODO check info for correctness */}
To create a product gift card:
1. Go to Products → Gift Cards.
2. Click the "Add gift card products" button.
3. In the form that opens, there are two steps:
1. In the first step:
1. Enter the gift card's title and description in their respective fields.
2. Under the Denominations section, for each denomination, enter its name and amount in the store's default currency.
3. Under the Organize section, you can add a type, collection, categories, or tags that the product gift card belongs to.
4. Under the "Sales channels" section:
1. Enable the field if you want to enable the gift card in sales channels other than the default one.
2. If you enable the field, check the checkbox next to the sales channels that the gift card is available in.
5. Under the Thumbnail section, upload an image that's used as the thumbnail of the gift card.
6. Under the Media section, upload images of the gift card.
7. Once you're done, click the Continue button.
2. In the second step, add prices of the gift card for different currencies in your store using the [bulk editor](../../../tips/bulk-editor/page.mdx). You can add a currency by clicking the "Add currency" button.
4. Once you're done, click the Save button.
---
## View Product Gift Card
{/* TODO check info for correctness */}
To view product gift cards:
1. Go to Products → Gift Cards.
2. Click the "View gift card products" button.
3. This takes you to the Products page with the Gift Card filter applied.
4. Find the gift card to view and click on it.
This opens the gift card's details page, which is similar to the regular product's details page.
---
## Edit a Product Gift Card's General Details
{/* TODO check info for correctness */}
To edit a product gift card's details:
1. Go to the product gift card's details page.
2. Click 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 drawer that opens, edit the gift card's details.
5. Once you're done, click the Confirm button.
---
## Edit a Product Gift Card's Denominations
{/* TODO check info for correctness */}
To edit a product gift card's denominations:
1. Go to the product gift card's details page.
2. Under the Denominations section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
3. Choose Edit from the dropdown.
4. In the drawer that opens, edit the gift card's denominations in the store's default currency.
5. Once you're done, click the Save button.
---
## Edit a Product Gift Card's Prices
{/* TODO check info for correctness */}
To edit a product gift card's prices:
1. Go to the product gift card's details page.
2. Under the Variants section, click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
3. Choose Edit from the dropdown.
4. In the [bulk editor](../../../tips/bulk-editor/page.mdx) form that opens, edit the gift card's prices in different currencies. You can add currencies by clicking the "Add currency" button.
5. Once you're done, click the Save button.
---
## Edit Other Product Gift Card's Details
To edit other details of the product gift card, such as its images or sales channels availability, refer to the [manage products guide](../../manage/page.mdx).
---
## Delete Product Gift Card
<Note type="warning">
Deleting a product gift card is irreversible.
</Note>
To delete a product gift card:
1. Go to the product gift card's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
3. Choose Delete from the dropdown.
4. Confirm deleting the product by clicking the “Yes, confirm” button in the pop-up.

285
www/apps/user-guide/app/products/import/page.mdx
View File

@@ -1,8 +1,9 @@
---
sidebar_position: 5
sidebar_position: 6
---
import { ArrowDownTray, Trash, BellAlert } from "@medusajs/icons"
import { ArrowDownTray, Trash, BellAlert, EllipsisHorizontal } from "@medusajs/icons"
import { Prerequisites, Table } from "docs-ui"
export const metadata = {
title: `Import Products`,
@@ -10,43 +11,259 @@ export const metadata = {
# {metadata.title}
In this document, you’ll learn how to import products into your Medusa store.
In this guide, you’ll learn how to import products into your Medusa store.
## Overview
## Import Products from a CSV File
To import products, you must have the products in a CSV file. You can see a template of the CSV file during the import process.
If you're migrating from another commerce platform, or from Medusa v1, you can import products into Medusa using a CSV file.
{/* <Note>
When you import the CSV file, Medusa will either create or update products based on the CSV file you upload.
TODO add link [this guide](../../modules/products/admin/import-products.mdx#csv-file)
### CSV File Format
For a list of accepted columns, refer to this guide.
In the import form, you can download a template CSV file to see the format required for the import. The CSV file can have the following columns:
</Note> */}
{/* TODO need updates */}
When you import products into your Medusa store, you’ll either create new products or update existing ones.
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Column</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>`Product Id`</Table.Cell>
<Table.Cell>The ID for an existing product to update. If provided, no other columns are required.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Handle`</Table.Cell>
<Table.Cell>A unique identifier used in the product's URL on the storefront. It allows you to create a human-readable URL for the product. The handle must be unique across all products, and it must contain lowercase letters, numbers, and hyphens (`-`). If not specified, Medusa will generate a handle from the title.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Title`</Table.Cell>
<Table.Cell>The product’s title. This is the only required field if you don't provide a `Product Id`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Status`</Table.Cell>
<Table.Cell>The status of the product. Can be `draft` (default), `published`, `proposed`, or `rejected`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Description`</Table.Cell>
<Table.Cell>A description of the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Subtitle`</Table.Cell>
<Table.Cell>A subtitle for the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product External Id`</Table.Cell>
<Table.Cell>The ID of the product in an external system, such as an ERP.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Thumbnail`</Table.Cell>
<Table.Cell>The URL of the product's thumbnail image.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Collection Id`</Table.Cell>
<Table.Cell>The ID of the collection the product belongs to.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Type Id`</Table.Cell>
<Table.Cell>The ID of the product type.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Category 1`</Table.Cell>
<Table.Cell>The primary category of the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Created At`</Table.Cell>
<Table.Cell>The date and time when the product was created.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Deleted At`</Table.Cell>
<Table.Cell>The date and time when the product was deleted.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Discountable`</Table.Cell>
<Table.Cell>Whether the product can be discounted. Can be `TRUE` or `FALSE`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Height`</Table.Cell>
<Table.Cell>The height of the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Hs Code`</Table.Cell>
<Table.Cell>The Harmonized System (HS) code for the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Image *`</Table.Cell>
<Table.Cell>The URL of a product image, where `*` is the image's number. For example, `Product Image 1`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Length`</Table.Cell>
<Table.Cell>The length of the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Material`</Table.Cell>
<Table.Cell>The material of the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Mid Code`</Table.Cell>
<Table.Cell>The Manufacturer Identification Number (MID) for the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Origin Country`</Table.Cell>
<Table.Cell>The country of origin for the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Tag *`</Table.Cell>
<Table.Cell>The ID of the product's tag, where `*` is the tag's number. For example, `Product Tag 1`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Updated At`</Table.Cell>
<Table.Cell>The date and time when the product was last updated.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Weight`</Table.Cell>
<Table.Cell>The weight of the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Width`</Table.Cell>
<Table.Cell>The width of the product.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Shipping Profile Id`</Table.Cell>
<Table.Cell>The ID of the product's shipping profile.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Id`</Table.Cell>
<Table.Cell>The ID for an existing variant to update. The variant must belong to the product specified in the `Product Id` column. If provided, no other variant-related columns are required.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Title`</Table.Cell>
<Table.Cell>The title of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Sku`</Table.Cell>
<Table.Cell>The SKU of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Upc`</Table.Cell>
<Table.Cell>The UPC of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Ean`</Table.Cell>
<Table.Cell>The EAN of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Hs Code`</Table.Cell>
<Table.Cell>The Harmonized System (HS) code for the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Mid Code`</Table.Cell>
<Table.Cell>The Manufacturer Identification Number (MID) for the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Manage Inventory`</Table.Cell>
<Table.Cell>Whether Medusa manages the variant's inventory. Can be `TRUE` or `FALSE`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Allow Backorder`</Table.Cell>
<Table.Cell>Whether the variant allows backorders. Can be `TRUE` or `FALSE`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Barcode`</Table.Cell>
<Table.Cell>The barcode of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Created At`</Table.Cell>
<Table.Cell>The date and time when the variant was created.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Deleted At`</Table.Cell>
<Table.Cell>The date and time when the variant was deleted.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Height`</Table.Cell>
<Table.Cell>The height of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Length`</Table.Cell>
<Table.Cell>The length of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Material`</Table.Cell>
<Table.Cell>The material of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Metadata`</Table.Cell>
<Table.Cell>Metadata for the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Option * Name`</Table.Cell>
<Table.Cell>The name of the variant's option, where `*` is the option's number. For example, `Variant Option 1 Name`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Option * Value`</Table.Cell>
<Table.Cell>The value of the variant's option, where `*` is the option's number. For example, `Variant Option 1 Value`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Origin Country`</Table.Cell>
<Table.Cell>The country of origin for the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Price *`</Table.Cell>
<Table.Cell>The price of the variant in a currency, where `*` is the currency's ISO code. For example, `Variant Price USD`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Product Id`</Table.Cell>
<Table.Cell>The ID of the product the variant belongs to.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Updated At`</Table.Cell>
<Table.Cell>The date and time when the variant was last updated.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Variant Rank`</Table.Cell>
<Table.Cell>The rank of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Weight`</Table.Cell>
<Table.Cell>The weight of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Width`</Table.Cell>
<Table.Cell>The width of the variant.</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Import List of Products
{/* TODO check info for correctness */}
<Prerequisites
items={[
{
text: "A CSV file to import.",
link: "#csv-file-format",
}
]}
/>
To import products:
1. Go to the Products page.
2. Click on the Import button 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 <InlineIcon Icon={ArrowDownTray} 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.
3. In the side window:
1. If you’re unsure of what the CSV file’s format must be like, you can download the template CSV file.
2. To upload the CSV file you want to import products from, either drag-and-drop the file to the upload area or click on the area to open a file picker.
3. After you upload the CSV file:
1. Check the number of products to be created or updated above the uploaded file’s name.
2. You can remove the file you choose by clicking the <InlineIcon Icon={Trash} 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 process. Based on the number of products you’re importing, it can take some time.
1. Check the number of products to be created or updated.
2. To remove the uploaded file, click the <InlineIcon Icon={EllipsisHorizontal} alt="trash" /> icon, and choose Delete from the dropdown.
4. Once you’re done, click the Import button.
<Note>
@@ -54,29 +271,21 @@ If you face any errors or difficulties, please contact your technical support te
</Note>
![Import Products Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739878759/User%20Guide/Screenshot_2025-02-18_at_1.39.01_PM_ctovne.png)
This starts the import process which may take some time.
### Check Import Status
{/* TODO check info for correctness */}
To check the status of the import:
To check whether the import is in progress, finished, or failed:
1. Click on the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the page.
2. Find the product import, which should be the latest item on the list.
If a loading indicator is showing, then the import process is still in progress.
The text on the import item will explain the current state of the import.
If the import is done, you should see the text “Import of products is done.”
<Note>
Once the import is done, you should find the created/updated products on the Products page.
If the product import fails, please contact your technical support to check the error logs.
---
## Cancel Import
{/* TODO check for correctness and if feature is still available */}
To cancel a product import:
1. Click on the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the page.
2. Find the import you want to cancel.
3. Click on the cancel button.
</Note>

338
www/apps/user-guide/app/products/manage/page.mdx
View File

@@ -1,338 +0,0 @@
---
sidebar_position: 1
---
import { DotsSix, EllipsisHorizontal, XMark } from "@medusajs/icons"
export const metadata = {
title: `Manage Products`,
}
# {metadata.title}
In this document, you’ll learn how to create new products, edit a product's details, and more.
## Create a Product
{/* TODO check for correctness */}
To create a new product:
1. Go to the Products page.
2. Click on the Create button at the top right.
3. In the new form that opens, there are two steps:
1. In the first step:
1. Enter the product's name under the Title field. This is the only required field in the form.
2. Optionally enter the values of the Subtitle, Material, and Description fields.
3. In the Handle field, enter a dash (`-`) separated string that's used as part of the product's URL when the customer views it on the storefront. If not specified, the handle is generated from the Title field's value.
4. If you don't want discounts to be applied on the product, toggle the Discountable button.
5. Under the Organize section, all fields are optional:
1. Choose types, collections, categories, or tags that the product belongs to.
2. To add sales channels that the product is available in:
1. Click on the Add Sales Channel button.
2. In the drawer that opens, choose the sales channels to add the products to.
3. Once done, click on the "Add channels" button.
6. Under the Variants section:
1. To add a product option:
1. Enter the title (for example, "Color") and the variations (for example, "Black") into the "Product options" table.
2. To add multiple variations, set the variations' value to a comma-separated list of values (for example, "Black, White").
3. To add a new option, press <Kbd>tab</Kbd> when at the last column of the current row to add a new row.
2. After you add options, product variants are created automatically from these options.
- You can disable creating a product variant by unchecking its checkbox.
- You can re-order the product variants by dragging the <InlineIcon Icon={DotsSix} alt="drag" /> icon.
7. Under the Attributes section, enter stock and shipping related details of the product, such as width, height, MID code, and more.
8. Under the Thumbnail section, upload an image used as the thumbnail of the product.
9. Under the Medusa section, upload the product's images.
10. Once you're done, click on the Continue button.
2. In the second step, enter the details of the product's variants, such as title, SKU, or price.
4. Once done, click the Save button.
---
## View Product Details
To view a product’s details:
1. Go to the Products page.
2. Click on the product you want to view.
---
## Edit a Product’s General Information
{/* TODO check for correctness */}
To edit a product’s general information:
1. Go to the product’s details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the first section.
3. Choose “Edit General Information” from the dropdown.
4. In the drawer that opens, edit any of the product's general information.
5. Once done, click on the Confirm button.
---
## Change a Product’s Status
{/* TODO check for correctness */}
To change a product’s status:
1. Go to the product’s details page.
2. Click on the status at the top right of the first section. For example, if the current status of the product is Active, you should see Active written at the top right of the first section.
3. Click on the status in the dropdown to change the status.
---
## Manage Product Media
{/* TODO check for correctness */}
To manage the product's media:
1. Go to the product's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the top right of the Media section.
3. Choose Edit from the dropdown.
4. In the form that opens:
1. To upload an image, drag and drop the image to the box at the right, or click the box to select media to upload.
2. To set an image as a thumbnail image:
1. Hover over the image.
2. Click the checkbox shown at the top right of the image.
3. Press <Kbd>T</Kbd> to make the image a thumbnail.
3. To delete one or more images:
1. Hover over the image.
2. Click the checkbox shown at the top right of the images to select.
3. Press <Kbd>D</Kbd> to delete the images.
5. Once you're done, click the Save button.
---
## Add Product Option
{/* TODO check for correctness */}
To add a product option:
1. Go to the product’s details page.
2. In the Options section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right.
3. Choose Create from the dropdown.
4. In the drawer that opens, enter the product option's title.
5. Once you're done, click the Save button.
<Note>
To add values to the new product option, add a variant.
</Note>
{/* TODO check if product options can be edited */}
{/* ## Manage Product Options
<Note>
After a product is created, the only way to add values to an option is when you add or edit a variant. Adding a new option automatically creates the value “Default Value”. An option’s value is deleted if no variant is using it.
</Note>
To manage a product’s option:
1. Go to the product’s details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the top right of the Variants section.
3. Click on Edit Options from the dropdown.
4. In the new window that opens:
1. You can add a new option by clicking the “Add an option” button.
2. You can edit an option’s name by changing its name in the field.
3. You can delete an option 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, click on the "Save and close" button. */}
---
## Manage Product Variants
### Add a Variant
{/* TODO check for correctness */}
<Note>
Multiple variants can’t have the same options combination.
</Note>
To add a variant to a product:
1. Go to the product’s details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the top right of the Variants section.
3. Choose "Add variant" from the dropdown.
4. In the new form that opens:
1. Enter the variant's name in the Title field.
2. Optionally enter the variant's material in the Material field.
3. You'll find a field for each product option to specify its value. You can choose an existing value or enter a new one.
4. Under the Stock & Inventory section:
1. Enter the general inventory details such as SKU or EAN.
2. If you disable the "Manage inventory" field, Medusa assumes the product is always in stock.
2. If you enable the "Manage inventory" field, choose the stock locations of the variant in the Locations field.
3. If "Allow backorders" is enabled, customers can purchase this variant even if it’s out-of-stock. You can only enable "Allow Backorders" if "Manage Inventory" is enabled.
5. Under the Attributes section, enter general details related to shipping such as width, height or MID code.
5. Once you’re done, click on the Save button.
{/* TODO check if this feature is still available */}
{/* ### Edit Variants Position
To edit variants’ position in a product:
1. Go to the product’s details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the top right of the Variants section.
3. Click on Edit Variants from the dropdown.
4. In the window that opens:
1. Click and hold the <InlineThemeImage light="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999654/Medusa%20Docs/UI%20Icons/zp2QTbO_io0f7i.png" dark="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999654/Medusa%20Docs/UI%20Icons/zp2QTbO_io0f7i.png" alt="grip" /> icon next to the variant, then drag it to the position you want.
2. You can also change the inventory of the variants.
5. Once you’re done, click on the “Save and close” button. */}
### Edit a Variant
{/* TODO check for correctness */}
To edit a variant:
1. Go to the product’s details page.
2. Find the variant you want to edit in the Variants section.
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at its right.
4. Choose "Edit variant" from the dropdown.
5. In the drawer that opens, edit the variant’s information.
6. Once you’re done, click on the Confirm button.
### Duplicate a Variant
{/* TODO check for correctness */}
To duplicate a variant:
1. Go to the product’s details page.
2. Find the variant you want to duplicate in the Variants section.
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at its right.
4. Choose "Duplicate variant" from the dropdown.
5. This opens a new form with almost all fields filled except for the selected Options.
6. Once you’re done, click on the Save button.
### Delete a Variant
{/* TODO check for correctness */}
<Note type="warning">
Deleting a variant is irreversible.
</Note>
To delete a variant:
1. Go to the product’s details page.
2. Find the variant you want to duplicate in the Variants section.
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at its right.
4. Choose "Delete variant" from the dropdown.
---
## Edit Product Variant Prices
{/* TODO check for correctness */}
The prices bulk editor allows you to edit the prices of a product's variants using a spreadsheet interface.
To open the prices bulk editor:
1. Go to the product's details page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Variants section.
3. Choose "Edit prices" from the dropdown.
This opens the prices bulk editor. Refer to the [Bulk Editor](../../tips/bulk-editor/page.mdx) guide to learn tips about how to use the bulk editor.
Once you're done making changes:
1. Save your changes by clicking the Save button.
2. In the pop-up that opens:
- If you made edits to a value in a currency or region that's now hidden, you'll be shown the option to save all changes or just save the changes made in the currently visible currencies and regions. Choose one of the options then click the "Save changes" button.
- Otherwise, you can directly click the "Save changes" button.
To discard the changes you made:
1. Either press <Kbd>esc</Kbd> or click the <InlineIcon Icon={XMark} alt="X" /> icon at the top left.
2. Confirm discarding the changes by clicking the “Yes, close” button in the pop-up.
---
## Edit Sales Channel Availability
{/* TODO check for correctness */}
To edit the product's availability in sales channels:
1. Go to the product’s details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the top right of the Sales Channels section.
3. Choose Edit from the dropdown.
4. In the form that opens, check or uncheck the sales channels to add or remove availability.
5. Once you're done, click the Save button.
---
## Edit Product Organization
{/* TODO check for correctness */}
To edit the product's organization details:
1. Go to the product’s details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the top right of the Organization section.
3. Choose Edit from the dropdown.
4. In the drawer that opens, edit the types, collections, categories, and tags that the product belongs to.
4. Once you're done, click the Save button.
---
## Edit a Product’s Attributes
{/* TODO check for correctness */}
To edit a product’s attributes:
1. Go to the product’s details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon in the top right of the Attributes section.
3. Choose "Edit attributes" from the dropdown.
4. In the drawer that opens, edit the attribute information of the product.
5. Once you’re done, click on the Save button.
---
## Duplicate a Product
{/* TODO check if feature is still available */}
To duplicate a product:
1. Go to the Products page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon next to the product you want to duplicate.
3. Choose Duplicate from the dropdown.
This creates a product with the same information as the original but as a draft.
---
## Delete a Product
{/* TODO check info for correctness */}
<Note type="warning">
Deleting a product is irreversible.
</Note>
To delete a product:
1. Go to the Products page.
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon next to the product you want to delete.
3. Choose Delete from the dropdown.
4. Confirm deleting the product by clicking the “Yes, confirm” button in the pop-up.

44
www/apps/user-guide/app/products/page.mdx
View File

@@ -1,38 +1,38 @@
---
sidebar_autogenerate_exclude: true
---
export const metadata = {
title: `Products`,
title: `Products Overview`,
}
# {metadata.title}
In this document, you’ll get an overview of the product listing page.
The Products domain is where you manage all your products, their variants, and the different ways to organize them, such as categories and collections.
## Overview
You can view the list of available products in your commerce store by clicking on Products from the sidebar menu.
The Products page shows all your products and allows you to view their details.
In the list, you can see product details such as the title, collection, status, and more. You can also search, filter, and sort the products to find the specific order you are looking for.
The Products domain also contains the following sub-sections:
<Note title="Tip">
- Collections and Categories for better product organization.
- Gift Cards to manage gift-card products associated with a specific customer.
Find tips to use lists effectively in [this guide](../tips/lists/page.mdx).
</Note>
![Product List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.35_PM_ecyltl.png)
---
## View List of Products
## Manage Products
View the list of available products in your ecommerce store by clicking on Products from the sidebar menu.
In the list, find product details such as the name, collection, status, and more.
---
## Learn More About Products
- [Manage Products](./manage/page.mdx)
- [Create Product](./create/page.mdx)
- [Edit Product](./edit/page.mdx)
- [Manage Variants](./variants/page.mdx)
- [Manage Categories](./categories/page.mdx)
- [Manage Collections](./collections/page.mdx)
- [Export Products](./export/page.mdx)
- [Import Products](./import/page.mdx)
- [Import Products](./import/page.mdx)
You can also manage other product-related data under Settings:
{/* TODO add links */}
- [Manage Product Tags](#)
- [Manage Product Types](#)

162
www/apps/user-guide/app/products/variants/page.mdx Normal file
View File

@@ -0,0 +1,162 @@
---
sidebar_position: 3
---
import { EllipsisVertical, TaxExclusive, TaxInclusive, ArrowUpRightOnBox } from "@medusajs/icons"
export const metadata = {
title: `Manage Product Variants`,
}
# {metadata.title}
In this guide, you'll learn how to manage the variants of a product.
## View Product Variants
To view the variants of a product:
1. Go to the Products page from the sidebar.
2. Select a product from the list to open its details page.
3. In the Variants section, you can see the list of variants for the product. You can search and filter them.
If you click on a variant, you can see its details in a separate page.
![Product Variant Details](https://res.cloudinary.com/dza7lstvk/image/upload/v1739813067/User%20Guide/Screenshot_2025-02-17_at_7.24.04_PM_deaj7w.png)
---
## Create Product Variant
You can only create a product variant if there are option combinations that aren't created as a variant yet. For example, if you [created a new option](../edit/page.mdx#create-options) or deleted an existing variant, you can create a new variant.
To create a product variant:
<Note title="Tip">
You can create a variant to be multi-part or a bundle, as explained in [this guide](../create/page.mdx#types-of-products-to-create).
</Note>
1. Click the "Create" button at the top right of the Variants section.
2. In the form that opens, there are two steps:
1. Details step:
- Enter the variant's title and optionally SKU.
- For each option, such as Color and Size, choose the variant's value.
- Enable the "Manage Inventory" toggle if you want Medusa to track the inventory of this variant. If disabled, the variant is always considered in stock.
- Enable "Allow backorders" if you want to allow customers to purchase the variant even if it's out of stock.
- Enable "Has inventory kit" if you want to add multi-part or bundled products. This will show a third step "Inventory Kits" after the Prices step.
2. Prices step: Use the [Bulk Editor](../../tips/bulk-editor/page.mdx) to set the variant's prices for each currency and region in your store.
3. Inventory Kits step (optional): If you enabled "Has inventory kit", you can add the parts of the kit in this step.
- Choose an existing inventory item to be part of the kit.
- Enter the quantity required for a single item of the variant. For example, if the variant is a bicycle and the inventory item is a wheel, you can enter `2` in the Quantity field to indicate that the variant requires two wheels.
- To add more inventory items, click the "Add" button.
3. Once you're done, click the "Save" button.
<Note title="Tips">
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx) or [region's](../../settings/regions/page.mdx) settings.
</Note>
---
## Edit Product Variant Details
To edit a product variant's general details:
1. Go to its product's details page.
2. In the Variants section, click on the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> at the variant's right.
3. Choose "Edit" from the dropdown.
4. In the side window that opens:
- You can edit the variant's title, materials, option values (such as color or size), SKU, EAN, UPC, and barcode.
- You can modify managing inventory, enabling or disabling managing inventory quantity in different locations.
- You can modify allowing backorders, enabling or disabling customers from purchasing the variant even if it's out of stock.
- You can edit the variant's attributes, including the variant's weight, height, width, length, MID code, HS code, and country of origin.
5. Once you're done, click the "Save" button.
---
## Edit Product Variant Prices
To edit the prices of product variants:
1. Go to its product's details page.
2. Click on the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> at the top right of the section.
3. Choose "Edit Prices" from the dropdown.
4. In the [bulk editor](../../tips/bulk-editor/page.mdx), you can edit the price of each variant for the currencies and regions in your store.
5. Once you're done, click the "Save" button.
<Note title="Tips">
- Price columns that have the <InlineIcon Icon={TaxExclusive} alt="tax-exclusive" /> icon are tax-exclusive prices. Medusa will calculate taxes during checkout and add them to this price.
- Price columns that have the <InlineIcon Icon={TaxInclusive} alt="tax-inclusive" /> icon are tax-inclusive prices. Medusa will calculate taxes during checkout as part of this price.
Tax-inclusive pricing is configured in the [currency's](../../settings/store/page.mdx) or [region's](../../settings/regions/page.mdx) settings.
</Note>
---
## Manage Product Variant Inventory
There are many ways to manage the inventory of a product variant. From the product's details page, you can manage the inventory of its variants using the [bulk editor](../../tips/bulk-editor/page.mdx), providing you with an intuitive interface.
![Product Variant Inventory Bulk Editor](https://res.cloudinary.com/dza7lstvk/image/upload/v1739813716/User%20Guide/Screenshot_2025-02-17_at_7.35.03_PM_esoybv.png)
To manage the inventory of a product's variants:
1. Go to its product's details page.
2. Click on the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> at the top right of the section.
3. Choose "Edit stock levels" from the dropdown.
4. In the bulk editor, the rows are the inventory item(s) of each product variant, and the columns are inventory-related fields to edit, such as SKU and quantity in each stock location.
5. Once you're done, click the "Save" button.
---
## Manage Product Variant Metadata
Metadata is custom data that can be associated with the product variant in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the variant.
To manage the metadata of a product variant:
1. Go to its product's details page.
2. In the Variants section, click on a variant to go to its details page.
3. Click on the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> at the right of the section.
4. 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 right.
- 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 right.
- Choose "Delete row" from the dropdown.
5. Once you're done, click the Save button.
---
## Product Variant JSON Section
The JSON section is useful for developers to view the raw product variant data in JSON structure. Developers can use this section to debug and troubleshoot issues related to the variant.
To view the JSON structure, click on the <InlineIcon Icon={ArrowUpRightOnBox} alt="Expand" /> icon.
---
## Delete Product Variant
<Note type="warning">
Deleting a product variant is irreversible.
</Note>
To delete a product variant:
1. Go to its product's details page.
2. In the Variants section, click on the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> at the variant's right.
3. Choose "Delete" from the dropdown.
4. Confirm the action by clicking the "Delete" button in the pop-up.

21
www/apps/user-guide/generated/edit-dates.mjs
View File

@@ -8,7 +8,7 @@ export const generatedEditDates = {
"app/settings/taxes/tax-rates/page.mdx": "2024-05-03T17:36:38+03:00",
"app/page.mdx": "2025-02-14T11:18:46.636Z",
"app/settings/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/export/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/export/page.mdx": "2025-02-18T12:16:52.639Z",
"app/settings/return-reasons/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/shipping-options/page.mdx": "2024-05-03T17:36:38+03:00",
@@ -20,23 +20,19 @@ export const generatedEditDates = {
"app/settings/profile/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/countries/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/store/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/gift-cards/product-gift-card/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/import/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/import/page.mdx": "2025-02-18T12:15:03.830Z",
"app/pricing/create/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/providers/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/locations/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/api-key-management/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/categories/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/categories/page.mdx": "2025-02-18T12:12:53.460Z",
"app/inventory/reservations/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/api-key-management/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/gift-cards/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/gift-cards/customer-gift-card/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/discounts/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/_import/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/page.mdx": "2025-02-18T12:24:19.794Z",
"app/settings/sales-channels/products/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00",
"app/inventory/inventory/page.mdx": "2024-05-03T17:36:38+03:00",
@@ -49,10 +45,15 @@ export const generatedEditDates = {
"app/orders/fulfillments/page.mdx": "2025-02-17T15:12:20.431Z",
"app/customers/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z",
"app/products/collections/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/collections/page.mdx": "2025-02-18T12:07:53.371Z",
"app/customers/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z",
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/exchanges/page.mdx": "2025-02-17T15:14:13.676Z"
"app/orders/exchanges/page.mdx": "2025-02-17T15:14:13.676Z",
"app/products/create/page.mdx": "2025-02-18T12:17:14.624Z",
"app/products/edit/page.mdx": "2025-02-17T17:13:29.141Z",
"app/products/variants/page.mdx": "2025-02-18T12:10:36.029Z",
"app/products/create/bundle/page.mdx": "2025-02-18T12:17:32.166Z",
"app/products/create/multi-part/page.mdx": "2025-02-18T12:17:29.629Z"
}

86
www/apps/user-guide/generated/sidebar.mjs
View File

@@ -122,64 +122,38 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "category",
"path": "/products",
"title": "Products",
"autogenerate_path": "/products",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/manage",
"title": "Manage Products",
"description": "",
"title": "Overview",
"path": "/products",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/collections",
"title": "Manage Product Collections",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/categories",
"title": "Manage Product Categories",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/gift-cards",
"title": "Gift Cards",
"description": "",
"title": "Create Product",
"path": "/products/create",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/gift-cards/product-gift-card",
"title": "Manage a Product Gift Card",
"description": "",
"children": [],
"sidebar_position": 1
"title": "Multi-Part Product",
"path": "/products/create/multi-part",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/gift-cards/customer-gift-card",
"title": "Manage a Customer Gift Card",
"description": "",
"children": [],
"sidebar_position": 2
"title": "Bundle Product",
"path": "/products/create/bundle",
"children": []
}
]
},
@@ -187,18 +161,48 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/import",
"title": "Import Products",
"description": "",
"title": "Edit Product",
"path": "/products/edit",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Manage Variants",
"path": "/proucts/variants",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Manage Collections",
"path": "/products/collections",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Categories",
"path": "/products/categories",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Import Products",
"path": "/products/import",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/products/export",
"title": "Export Products",
"description": "",
"path": "/products/export",
"children": []
}
]

56
www/apps/user-guide/sidebar.mjs
View File

@@ -65,9 +65,61 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
{
type: "category",
path: "/products",
title: "Products",
autogenerate_path: "/products",
children: [
{
type: "link",
title: "Overview",
path: "/products",
},
{
type: "link",
title: "Create Product",
path: "/products/create",
children: [
{
type: "link",
title: "Multi-Part Product",
path: "/products/create/multi-part",
},
{
type: "link",
title: "Bundle Product",
path: "/products/create/bundle",
},
],
},
{
type: "link",
title: "Edit Product",
path: "/products/edit",
},
{
type: "link",
title: "Manage Variants",
path: "/proucts/variants",
},
{
type: "link",
title: "Manage Collections",
path: "/products/collections",
},
{
type: "link",
title: "Categories",
path: "/products/categories",
},
{
type: "link",
title: "Import Products",
path: "/products/import",
},
{
type: "link",
title: "Export Products",
path: "/products/export",
},
],
},
{
type: "category",