diff --git a/www/apps/resources/app/commerce-modules/order/edit/page.mdx b/www/apps/resources/app/commerce-modules/order/edit/page.mdx index 1acf6f8837..bd5f77bba1 100644 --- a/www/apps/resources/app/commerce-modules/order/edit/page.mdx +++ b/www/apps/resources/app/commerce-modules/order/edit/page.mdx @@ -4,7 +4,7 @@ export const metadata = { # {metadata.title} -In this document, you'll learn about order edits. +In this guide, you'll learn about order edits. @@ -14,23 +14,23 @@ Refer to this [Medusa Admin User Guide](!user-guide!/orders/edit) to learn how t ## What is an Order Edit? -A merchant can edit an order to add new items or change the quantity of existing items in the order. +A merchant can edit an order to add new items or change the quantity of existing items. An order edit is represented by the [OrderChange data model](/references/order/models/OrderChange). -The `OrderChange` data model is associated with any type of change, including a return or exchange. However, its `change_type` property distinguishes the type of change it's making. +The `OrderChange` data model is associated with any type of change, including returns or exchanges. However, its `change_type` property distinguishes the type of change being made. -In the case of an order edit, the `OrderChange`'s type is `edit`. +For order edits, the `OrderChange`'s `change_type` is `edit`. --- ## Add Items in an Order Edit -When the merchant adds new items to the order in the order edit, the item is added as an [OrderItem](/references/order/models/OrderItem). +When a merchant adds new items to an order during editing, the item is added as an [OrderItem](/references/order/models/OrderItem). -Also, an `OrderChangeAction` is created. The [OrderChangeAction data model](/references/order/models/OrderChangeAction) represents a change made by an `OrderChange`, such as an item added. +Additionally, an `OrderChangeAction` is created. The [OrderChangeAction data model](/references/order/models/OrderChangeAction) represents a change made by an `OrderChange`, such as adding an item. -So, when an item is added, an `OrderChangeAction` is created with the type `ITEM_ADD`. In its `details` property, the item's ID, price, and quantity are stored. +When an item is added, an `OrderChangeAction` is created with the type `ITEM_ADD`. Its `details` property stores the item's ID, price, and quantity. --- @@ -38,7 +38,7 @@ So, when an item is added, an `OrderChangeAction` is created with the type `ITEM A merchant can update an existing item's quantity or price. -This change is added as an `OrderChangeAction` with the type `ITEM_UPDATE`. In its `details` property, the item's ID, new price, and new quantity are stored. +This change is recorded as an `OrderChangeAction` with the type `ITEM_UPDATE`. Its `details` property stores the item's ID, updated price, and updated quantity. --- @@ -46,18 +46,18 @@ This change is added as an `OrderChangeAction` with the type `ITEM_UPDATE`. In i Adding new items to the order requires adding shipping methods for those items. -These shipping methods are represented by the [OrderShippingMethod data model](/references/order/models/OrderItem). Also, an `OrderChangeAction` is created with the type `SHIPPING_ADD` +These shipping methods are represented by the [OrderShippingMethod data model](/references/order/models/OrderShippingMethod). Also, an `OrderChangeAction` is created with the type `SHIPPING_ADD`. --- ## How Order Edits Impact an Order’s Version -When an order edit is confirmed, the order’s version is incremented. +When an order edit is confirmed, the order’s [version](../order-versioning/page.mdx) is incremented. --- ## Payments and Refunds for Order Edit Changes -Once the Order Edit is confirmed, any additional payment or refund required can be made on the original order. +Once the order edit is confirmed, any additional payment or refund required can be made on the original order. -This is determined by the comparison between the `OrderSummary` and the order's transactions, as mentioned in [this guide](../transactions/page.mdx#checking-outstanding-amount). +This is determined by the comparison between the `OrderSummary` and the order's transactions, as mentioned in the [Transactions guide](../transactions/page.mdx#checking-outstanding-amount). diff --git a/www/apps/resources/app/commerce-modules/order/exchange/page.mdx b/www/apps/resources/app/commerce-modules/order/exchange/page.mdx index 34c233a275..bccade105f 100644 --- a/www/apps/resources/app/commerce-modules/order/exchange/page.mdx +++ b/www/apps/resources/app/commerce-modules/order/exchange/page.mdx @@ -6,7 +6,7 @@ export const metadata = { # {metadata.title} -In this document, you’ll learn about order exchanges. +In this guide, you’ll learn about order exchanges. @@ -16,9 +16,9 @@ Refer to this [Medusa Admin User Guide](!user-guide!/orders/exchanges) to learn ## What is an Exchange? -An exchange is the replacement of an item that the customer ordered with another. +An exchange is the replacement of an item that the customer ordered with another item. -A merchant creates the exchange, specifying the items to be replaced and the new items to be sent. +A merchant creates the exchange, specifying which items to return and which new items to send. The [OrderExchange data model](/references/order/models/OrderExchange) represents an exchange. @@ -26,15 +26,15 @@ The [OrderExchange data model](/references/order/models/OrderExchange) represent ## Returned and New Items -When the exchange is created, a return, represented by the [Return data model](/references/order/models/Return), is created to handle receiving the items back from the customer. +When an exchange is created, a return, represented by the [Return data model](/references/order/models/Return), is also created to handle receiving the items back from the customer. -Learn more about returns in [this guide](../return/page.mdx). +Refer to the [Returns guide](../return/page.mdx) to learn more about returns and how they work. -The [OrderExchangeItem data model](/references/order/models/OrderExchangeItem) represents the new items to be sent to the customer. +The [OrderExchangeItem data model](/references/order/models/OrderExchangeItem) represents the new items to be sent to the customer. It's associated with the `OrderExchange` data model. --- @@ -42,19 +42,23 @@ The [OrderExchangeItem data model](/references/order/models/OrderExchangeItem) r An exchange has shipping methods used to send the new items to the customer. They’re represented by the [OrderShippingMethod data model](/references/order/models/OrderShippingMethod). -The shipping methods for the returned items are associated with the exchange's return, as explained in [this guide](../return/page.mdx#return-shipping-methods). +The shipping methods for the returned items are associated with the exchange's return, as explained in the [Returns guide](../return/page.mdx#return-shipping-methods). --- ## Exchange Payment -The `Exchange` data model has a `difference_due` property that stores the outstanding amount. +The `OrderExchange` data model has a `difference_due` property that stores the outstanding amount. - Condition - Result + + Condition + + + Result + @@ -66,7 +70,7 @@ The `Exchange` data model has a `difference_due` property that stores the outsta - Merchant owes the customer a refund of the `difference_due` amount. + The merchant owes the customer a refund of the `difference_due` amount. @@ -78,7 +82,7 @@ The `Exchange` data model has a `difference_due` property that stores the outsta - Merchant requires additional payment from the customer of the `difference_due` amount. + The merchant requires additional payment from the customer of the `difference_due` amount. @@ -97,10 +101,10 @@ The `Exchange` data model has a `difference_due` property that stores the outsta
-Any payment or refund made is stored in the [Transaction data model](/references/order/models/OrderTransaction). +Any payments or refunds made are stored in the [OrderTransaction data model](/references/order/models/OrderTransaction). --- ## How Exchanges Impact an Order’s Version -When an exchange is confirmed, the order’s version is incremented. +When an exchange is confirmed, the order’s [version](../order-versioning/page.mdx) is incremented. diff --git a/www/apps/resources/app/commerce-modules/promotion/campaign/page.mdx b/www/apps/resources/app/commerce-modules/promotion/campaign/page.mdx index 4d5b92b490..d2962d5069 100644 --- a/www/apps/resources/app/commerce-modules/promotion/campaign/page.mdx +++ b/www/apps/resources/app/commerce-modules/promotion/campaign/page.mdx @@ -4,7 +4,7 @@ export const metadata = { # {metadata.title} -In this document, you'll learn about campaigns. +In this guide, you'll learn what a campaign is and its related concepts. @@ -14,7 +14,9 @@ Refer to this [Medusa Admin User Guide](!user-guide!/promotions/campaigns) to le ## What is a Campaign? -A [Campaign](/references/promotion/models/Campaign) combines promotions under the same conditions, such as start and end dates. +A [Campaign](/references/promotion/models/Campaign) combines [promotions](../concepts/page.mdx#what-is-a-promotion) under the same conditions, such as start and end dates. + +Campaigns are useful for grouping promotions that share the same time frame or target audience. They're also useful for limiting the usage of promotions. ![A diagram showcasing the relation between the Campaign and Promotion data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899225/Medusa%20Resources/campagin-promotion_hh3qsi.jpg) @@ -22,11 +24,21 @@ A [Campaign](/references/promotion/models/Campaign) combines promotions under th ## Campaign Limits -Each campaign has a budget represented by the [CampaignBudget data model](/references/promotion/models/CampaignBudget). The budget limits how many times the promotion can be used. +Each campaign can have a budget represented by the [CampaignBudget data model](/references/promotion/models/CampaignBudget). The budget limits how many times the promotion can be used. There are two types of budgets: -- `spend`: An amount that, when crossed, the promotion becomes unusable. For example, if the amount limit is set to `$100`, and the total amount of usage of this promotion crosses that threshold, the promotion can no longer be applied. -- `usage`: The number of times that a promotion can be used. For example, if the usage limit is set to `10`, the promotion can be used only 10 times by customers. After that, it can no longer be applied. +- `spend`: An amount that, when crossed, the promotion becomes unusable. + - For example, if the amount limit is set to `$100`, and the total amount of usage of this promotion crosses that threshold, the promotion can no longer be applied. +- `usage`: The number of times that a promotion can be used. + - For example, if the usage limit is set to `10`, the promotion can be used only 10 times by customers. After that, it can no longer be applied. ![A diagram showcasing the relation between the Campaign and CampaignBudget data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899463/Medusa%20Resources/campagin-budget_rvqlmi.jpg) + +### How Budgets Limit Promotion Usage + +When a customer tries to use a promotion, Medusa checks whether the campaign has a budget and if the budget limit has been reached. If so, the promotion cannot be applied. + +For example, if a campaign has a budget of type `usage` with a limit of `10`, and the promotion has already been used 10 times, it cannot be applied anymore and is considered expired. + +However, once a promotion is applied to a cart, it remains valid until the order is completed, even if the budget limit is reached in the meantime. This ensures that customers who have already applied the promotion can still benefit from it during checkout. \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/tax/tax-rates-and-rules/page.mdx b/www/apps/resources/app/commerce-modules/tax/tax-rates-and-rules/page.mdx index de6b646273..33263a5a16 100644 --- a/www/apps/resources/app/commerce-modules/tax/tax-rates-and-rules/page.mdx +++ b/www/apps/resources/app/commerce-modules/tax/tax-rates-and-rules/page.mdx @@ -4,7 +4,7 @@ export const metadata = { # {metadata.title} -In this document, you’ll learn about tax rates and rules. +In this guide, you’ll learn about tax rates and rules. @@ -30,13 +30,13 @@ Then, when tax rates are retrieved for a taxable item in the child region, both You can create tax rates that override the default for specific conditions or rules. -For example, you can have a default tax rate is 10%, but for products of type “Shirt” is %15. +For example, you can have a default 10% tax rate, but for products of type “Shirt” it is 15%. A tax region can have multiple tax rates, and each tax rate can have multiple tax rules. The [TaxRateRule data model](/references/tax/models/TaxRateRule) represents a tax rate’s rule. ![A diagram showcasing the relation between TaxRegion, TaxRate, and TaxRateRule](https://res.cloudinary.com/dza7lstvk/image/upload/v1711462167/Medusa%20Resources/tax-rate-rule_enzbp2.jpg) -These two properties of the data model identify the rule’s target: +The following two properties of the data model identify the rule’s target: - `reference`: the name of the table in the database that this rule points to. For example, `product_type`. - `reference_id`: the ID of the data model’s record that this points to. For example, a product type’s ID. diff --git a/www/apps/user-guide/app/customers/groups/page.mdx b/www/apps/user-guide/app/customers/groups/page.mdx index 07bfdfdc19..8332e7bb32 100644 --- a/www/apps/user-guide/app/customers/groups/page.mdx +++ b/www/apps/user-guide/app/customers/groups/page.mdx @@ -63,7 +63,7 @@ This opens the customer group's details page. To edit a customer group: 1. Go to the customer group’s details page. -2. Click on the icon at the top right of the first section. +2. Click on the icon in the first section's header. 3. Click on Edit in the dropdown. 4. In the side window that opens, you can edit the customer group's name. 5. Once you’re done, click on the Save button. @@ -81,7 +81,7 @@ A customer group can have multiple customers. You can add or remove customers fr To add customers to a customer group: 1. Go to the customer group’s details page. -2. In the Customers section, click the Add button at the top right. +2. In the Customers section, click the Add button in the section's header. 3. Check the customers you want to add to the group. 4. Once you're done, click on the Save button. @@ -107,14 +107,14 @@ Metadata is custom data that can be associated with the customer group in key-va To edit the customer group's metadata: 1. Go to the customer group's details page. -2. Click the icon at the right of the "Metadata" section. +2. Click the icon in the "Metadata" section. 3. 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 4. Once you're done, click the Save button. @@ -131,6 +131,6 @@ Deleting a customer group is irreversible. It doesn't delete the customers in th To delete a customer group: 1. Go to the customer group’s details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm deleting the customer group by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/customers/manage/page.mdx b/www/apps/user-guide/app/customers/manage/page.mdx index 3ec0d4f91f..de4b06407d 100644 --- a/www/apps/user-guide/app/customers/manage/page.mdx +++ b/www/apps/user-guide/app/customers/manage/page.mdx @@ -26,7 +26,7 @@ You can create a customer through the Medusa Admin, which is useful if a custome To create a customer from the Medusa Admin: 1. Go to the Customers page. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens, enter the customer's email, and optionally their first and last name, company name, and phone number. 4. Once you're done, click the Create button. @@ -45,7 +45,7 @@ To view a customer’s details: ### Customer Type -At the top right of the first section, you can see a badge with the customer's type: +In the first section's header, you can see a badge with the customer's type: @@ -107,7 +107,7 @@ You can't transfer ownership to a guest customer, and that includes customers yo To transfer a customer's order ownership to another: 1. Go to the customer's details page. -2. In the Orders section, click on the icon on the right of the order. +2. In the Orders section, click on the icon in the order's row. 3. Choose Transfer ownership from the dropdown. 4. In the side window that opens, choose the customer to transfer the order to in the "New owner" field. 5. Once you're done, click the Save button. @@ -159,14 +159,14 @@ Metadata is custom data that can be associated with the customer in key-value pa To edit the customer's metadata: 1. Go to the customer's details page. -2. Click the icon at the right of the "Metadata" section. +2. Click the icon in the "Metadata" section. 3. 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 4. Once you're done, click the Save button. @@ -187,7 +187,7 @@ The Address section and management features are only available after This injec To add an address to a customer: 1. Go to the customer's details page. -2. Click on the "Add" button at the top right of the "Addresses" section. +2. Click on the "Add" button in the "Addresses" section's header. 3. In the form that opens, enter the address details including name, address line, apartment, postal code, city, country, state, company, and phone number. 4. Once you're done, click the Save button. @@ -205,7 +205,7 @@ To delete a customer address: 1. Go to the customer's details page. 2. Find the address in the "Addresses" section. -3. Click on the icon at the right of the address. +3. Click on the icon in its row. 4. Choose Delete from the dropdown. 5. In the pop-up, enter the address name and click the "Delete" button. @@ -222,6 +222,6 @@ Deleting a customer is irreversible. To delete a customer: 1. Go to the customer's details page. -2. Click on the icon at the top right of the first section. +2. Click on the icon in the first section's header. 3. Choose Delete from the dropdown. 4. In the pop-up, enter the customer's email and click the "Delete" button. diff --git a/www/apps/user-guide/app/inventory/inventory/page.mdx b/www/apps/user-guide/app/inventory/inventory/page.mdx index c07a46e5c5..56c250a62b 100644 --- a/www/apps/user-guide/app/inventory/inventory/page.mdx +++ b/www/apps/user-guide/app/inventory/inventory/page.mdx @@ -29,7 +29,7 @@ This guide covers how to manage inventory items in the Inventory domain of the M To create an inventory item: 1. Go to the Inventory page from the sidebar. -2. Click on the Create button at the top right. +2. Click on the Create button in the main section's header. 3. The form that opens has two steps: 1. Details step: - Enter the inventory item's title and SKU in their respective fields. @@ -61,7 +61,7 @@ To view an inventory item's details: To edit an inventory item's details: 1. Go to the inventory item's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose "Edit" from the dropdown. 4. In the side window that opens, you can edit the inventory's title and SKU. 5. Once you're done, click the Save button. @@ -75,7 +75,7 @@ To edit an inventory item's details: To edit an inventory item's attributes, such as height and weight: 1. Go to the inventory item's details page. -2. Click the icon at the top right of the "Attributes" section. +2. Click the icon in the "Attributes" section's header. 3. Choose "Edit" from the dropdown. 4. In the side window that opens, you can edit the inventory item's height, width, length, weight, MID code, HS code, and country of origin. 5. Once you're done, click the Save button. @@ -91,14 +91,14 @@ Metadata is custom data that can be associated with the inventory item in key-va To edit the inventory item's metadata: 1. Go to the inventory item's details page. -2. Click the icon at the right of the "Metadata" section. +2. Click the icon in the "Metadata" section. 3. 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 4. Once you're done, click the Save button. @@ -113,7 +113,7 @@ You can manage which locations the inventory item is available in, the quantity To manage the locations that an inventory item is available in: 1. Go to the inventory item's details page. -2. Click the "Manage locations" button at the top right of the "Locations" section. +2. Click the "Manage locations" button in the "Locations" section's header. 3. In the side window that opens, you can check or uncheck any location that the item is available in. 4. Once you're done, click the Save button. @@ -124,7 +124,7 @@ To manage the locations that an inventory item is available in: To manage the in-stock quantity of an inventory item in a location: 1. Go to the inventory item's details page. -2. In the "Locations" section, find the location you want to edit the in-stock quantity in, and click the icon at its right. +2. In the "Locations" section, find the location you want to edit the in-stock quantity in, and click the icon at its end. 3. Choose "Edit" from the dropdown. 4. In the side window that opens, you can edit the inventory item's in-stock quantity in that location. 5. Once you're done, click the Save button. @@ -157,7 +157,7 @@ To create a reservation for an inventory item: To edit a reservation for an inventory item: 1. Go to the inventory item's details page. -2. In the "Reservations" section, find the reservation you want to edit and click the icon at its right. +2. In the "Reservations" section, find the reservation you want to edit and click the icon at its end. 3. Choose "Edit" from the dropdown. 4. In the side window that opens, you can edit the reservation's location, quantity, and description. 5. Once you're done, click the Save button. @@ -175,7 +175,7 @@ Deleting a reservation is irreversible. If you delete a reservation created for To delete a reservation for an inventory item: 1. Go to the inventory item's details page. -2. In the "Reservations" section, find the reservation you want to delete and click the icon at its right. +2. In the "Reservations" section, find the reservation you want to delete and click the icon at its end. 3. Choose "Delete" from the dropdown. 4. Confirm the action by clicking the Delete button in the pop-up. @@ -192,6 +192,6 @@ Deleting an inventory item is irreversible. This may affect the associated varia To delete an inventory item: 1. Go to the Inventory page from the sidebar. -2. Find the inventory item to delete, and click the icon at its right. +2. Find the inventory item to delete, and click the icon in its row. 3. Choose "Delete" from the dropdown. 4. Confirm the action by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/inventory/reservations/page.mdx b/www/apps/user-guide/app/inventory/reservations/page.mdx index 05876cbe65..2721a42a6d 100644 --- a/www/apps/user-guide/app/inventory/reservations/page.mdx +++ b/www/apps/user-guide/app/inventory/reservations/page.mdx @@ -39,7 +39,7 @@ In the list, you can see reservation details such as the SKU and reserved quanti To create a reservation manually: 1. Go to Inventory → Reservations. -2. Click on the Create button at the top right. +2. Click on the Create button in the main section's header. 3. In the form that opens: - For the “Item to reserve” field, enter or choose the SKU of the item you want to create a reservation for. - For the “Location” field, select the location where the reservation is created. @@ -70,7 +70,7 @@ This will open the reservation's details page. To edit a reservation: 1. Go to Inventory → Reservations. -2. Find the reservation you want to edit, and click the icon on its right. +2. Find the reservation you want to edit, and click the icon in its row. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the reservation's location, reserved quantity, and description. 5. Once you’re done, click the Save button. @@ -86,14 +86,14 @@ Metadata is custom data that can be associated with the reservation in key-value To edit the reservation's metadata: 1. Go to the reservation's details page. -2. Click the icon at the right of the "Metadata" section. +2. Click the icon in the "Metadata" section. 3. 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 4. Once you're done, click the Save button. @@ -110,6 +110,6 @@ Deleting a reservation is irreversible. If you delete a reservation created for To delete a reservation: 1. Go to Inventory → Reservations. -2. Find the reservation you want to delete, and click the icon on its right. +2. Find the reservation you want to delete, and click the icon in its row. 3. Choose Delete from the dropdown. 4. Confirm deleting the reservation by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/orders/claims/page.mdx b/www/apps/user-guide/app/orders/claims/page.mdx index 0ee9dfdf10..f84ce2f074 100644 --- a/www/apps/user-guide/app/orders/claims/page.mdx +++ b/www/apps/user-guide/app/orders/claims/page.mdx @@ -42,7 +42,7 @@ You can create an order claim after the order's items have been [delivered](../f To create an order claim: 1. Go to an order’s details page. -2. In the Summary section, click on the icon at the top right. +2. In the Summary section, click on the icon in the section's header. 3. Choose "Create Claim" from the dropdown. 4. In the form that opens: - To add items to be returned: diff --git a/www/apps/user-guide/app/orders/draft-orders/create/page.mdx b/www/apps/user-guide/app/orders/draft-orders/create/page.mdx index 19c9765db8..fe57818c49 100644 --- a/www/apps/user-guide/app/orders/draft-orders/create/page.mdx +++ b/www/apps/user-guide/app/orders/draft-orders/create/page.mdx @@ -39,7 +39,7 @@ You can create the draft order and convert it to a regular order once it is read To create a draft order: 1. Go to Orders -> Drafts. -2. Click on the Create button at the top right. +2. Click on the Create button in the main section's header. 3. In the form that opens, enter the following information: - **Region**: Choose the region for the draft order. This determines the currency and tax rules applied to the order. - **Sales Channel**: Select the sales channel for the draft order. This defines where the order is being placed, affects which inventory items are available, and determines which shipping options are applicable to the order. diff --git a/www/apps/user-guide/app/orders/draft-orders/manage/page.mdx b/www/apps/user-guide/app/orders/draft-orders/manage/page.mdx index 4af2b31649..020ea8b487 100644 --- a/www/apps/user-guide/app/orders/draft-orders/manage/page.mdx +++ b/www/apps/user-guide/app/orders/draft-orders/manage/page.mdx @@ -80,7 +80,7 @@ To view the JSON structure, click the icon at the right. +2. In the first section displaying the order's number and region, click the icon in the draft order's row. 3. Select "Edit sales channel" from the dropdown menu. 4. In the side window that opens, select the new sales channel from the dropdown. 5. Click the Save button. @@ -94,10 +94,10 @@ To edit the sales channel of a draft order: To add, edit, or remove items from a draft order: 1. Go to the draft order's details page. -2. In the Summary section, click on the icon at the right. +2. Click on the icon in the Summary section's header. 3. Select "Edit items" from the dropdown menu. 4. In the form that opens: - - To add an item, click the button at the right of the "Items" section. From the dropdown, you can either choose: + - To add an item, click the button in the "Items" section's header. From the dropdown, you can either choose: - **Add items**: Add existing product variants to the draft order. This will open the product variant selection window. - **Add custom item**: Add a custom item that's only available in this draft order. This will open a form to enter the item's title, price, and quantity. - To edit an existing item, click the button in the item's row. This will allow you to change the item's quantity and price. @@ -115,7 +115,7 @@ The items in the Summary section will be updated accordingly. To add or remove promotions applied to the draft order: 1. Go to the draft order's details page. -2. In the Summary section, click on the icon at the right. +2. Click on the icon in the Summary section's header. 3. Select "Edit promotions" from the dropdown menu. 4. In the side window that opens: - To add a promotion, choose it from the dropdown menu. @@ -142,8 +142,8 @@ To manage the shipping methods of a draft order: - **Custom amount**: (optional) If you want to override the price of the shipping option, you can set a custom amount. - **Items to ship**: This section only shows you which items this shipping option ships. You cannot edit this section. - Once you're done, click the "Add" button. - - To edit the shipping option of a shipping profile, click the icon at the right of the shipping option and choose "Edit shipping option" from the dropdown. You can edit the location, shipping option, and custom amount. - - To remove a shipping option from the draft order, click the icon at the right of the shipping option and choose "Remove shipping option" from the dropdown. + - To edit the shipping option of a shipping profile, click the icon in the shipping option's row and choose "Edit shipping option" from the dropdown. You can edit the location, shipping option, and custom amount. + - To remove a shipping option from the draft order, click the icon in the shipping option's row and choose "Remove shipping option" from the dropdown. 4. Once you're done managing the shipping methods, click the "Save" button. The Shipping section will be updated accordingly. @@ -161,7 +161,7 @@ If you've associated the draft order with a customer in your store, you can tran To transfer the draft order to another customer: 1. Go to the draft order's details page. -2. In the Customer section, click on the icon at the right. +2. Click on the icon in the Customer section's header. 3. Choose "Transfer ownership" from the dropdown menu. 4. In the side window that opens, choose the customer to transfer the draft order to in the "New customer" field. 5. Once you're done, click the "Save" button. @@ -175,7 +175,7 @@ The draft order has an associated email address that is used to send order updat To edit the email address associated with a draft order: 1. Go to the draft order's details page. -2. In the Customer section, click on the icon at the right. +2. Click on the icon in the Customer section's header. 3. Choose "Edit email" from the dropdown menu. 4. In the side window that opens, enter the new email address in the "Email" field. 5. Once you're done, click the "Save" button. @@ -191,7 +191,7 @@ Updates related to the order will be sent to the new email address. To edit the shipping address used for a draft order: 1. Go to the draft order's details page. -2. In the Customer section, click on the icon at the right. +2. Click on the icon in the Customer section's header. 3. Choose "Edit shipping address" from the dropdown menu. 4. In the side window that opens, you can update the shipping address details, including the country, first and last names, company, address lines, city, state, postal code, and phone number. 5. Once you're done, click the "Save" button. @@ -205,7 +205,7 @@ To edit the shipping address used for a draft order: To edit the billing address used for a draft order: 1. Go to the draft order's details page. -2. In the Customer section, click on the icon at the right. +2. Click on the icon in the Customer section's header. 3. Choose "Edit billing address" from the dropdown menu. 4. In the side window that opens, you can update the billing address details, including the country, first and last names, company, address lines, city, state, postal code, and phone number. 5. Once you're done, click the "Save" button. @@ -222,14 +222,14 @@ When the draft order is converted to an order, the metadata will be carried over To edit the draft order's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. @@ -266,5 +266,5 @@ Deleting a draft order is irreversible. To delete a draft order: 1. Go to the draft order's details page. -2. In the first section displaying the order's number and region, click the icon at the right. +2. In the first section displaying the order's number and region, click the icon. 3. Choose "Delete draft order" from the dropdown menu. \ No newline at end of file diff --git a/www/apps/user-guide/app/orders/edit/page.mdx b/www/apps/user-guide/app/orders/edit/page.mdx index 096e13dc45..d72217b471 100644 --- a/www/apps/user-guide/app/orders/edit/page.mdx +++ b/www/apps/user-guide/app/orders/edit/page.mdx @@ -88,7 +88,7 @@ Force-confirming an order edit makes irreversible changes to the order. To force confirm an order edit: 1. Open the order's details page. -2. Click the "Force confirm" button at the bottom right of the "Order edit requested" section. +2. Click the "Force confirm" button at the bottom of the "Order edit requested" section. This applies the changes to the order edit. If there are any additional payments required, you'll have to mark the order as paid or share a payment link manually. @@ -115,6 +115,6 @@ If an order edit request hasn't been confirmed yet, you can cancel it. To cancel an order edit request: 1. Open the order details page. -2. Click the "Cancel" button at the bottom right of the "Order edit requested" section. +2. Click the "Cancel" button at the bottom of the "Order edit requested" section. The order edit will be canceled and the changes won't be saved on the order. The customer also can't confirm the order edit anymore. diff --git a/www/apps/user-guide/app/orders/exchanges/page.mdx b/www/apps/user-guide/app/orders/exchanges/page.mdx index c931a99de5..a981e2f924 100644 --- a/www/apps/user-guide/app/orders/exchanges/page.mdx +++ b/www/apps/user-guide/app/orders/exchanges/page.mdx @@ -36,7 +36,7 @@ You can create an order exchange after the order's items have been [delivered](. To create an order exchange: 1. Go to an order’s details page. -2. In the Summary section, click on the icon at the top right. +2. In the Summary section, click on the icon in the section's header. 3. Choose "Create Exchange" from the dropdown. 4. In the form that opens: - To add items to be returned: diff --git a/www/apps/user-guide/app/orders/fulfillments/page.mdx b/www/apps/user-guide/app/orders/fulfillments/page.mdx index 159d8e322f..7b9735a2fa 100644 --- a/www/apps/user-guide/app/orders/fulfillments/page.mdx +++ b/www/apps/user-guide/app/orders/fulfillments/page.mdx @@ -139,7 +139,7 @@ To add a shipment for a fulfillment: 1. Open the order's details page. 2. Scroll down to the Fulfillment's section. If you have more than one fulfillment, find the fulfillment you're looking for. -3. Click on the "Mark as shipped" button at the bottom right of the section. +3. Click on the "Mark as shipped" button at the bottom of the section. 4. In the form that opens: - To add a tracking number, click on the "Add tracking number" button, then enter a tracking number. - If you don’t want the customer to receive a notification that the fulfillment has been shipped, uncheck the “Send notifications” toggle. @@ -171,7 +171,7 @@ To mark the fulfillment as delivered: 1. Open the order's details page. 2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for. -3. Click on the "Mark as delivered" button at the bottom right of the section. +3. Click on the "Mark as delivered" button at the bottom of the section. 4. Confirm marking the fulfillment as delivered by clicking the "Continue" button in the pop-up ![Mark as Delivered Pop-up](https://res.cloudinary.com/dza7lstvk/image/upload/v1739784298/User%20Guide/Screenshot_2025-02-17_at_11.24.48_AM_dpplxp.png) @@ -194,7 +194,7 @@ To mark the fulfillment as picked up: 1. Open the order's details page. 2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for. -3. Click on the "Mark as picked up" button at the bottom right of the section. +3. Click on the "Mark as picked up" button at the bottom of the section. 4. Confirm marking the fulfillment as picked up by clicking the "Continue" button in the pop-up. ![Mark as Picked Up Pop-up](https://res.cloudinary.com/dza7lstvk/image/upload/v1740486580/User%20Guide/Screenshot_2025-02-25_at_2.28.36_PM_ncci0m.png) @@ -211,7 +211,7 @@ To cancel a fulfillment in an order: 1. Open the order's details page. 2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for. -3. Click on the icon at the top right of the section. +3. Click on the icon in the section's header. 4. Click on Cancel in the dropdown. 5. Confirm canceling the fulfillment by clicking the “Continue" button in the pop-up. diff --git a/www/apps/user-guide/app/orders/manage/page.mdx b/www/apps/user-guide/app/orders/manage/page.mdx index ad24f17e52..be75bd2098 100644 --- a/www/apps/user-guide/app/orders/manage/page.mdx +++ b/www/apps/user-guide/app/orders/manage/page.mdx @@ -104,7 +104,7 @@ To allocate these items manually: To edit the shipping address used for an order: 1. Open the order details page. -2. Click on the icon at the top right of the Customer section. +2. Click on the icon in the Customer section header. 3. Click on "Shipping address" from the dropdown. 4. In the side window that opens, update the address details. 5. Once you’re done, click on the Save button. @@ -118,7 +118,7 @@ To edit the shipping address used for an order: To edit the billing address used for an order: 1. Open the order details page. -2. Click on the icon at the top right of the Customer section. +2. Click on the icon in the Customer section header. 3. Click on "Billing address" from the dropdown. 4. In the side window that opens, update the address details. 5. Once you’re done, click on the Save button. @@ -134,7 +134,7 @@ You can edit the email address of an order to send order-update notifications to To edit the email address associated with an order: 1. Open the order details page. -2. Click on the icon at the top right of the Customer section. +2. Click on the icon in the Customer section header. 3. Click on "Email" from the dropdown. 4. In the side window that opens, edit the email address. 5. Once you’re done, click on the Save button. @@ -158,7 +158,7 @@ When you transfer the ownership of an order, the original customer will receive To transfer the ownership of an order to another customer: 1. Open the order details page. -2. Click on the icon at the top right of the Customer section. +2. Click on the icon in the Customer section header. 3. Click on "Transfer ownership" from the dropdown. 4. In the side window that opens, choose the new customer from the dropdown under the "New owner" section. 5. Once you're done, click on the Save button. @@ -193,7 +193,7 @@ Canceling an order is irreversible. To cancel an order: 1. Open the order details page. -2. In the first section showing the order’s number, click on the at its right. +2. In the first section showing the order’s number, click on the next to it. 3. Click on Cancel from the dropdown. 4. Confirm canceling the order by clicking the “Continue” button in the pop-up. diff --git a/www/apps/user-guide/app/orders/payments/page.mdx b/www/apps/user-guide/app/orders/payments/page.mdx index 72f05806de..2fa66ab570 100644 --- a/www/apps/user-guide/app/orders/payments/page.mdx +++ b/www/apps/user-guide/app/orders/payments/page.mdx @@ -107,7 +107,7 @@ To refund an order’s negative outstanding amount: 1. Open the order's details page. 2. Scroll to the Payment section. -3. Click on the icon at the right of the payment to refund. +3. Click on the icon at the end of the payment to refund. 4. Choose "Refund" from the dropdown. 5. In the side window that opens, fill out the following fields: - **Select payment to refund**: Choose the payment to refund an amount from. diff --git a/www/apps/user-guide/app/orders/returns/page.mdx b/www/apps/user-guide/app/orders/returns/page.mdx index ed815a5208..fc21b0a7d0 100644 --- a/www/apps/user-guide/app/orders/returns/page.mdx +++ b/www/apps/user-guide/app/orders/returns/page.mdx @@ -57,7 +57,7 @@ You can create a return from the Medusa Admin for [delivered items](../fulfillme To create a return for an order: 1. Open the order details page. -2. In the Summary section, click on the icon at the top right. +2. In the Summary section, click on the icon in the section's header. 3. Choose "Create Return" from the dropdown. 4. In the form that opens: - To add items to return: diff --git a/www/apps/user-guide/app/page.mdx b/www/apps/user-guide/app/page.mdx index 94b6c55f79..c75f3a4e84 100644 --- a/www/apps/user-guide/app/page.mdx +++ b/www/apps/user-guide/app/page.mdx @@ -6,19 +6,19 @@ export const metadata = { # {metadata.title} -Welcome to the Medusa Admin user guide. This user guide is intended to help admin users learn how they can use the Medusa Admin to perform commerce operations and manage their store. +Welcome to the Medusa Admin user guide. This guide is intended to help admin users and merchants learn how to use the Medusa Admin to perform commerce operations and manage their store. ![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.35_PM_ecyltl.png) ## Who is this guide for? -This guide is for Medusa Admin users looking to master the Medusa Admin and manage their store effectively. You don't need any technical knowledge to follow these guides. +This guide is for Medusa Admin users looking to master the Medusa Admin and manage their store effectively. You don't need any technical knowledge to follow this guide. -You can also follow these guides if you're exploring Medusa and its operational features. +You can also follow this guide if you're exploring Medusa and its operational features. -For technical users, learn how to build and customize Medusa in [this documentation](!docs!/learn). +For technical users, learn how to build and customize Medusa in the [Get Started](!docs!/learn) section of the documentation. @@ -32,65 +32,65 @@ You must use your user’s email and password to log in. If you’re unsure what -Refer to [this documentation](!resources!/medusa-cli#user) on how to create a user. +Refer to the [Medusa CLI](!resources!/medusa-cli#user) reference to learn how to create a user. ## Tour of Medusa Admin -After you log into your Medusa Admin, you see a sidebar menu to the left with a search bar at its top, a at the top right, and in the middle the content of the page you’re currently on. +After you log into your Medusa Admin, you'll see a navigation sidebar with a search bar at the top, a notifications icon in the header, and the main content area in the center. ### Sidebar Menu -The sidebar menu includes the main navigation of your Medusa Admin. You can use it to navigate between different pages, such as Products or Orders pages. +The sidebar menu includes the main navigation of your Medusa Admin. You can use it to navigate between different domains, such as the Products or Orders pages. ![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529281/User%20Guide/Screenshot_2025-02-14_at_12.34.22_PM_oeyaol.png) -You can hide the sidebar by clicking the icon at the top next to the sidebar. Clicking it again shows the sidebar. +You can hide the sidebar by clicking the icon at the top next to the sidebar. Clicking it again will show the sidebar. ### Sidebar Shortcuts -Sidebar items have shortcuts. For example, the Products page has a G then P shortcut. To view the shortcut of an item, hover your mouse for a few seconds and a tooltip will appear with the shortcut. +Sidebar items have shortcuts. For example, the Products page has a G then P shortcut. To view the shortcut of an item, hover your mouse over it for a few seconds and a tooltip will appear with the shortcut. ![Sidebar Shortcuts](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530172/User%20Guide/Screenshot_2025-02-14_at_12.48.19_PM_moyjtv.png) -You can also find all shortcuts by clicking on your profile item at the bottom of the sidebar and choosing "Shortcuts". +You can also find all shortcuts by clicking on your profile item at the bottom of the sidebar and selecting "Shortcuts". ### Settings and Quick Actions -At the bottom of the sidebar you'll find a Settings item, which takes you to further settings of your store such as Region and Sales Channel management. You'll also find your avatar and name. +At the bottom of the sidebar, you'll find a Settings item, which takes you to additional settings for your store such as Region and Sales Channel management. You'll also find your avatar and name. ![Settings and profile](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530277/User%20Guide/Screenshot_2025-02-14_at_12.51.06_PM_lq0ehf.png) -By clicking on your avatar and name, you'll view quick actions such as going to profile settings, view shortcuts, or changing the admin theme. +By clicking on your avatar and name, you'll see quick actions such as accessing profile settings, viewing shortcuts, or changing the admin theme. ![Profile Quick Actions](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530277/User%20Guide/Screenshot_2025-02-14_at_12.50.50_PM_qqmw54.png) ### Search Bar -At the top of the sidebar, you'll find a search item. You can also open the search window using the shortcuts: +At the top of the sidebar, you'll find a search item that opens the search window. You can also open the search window using these keyboard shortcuts: - Windows and Linux: CTRL + K - Mac OS: ⌘ + K ![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529553/User%20Guide/Screenshot_2025-02-14_at_12.36.53_PM_vps6cm.png) -You can select a result with your mouse, or use the up and down arrows on your keyboard to navigate between the results, then choose a result by hitting the Enter key. +You can select a result with your mouse, or use the up and down arrow keys on your keyboard to navigate between the results, then choose a result by pressing the Enter key. ### Check Notifications -At the top right you’ll find a icon. Clicking this icon opens a side window to view any notifications you might have. Use this to view notifications such as completed product exports. +At the top end of the header, you'll find a icon. Clicking this icon opens a side window to view any notifications you might have. Use this to view notifications such as completed product exports. ![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529955/User%20Guide/Screenshot_2025-02-14_at_12.45.44_PM_ljdvof.png) ### Change Language -The Medusa Admin supports multiple-languages, with English being the default one. Check out available languages [here](./tips/languages/page.mdx). +The Medusa Admin supports multiple languages, with English being the default. Check out available languages in the [Languages](./tips/languages/page.mdx) guide. -Learn how to change the language in [this guide](./settings/profile/page.mdx#change-admin-language). +Learn how to change the language in the [Profile Settings](./settings/profile/page.mdx#change-admin-language) guide. ### Change Admin Theme -The Medusa Admin comes in light and dark themes. You can change the theme by clicking the profile item at the bottom of the sidebar -> Theme -> Light, Dark, or System, defaulting to your Operating System or Browser theme. +The Medusa Admin comes with light and dark themes. You can change the theme by clicking the profile item at the bottom of the sidebar → Theme → Light, Dark, or System, which defaults to your Operating System or Browser theme. ![Dark Theme](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.56_PM_fdcgmz.png) diff --git a/www/apps/user-guide/app/price-lists/create/page.mdx b/www/apps/user-guide/app/price-lists/create/page.mdx index 6efebb34b0..90bc408ef4 100644 --- a/www/apps/user-guide/app/price-lists/create/page.mdx +++ b/www/apps/user-guide/app/price-lists/create/page.mdx @@ -21,7 +21,7 @@ In this guide, you’ll learn how to create a price list. To create a price list: 1. Go to Price Lists from the sidebar. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. This will open the form to create a price, which is made up of three steps: Details, Products, and Prices. diff --git a/www/apps/user-guide/app/price-lists/manage/page.mdx b/www/apps/user-guide/app/price-lists/manage/page.mdx index 9150aca65d..50c01f72f7 100644 --- a/www/apps/user-guide/app/price-lists/manage/page.mdx +++ b/www/apps/user-guide/app/price-lists/manage/page.mdx @@ -32,7 +32,7 @@ This will open the price list's details page. ### Price List Status -At the top right of the first section, you'll find the price list's status. It can be one of the following: +In the first section's header, you'll find the price list's status. It can be one of the following:
@@ -74,7 +74,7 @@ To edit a price list's start and expiry dates, or customer availability, refer t 1. Go to the price list's details page. -2. Click on the icon at the top right of the first section. +2. Click on the 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. @@ -89,7 +89,7 @@ To edit a price list's start and expiry dates, or customer availability, refer t 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 icon at the top right of the "Configuration" section. +2. Click the 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. @@ -155,6 +155,6 @@ Deleting a price list is irreversible. To delete a price list: 1. Go to the price list's details page. -2. Click on the icon at the top right of the first section. +2. Click on the 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. diff --git a/www/apps/user-guide/app/products/categories/page.mdx b/www/apps/user-guide/app/products/categories/page.mdx index 2d3bdd921a..d6e54ab8cb 100644 --- a/www/apps/user-guide/app/products/categories/page.mdx +++ b/www/apps/user-guide/app/products/categories/page.mdx @@ -39,7 +39,7 @@ To view all product categories, go to the Product → Categories page. From here 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 in the main section's header. 3. In the form that opens, there are two steps: 1. Details Step: 1. Enter the category's name in the Title field. This is the only required field. @@ -50,7 +50,7 @@ To create a product category: 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 icon to drag categories to their correct position. - - To nest the category, drag it under another category and move it slightly to the right. + - To nest the category, drag it under another category and move it slightly to the side. 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) @@ -68,12 +68,12 @@ To view a category's details: ### Product Category Status and Visibility -At the top right of the first section, you'll find two badges: +In the first section's header, you'll find two badges: -- The first from the left is the category's status: +- The first badge shows the category's status: - **Active**: The category is active and shown on the storefront. - **Inactive**: The category is inactive and not shown on the storefront. -- The second from the left is the category's visibility: +- The second badge shows the category's visibility: - **Public**: The category is visible to customers on the storefront. - **Private**: The category is not visible to customers on the storefront. It's only used by admin users. @@ -101,14 +101,14 @@ Metadata is custom data that can be associated with the product category in key- To edit the product category's metadata: 1. Go to the product category's details page. -2. Click the icon at the right of the "Metadata" section. +2. Click the icon in the "Metadata" section. 3. 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 4. Once you're done, click the Save button. @@ -152,7 +152,7 @@ To change the categories' ranking and hierarchy: 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 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. + - To nest a category in another, drag it under the other category and move it slightly to the side. 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) @@ -168,6 +168,6 @@ Deleting a category is irreversible. 1. Go to the Product → Categories page. -2. Click the icon at the right of the category to delete. +2. Click the icon in the category's row. 3. Choose Delete from the dropdown. 4. Confirm deleting the category by clicking the "Delete" button in the pop-up. diff --git a/www/apps/user-guide/app/products/collections/page.mdx b/www/apps/user-guide/app/products/collections/page.mdx index 7c4270dd95..4cee0c7bde 100644 --- a/www/apps/user-guide/app/products/collections/page.mdx +++ b/www/apps/user-guide/app/products/collections/page.mdx @@ -37,7 +37,7 @@ To view all product collections, go to the Products → Collections page. From h To create a collection: 1. Go to the Products → Collections page. -2. Click on the Create button at the top right. +2. Click on the Create button in the main section's header. 3. In the form that opens: 1. Enter the collection's name in the Title field. 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. @@ -63,7 +63,7 @@ To view a collection's details: To edit a collection: 1. Go to the collection's details page. -2. Click on the icon at the top right of the first section. +2. Click on the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the collection's title and handle. 5. Once done, click the Save button. @@ -79,14 +79,14 @@ Metadata is custom data that can be associated with the product collection in ke To edit the product collection's metadata: 1. Go to the product collection's details page. -2. Click the icon at the right of the "Metadata" section. +2. Click the icon in the "Metadata" section. 3. 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 4. Once you're done, click the Save button. @@ -101,7 +101,7 @@ From the product collection's details page, you can manage the products in the c To add products to a collection: 1. Go to the collection's details page. -2. In the Products section, click on the icon at the top right. +2. In the Products section, click on the icon in the section's header. 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. @@ -114,7 +114,7 @@ To remove a product from a collection: 1. Go to the collection's details page. 2. In the Products section, find the product you want to remove from the collection. -3. Click the icon at the right of the product. +3. Click the icon in the product's row. 4. Choose Remove from the dropdown. 5. Confirm removing the product by clicking the “Remove" button in the pop-up. @@ -131,6 +131,6 @@ Deleting a collection is irreversible. To delete a collection: 1. Go to the collection's details page. -2. Click on the icon at the top right of the first section. +2. Click on the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm deleting the collection by clicking the “Confirm" button in the pop-up. diff --git a/www/apps/user-guide/app/products/create/page.mdx b/www/apps/user-guide/app/products/create/page.mdx index 9f0eb02863..20c38a0ac3 100644 --- a/www/apps/user-guide/app/products/create/page.mdx +++ b/www/apps/user-guide/app/products/create/page.mdx @@ -36,7 +36,7 @@ This guide covers the general steps to create any of these products. You can als To create a new product: 1. Go to the Products page from the sidebar. -2. Click on the Create button at the top right. +2. Click on the Create button in the main section's header. 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). @@ -49,7 +49,7 @@ In the first "Details" step, you can enter the product's general information and - 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 at the image's right. + - Click the in the image's row. - 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. diff --git a/www/apps/user-guide/app/products/edit/page.mdx b/www/apps/user-guide/app/products/edit/page.mdx index 27a890d7ac..896ee327aa 100644 --- a/www/apps/user-guide/app/products/edit/page.mdx +++ b/www/apps/user-guide/app/products/edit/page.mdx @@ -38,7 +38,7 @@ The first section, which has the product's title as a header, includes the produ ### Product Statuses -At the top right of the first section, you can see the product's status. A product can have one of the following statuses: +In the first section's header, you can see the product's status. A product can have one of the following statuses:
@@ -71,7 +71,7 @@ At the top right of the first section, you can see the product's status. A produ To edit the product's general details: -1. Click on the icon at the top right of the section. +1. Click on the icon in the section's header. 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. @@ -88,7 +88,7 @@ Deleting a product is irreversible. To delete the product: -1. Click on the icon at the top right of the section. +1. Click on the icon in the section's header. 2. Choose "Delete" from the dropdown. 3. Confirm deleting the product by clicking the "Delete" button in the pop-up. @@ -104,7 +104,7 @@ The Media section includes the product's images. Use this section to view and ed To add images to the product: -1. Click on the icon at the top right of the "Media" section. +1. Click on the icon in the "Media" section's header. 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. @@ -113,18 +113,18 @@ To add images to the product: You can edit the order that images are shown in. To do this: -1. Click on the icon at the top right of the "Media" section. +1. Click on the icon in the "Media" section's header. 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 icon at its top left. +The product's thumbnail image has the icon in the top corner. To set an image as the thumbnail: -1. Click on the icon at the top right of the "Media" section. +1. Click on the icon in the "Media" section's header. 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 T or click the "Make thumbnail" button at the bottom of the page. @@ -158,7 +158,7 @@ Unlike the product-creation form, when you create an option for an existing prod To add a new option to the product: -1. Click on the icon at the top right of the "Options" section. +1. Click on the icon in the "Options" section's header. 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". @@ -169,7 +169,7 @@ To add a new option to the product: To edit an option: -1. Click on the icon at the right of the option. +1. Click on the icon in its row. 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. @@ -184,7 +184,7 @@ Deleting an option is irreversible. To delete an option: -1. Click on the icon at the right of the option. +1. Click on the icon in its row. 2. Choose Delete from the dropdown. 3. Confirm deleting the option by clicking the Delete button in the pop-up. @@ -206,14 +206,14 @@ Metadata is custom data that can be associated with the product in key-value pai To edit the product's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. @@ -233,7 +233,7 @@ Removing a product from a sales channel will make it unavailable for purchase in -1. Click the icon at the top right of the "Sales Channels" section. +1. Click the icon in the "Sales Channels" section's header. 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. @@ -250,7 +250,7 @@ The Shipping Configuration section includes the product's shipping profile. Use To edit the product's shipping profile: -1. Click the icon at the top right of the "Shipping Configuration" section. +1. Click the icon in the "Shipping Configuration" section's header. 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. @@ -265,7 +265,7 @@ The Organize section includes the product's organization details. Use this secti To edit the product's organization details: -1. Click the icon at the top right of the "Organize" section. +1. Click the icon in the "Organize" section's header. 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. @@ -280,7 +280,7 @@ The Attributes section includes the product's attributes, such as height and wei To edit the product's attributes: -1. Click the icon at the top right of the "Attributes" section. +1. Click the icon in the "Attributes" section's header. 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. diff --git a/www/apps/user-guide/app/products/export/page.mdx b/www/apps/user-guide/app/products/export/page.mdx index c9ac9e098a..ddf4042a95 100644 --- a/www/apps/user-guide/app/products/export/page.mdx +++ b/www/apps/user-guide/app/products/export/page.mdx @@ -30,10 +30,10 @@ To export products: 1. Go to the Products page. 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. +3. Click on the Export button in the main section's header. 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 icon at the top right of the page. You should see your new export loading. +6. To check the export's status, click the notifications icon in the page's header. You should see your new export loading. 7. Once the export is ready, click the icon. diff --git a/www/apps/user-guide/app/products/import/page.mdx b/www/apps/user-guide/app/products/import/page.mdx index cacd571cf6..f1c78b4eda 100644 --- a/www/apps/user-guide/app/products/import/page.mdx +++ b/www/apps/user-guide/app/products/import/page.mdx @@ -250,7 +250,7 @@ The columns in the CSV file holds the details of the product variant and its ass To import products: 1. Go to the Products page. -2. Click on the Import button at the top right. +2. Click on the Import button in the main section's header. 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. @@ -273,7 +273,7 @@ This starts the import process which may take some time. To check whether the import is in progress, finished, or failed: -1. Click on the icon at the top right of the page. +1. Click on the notifications icon in the page's header. 2. Find the product import, which should be the latest item on the list. The text on the import item will explain the current state of the import. diff --git a/www/apps/user-guide/app/products/variants/page.mdx b/www/apps/user-guide/app/products/variants/page.mdx index 36e76e8a10..8a527f7477 100644 --- a/www/apps/user-guide/app/products/variants/page.mdx +++ b/www/apps/user-guide/app/products/variants/page.mdx @@ -44,7 +44,7 @@ You can create a variant to be multi-part or a bundle, as explained in [this gui -1. Click the "Create" button at the top right of the Variants section. +1. Click the "Create" button in the Variants section's header. 2. In the form that opens, there are two steps: 1. Details step: - Enter the variant's title and optionally SKU. @@ -75,7 +75,7 @@ Tax-inclusive pricing is configured in the [currency's](../../settings/store/pag To edit a product variant's general details: 1. Go to its product's details page. -2. In the Variants section, click on the at the variant's right. +2. In the Variants section, click on the in its row. 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. @@ -91,7 +91,7 @@ To edit a product variant's general details: To edit the prices of product variants: 1. Go to its product's details page. -2. Click on the at the top right of the section. +2. Click on the in the section's header. 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. @@ -116,7 +116,7 @@ There are many ways to manage the inventory of a product variant. From the produ To manage the inventory of a product's variants: 1. Go to its product's details page. -2. Click on the at the top right of the section. +2. Click on the in the section's header. 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. @@ -131,14 +131,14 @@ 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 at the right of the section. +3. Click on the in the section's header. 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 5. Once you're done, click the Save button. @@ -163,6 +163,6 @@ Deleting a product variant is irreversible. To delete a product variant: 1. Go to its product's details page. -2. In the Variants section, click on the at the variant's right. +2. In the Variants section, click on the in its row. 3. Choose "Delete" from the dropdown. 4. Confirm the action by clicking the "Delete" button in the pop-up. diff --git a/www/apps/user-guide/app/promotions/campaigns/page.mdx b/www/apps/user-guide/app/promotions/campaigns/page.mdx index f5d6b0afa6..d1ad31a51d 100644 --- a/www/apps/user-guide/app/promotions/campaigns/page.mdx +++ b/www/apps/user-guide/app/promotions/campaigns/page.mdx @@ -45,7 +45,7 @@ Find tips to use lists effectively in [this guide](../../tips/lists/page.mdx). To create a campaign: 1. Go to Promotions -> Campaigns from the sidebar. -2. Click on the Create button at the top right. +2. Click on the Create button in the main section's header. 3. In the form that opens: - Enter the campaign's name and identifier in their respective fields. - Optionally add a description in the Description field. @@ -78,7 +78,7 @@ This opens the campaign's details page. ### Campaign Statuses -At the top right of the first section, you can see the campaign's status. The status can be one of the following: +In the first section's header, you can see the campaign's status. The status can be one of the following:
@@ -110,7 +110,7 @@ At the top right of the first section, you can see the campaign's status. The st To edit the details of a campaign: 1. Go to the campaign's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the campaign's name, description, identifier, and start and end dates. 5. Once you're done, click the Save button. @@ -124,7 +124,7 @@ To edit the details of a campaign: To edit a campaign's budget usage or spending limit: 1. Go to the campaign's details page. -2. Click the icon at the top right of the "Budget Limit" section. +2. Click the icon in the "Budget Limit" section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the budget limit. 5. Once you're done, click the Save button. @@ -148,7 +148,7 @@ You can only add promotions that don't belong to another campaign. 1. Go to the campaign's details page. -2. Click on the Add button at the top right of the "Promotions" section. +2. Click on the Add button in the "Promotions" section's header. 3. In the list that opens, check the promotions you want to add to the campaign. 4. Once you're done, click the Save button. @@ -178,6 +178,6 @@ Deleting a campaign is irreversible. Deleting a campaign doesn't delete its prom To delete a campaign: 1. Go to the campaign's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm deleting the campaign by clicking the "Delete" button in the pop-up. diff --git a/www/apps/user-guide/app/promotions/manage/page.mdx b/www/apps/user-guide/app/promotions/manage/page.mdx index 2ac51e8707..375a366218 100644 --- a/www/apps/user-guide/app/promotions/manage/page.mdx +++ b/www/apps/user-guide/app/promotions/manage/page.mdx @@ -32,7 +32,7 @@ This opens the promotion's details page. The sections in the details page may di ### Promotion Statuses -A promotion's status is shown in the Promotions listing page, and in the promotion's details page at the top right of the first section. The status can be one of the following: +A promotion's status is shown in the Promotions listing page, and in the promotion's details page in the first section's header. The status can be one of the following:
@@ -72,7 +72,7 @@ A promotion's status is shown in the Promotions listing page, and in the promoti To edit a promotion's general details: 1. Go to the promotion's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens: - You can change the promotion's status to either **Draft**, **Active**, or **Inactive**. Inactive is useful if the promotion was originally active but you want to expire it. @@ -91,7 +91,7 @@ To edit a promotion's general details: To edit who can use the promotion: 1. Go to the promotion's details page. -2. Click the icon at the top right of the "Who can use this code?" section. +2. Click the icon in the header of the "Who can use this code?" section. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit existing conditions or add new ones by clicking the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: @@ -125,7 +125,7 @@ For "Buy X Get Y" or "buyget" promotion types, this section allows you to edit w To edit the items the promotion applies to: 1. Go to the promotion's details page. -2. Click the icon at the top right of the "What items will the promotion be applied to?" section. +2. Click the icon in the header of the "What items will the promotion be applied to?" section. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit existing conditions or add new ones by clicking the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: @@ -162,7 +162,7 @@ To edit the items that the customer gets for free when they buy the specified it To edit the "Buy X" part of the promotion: 1. Go to the promotion's details page. -2. Click the icon at the top right of the "What needs to be in the cart to unlock the promotion?" section. +2. Click the icon in the header of the "What needs to be in the cart to unlock the promotion?" section. 3. Choose Edit from the dropdown. 4. In the side window, you can edit the minimum required quantity of the product in the "Buy X" condition, and any other existing conditions. You can also add new conditions by clicking the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: @@ -199,7 +199,7 @@ For "Free Shipping" promotions, you can edit the required conditions for the pro To edit the shipping methods the promotion applies to: 1. Go to the promotion's details page. -2. Click the icon at the top right of the "What shipping methods will the promotion be applied to?" section. +2. Click the icon in the header of the "What shipping methods will the promotion be applied to?" section. 3. Choose Edit from the dropdown. 4. In the side window, you can edit the required conditions for the promotion to be applicable on a cart's shipping methods. You can also add new conditions by clicking the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: @@ -221,7 +221,7 @@ If you created a promotion without a campaign, you can add it to an existing cam To add a promotion to a campaign: 1. Go to the promotion's details page. -2. Click on "Add to Campaign" at the top right of the "Campaign" section. +2. Click on "Add to Campaign" in the header of the "Campaign" section. 3. In the side window that opens: - Select "Existing Campaign". - Choose the campaign from the "Existing Campaign" dropdown. For promotions that are applied as a fixed amount, only campaigns whose budget uses the same currency as the promotion are shown. @@ -238,7 +238,7 @@ You can change the campaign that a promotion belongs to, or remove it from a cam To change a promotion's campaign: 1. Go to the promotion's details page. -2. Click the icon at the top right of the "Campaign" section. +2. Click the icon in the header of the "Campaign" section. 3. Choose Edit from the dropdown. 4. In the side window that opens: - To remove the promotion from its current campaign, select "Without Campaign". @@ -258,6 +258,6 @@ Deleting a promotion is irreversible. To delete a promotion: 1. Go to the promotion's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm deleting the promotion in the pop-up by entering its code and clicking the "Delete" button. diff --git a/www/apps/user-guide/app/settings/developer/page.mdx b/www/apps/user-guide/app/settings/developer/page.mdx index 7bbfa2d8a3..4684f0d29b 100644 --- a/www/apps/user-guide/app/settings/developer/page.mdx +++ b/www/apps/user-guide/app/settings/developer/page.mdx @@ -9,7 +9,9 @@ export const metadata = { # {metadata.title} -The Developer section in the Medusa Admin's settings is useful for developers building customizations for your Medusa application. If you're unsure about how to use these settings, please consult with your technical team. +The Developer section in the Medusa Admin's settings is useful for developers building customizations for your Medusa application. + +If you're unsure about how to use these settings, please consult with your technical team. ## Manage Developer Settings diff --git a/www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx b/www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx index da4ed65de8..ad562bff8a 100644 --- a/www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx +++ b/www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx @@ -47,7 +47,7 @@ Here, you can see a list of all the publishable API keys you have set up in your To create a new publishable API key: 1. Go to Settings -> Publishable API Keys. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens, enter the publishable API key's title. 4. Once you're done, click the Save button. @@ -68,7 +68,7 @@ This opens the publishable API key's details page where you can also manage the ### Publishable API Key Status -You can see the status of the publishable API key at the top right of the first section in the details page. A publishable API key's status can be: +You can see the status of the publishable API key in the header of the first section in the details page. A publishable API key's status can be:
@@ -107,7 +107,7 @@ To copy a publishable API key: To edit a publishable API key: 1. Go to the publishable API key's details page. -2. Click the at the top right of the first section. +2. Click the in the first section's header. 3. Choose "Edit" from the dropdown. 4. In the side window that opens, you can edit the publishable API key's title. 5. Once you're done, click the Save button. @@ -125,7 +125,7 @@ You can manage the sales channels of a publishable API key in its details page. To add a sales channel to a publishable API key: 1. Go to the publishable API key's details page. -2. Click the "Add" button at the top right of the "Sales Channels" section. +2. Click the "Add" button in the "Sales Channels" section's header. 3. In the list that opens, check the sales channels you want to add the API key to. 4. Once you're done, click the Save button. @@ -155,7 +155,7 @@ Revoking a publishable API key is irreversible. You can't use the key in request To revoke a publishable API key: 1. Go to the publishable API key's details page. -2. Click the at the top right of the first section. +2. Click the in the first section's header. 3. Choose "Revoke API key" from the dropdown. 4. Confirm revoking the API key by clicking the "Revoke API key" button in the pop-up. @@ -172,6 +172,6 @@ Deleting a publishable API key is irreversible. You can only delete a publishable API key after [revoking it](#revoke-publishable-api-key). To delete a publishable API key: 1. Go to the publishable API key's details page. -2. Click the at the top right of the first section. +2. Click the in the first section's header. 3. Choose "Delete" from the dropdown. 4. Confirm deleting the API key by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx b/www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx index 616d018e80..39b3959094 100644 --- a/www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx +++ b/www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx @@ -49,7 +49,7 @@ When you create a secret API key, you create it for the currently logged-in user To create a new secret API key for the currently logged-in user: 1. Go to Settings -> Secret API Keys. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens, enter the secret API key's title. 4. Once you're done, click the Save button. 5. You'll get a pop-up with the secret API key. Copy it and store it securely before closing the pop-up, as you won't be able to see it again. @@ -71,7 +71,7 @@ This opens the secret API key's details page where you can also manage the API k ### Secret API Key Status -You can see the status of the secret API key at the top right of the first section in the details page. A secret API key's status can be: +You can see the status of the secret API key in the header of the first section in the details page. A secret API key's status can be:
@@ -99,7 +99,7 @@ You can see the status of the secret API key at the top right of the first secti To edit a secret API key: 1. Go to the secret API key's details page. -2. Click the at the top right of the first section. +2. Click the in the first section's header. 3. Choose "Edit" from the dropdown. 4. In the side window that opens, you can edit the secret API key's title. 5. Once you're done, click the Save button. @@ -119,7 +119,7 @@ Revoking a secret API key is irreversible. You can't use the key in requests aft To revoke a secret API key: 1. Go to the secret API key's details page. -2. Click the at the top right of the first section. +2. Click the in the first section's header. 3. Choose "Revoke API key" from the dropdown. 4. Confirm revoking the API key by clicking the "Revoke API key" button in the pop-up. @@ -136,6 +136,6 @@ Deleting a secret API key is irreversible. You can only delete a secret API key after [revoking it](#revoke-secret-api-key). To delete a secret API key: 1. Go to the secret API key's details page. -2. Click the at the top right of the first section. +2. Click the in the first section's header. 3. Choose "Delete" from the dropdown. 4. Confirm deleting the API key by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/developer/workflows/page.mdx b/www/apps/user-guide/app/settings/developer/workflows/page.mdx index 97335cb87f..d17a944f3a 100644 --- a/www/apps/user-guide/app/settings/developer/workflows/page.mdx +++ b/www/apps/user-guide/app/settings/developer/workflows/page.mdx @@ -19,59 +19,87 @@ In this guide, you'll learn how to view workflow executions in the Medusa Admin. -This guide is mainly useful for developers and technical teams building and debugging customizations of a Medusa application. +This guide is primarily useful for developers and technical teams building and debugging customizations of a Medusa application. ## What are Workflow Executions? -[Workflows](!docs!/learn/fundamentals/workflows) are a series of steps that perform a task. You build a workflow in your source code to implement custom commerce flows and features. +[Workflows](!docs!/learn/fundamentals/workflows) are a series of steps that perform a task. You build workflows in your source code to implement custom commerce flows and features. -When you execute a workflow, it runs the steps in sequence to complete the task. If you've configured the workflow to have its executions stored in the database as explained in [this technical guide](!docs!/learn/fundamentals/workflows/store-executions), you can view the executions and their details in the Medusa Admin. This is useful to debug workflows and ensure they ran as expected. +When you execute a workflow, Medusa runs the steps in sequence to complete the task. If you've configured the workflow to store its executions in the database as explained in the [Store Workflow Executions guide](!docs!/learn/fundamentals/workflows/store-executions), you can view the workflow's executions and their details in the Medusa Admin. This is useful for debugging workflows and ensuring they run as expected. --- ## View Workflow Executions -To view workflow executions, go to Settings → Workflows. There, you'll find the list of custom and Medusa workflows that have been executed and are stored in the database. You can search through the list to find the one you're looking for. +To view workflow executions, go to Settings → Workflows. There, you'll find a list of custom and Medusa workflows that have been executed and are stored in the database. You can search through the list to find the one you're looking for. ![Workflow executions list](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496862/User%20Guide/Screenshot_2025-02-25_at_5.16.30_PM_fjkbrc.png) ### Workflow Execution Status -In the list, you can view the status of each workflow execution. A workflow's execution status can be: +In the list, you can view the status of each workflow execution. A workflow execution's status can be:
- Status - Description + + Status + + + Description + - Not Started - The workflow has been executed, but its steps haven't been invoked yet. + + Not Started + + + The workflow has been executed, but its steps haven't been invoked yet. + - Invoking - The workflow execution is currently running, invoking its steps. + + Invoking + + + The workflow execution is currently running and invoking its steps. + - Done - The workflow execution has finished successfully. + + Done + + + The workflow execution has completed successfully. + - Failed - The workflow execution has failed. + + Failed + + + The workflow execution has failed. + - Compensating - The workflow execution is compensating its steps after a failure. + + Compensating + + + The workflow execution is compensating its steps after a failure. + - Reverted - The workflow execution has been reverted, which occurs when the workflow ran as part of another workflow and the parent workflow failed. + + Reverted + + + The workflow execution has been reverted, which occurs when the workflow runs as part of another workflow and the parent workflow fails. +
@@ -85,7 +113,7 @@ To view a workflow execution's details: 1. Go to Settings → Workflows. 2. Click on the workflow execution to view it. -On the workflow execution's page, you'll find multiple sections with the execution's details. +On the workflow execution's page, you'll find multiple sections containing the execution's details. ![Workflow executions details](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496967/User%20Guide/Screenshot_2025-02-25_at_5.22.33_PM_z6al6a.png) @@ -93,24 +121,28 @@ On the workflow execution's page, you'll find multiple sections with the executi In the first section, you'll find a summary of the workflow execution, including: -- A badge at the top right indicating its [status](#workflow-execution-status). +- A badge at the top end of the section indicating the [execution's status](#workflow-execution-status). - The workflow's unique ID, which you specify when you create the workflow. - The transaction ID, which is a unique identifier for the workflow execution. This is useful for debugging, tracking, and changing step statuses of [long-running workflows](!docs!/learn/fundamentals/workflows/long-running-workflow). -- The workflow's progress which shows a quick overview of the steps that have been executed. +- The workflow's progress, which shows a quick overview of the steps that have been executed. ### Timeline -The timeline diagram shows you the step by step execution of the workflow. You can zoom in and out, and drag and move the mouse to view the entire diagram. You can also click on a step to view its execution details in the [History](#history) section. +The timeline diagram shows you the step-by-step execution of the workflow. You can zoom in and out, and drag the mouse to view the entire diagram. You can also click on a step to view its execution details in the [History](#history) section. #### Step Status -In the timeline diagram, each step node has a small box at its left whose color indicates its status: +In the timeline diagram, each step node has a small box whose color indicates the step's status: - Color - Description + + Color + + + Description + @@ -143,7 +175,7 @@ In the timeline diagram, each step node has a small box at its left whose color Gray - The step hasn't been executed yet, or it's been skipped, which can occur if the step is part of a [when condition](!docs!/learn/fundamentals/workflows/conditions). + The step hasn't been executed yet, or it has been skipped, which can occur if the step is part of a [when condition](!docs!/learn/fundamentals/workflows/conditions). @@ -155,11 +187,11 @@ The JSON section allows you to view the execution's details as a raw JSON object ### History -The History section shows you the execution of the workflow's steps by order of execution. You can see each step's name with a dot reflecting its status as explained in the [Step Status](#step-status) section. +The History section shows you the execution of the workflow's steps in order of execution. You can see each step's name with a dot reflecting its status as explained in the [Step Status](#step-status) section. If you click on any executed step, you'll see its details, including: -- **Definition**: the step's configurations which can be passed when you create the step. For example, the step's name, whether it has a compensation function, whether it's asynchronous, etc... +- **Definition**: the step's configurations that can be passed when you create the step. For example, the step's name, whether it has a compensation function, or whether it's asynchronous. - **Output**: the step's output, which is the result of the step's execution. - **Compensation Input**: if the workflow failed and the step has a compensation function, you can see the input that the compensation function received. - **Error**: if the step failed, you can see the error message. diff --git a/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx b/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx index aa2c00551b..545d4089a6 100644 --- a/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx +++ b/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx @@ -37,7 +37,7 @@ Then, during checkout, a customer can only choose shipping options available fro To create a stock location: 1. Go to Settings → Locations & Shipping. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens: - Enter the location's name, such as "Main Warehouse". - Enter the address details. It's only required to enter an address line and choose a country. @@ -52,7 +52,7 @@ To create a stock location: To view the details of a location: 1. Go to Settings → Locations. -2. Click on "View details" at the top right of the location's section. +2. Click on "View details" in the header of the location's section. This opens the location's details page where you can also manage the location. @@ -65,7 +65,7 @@ This opens the location's details page where you can also manage the location. To edit a stock location: 1. Open the location's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the location's name and address details. 5. Once you're done, click the Save button. @@ -87,7 +87,7 @@ So, to create a shipping option for either pick-up or shipping, you need to enab By default, pick-up and shipping are disabled in a location. To enable either: 1. Go to the location's details page. -2. Click the icon at the top right of the "Pickup" or "Shipping" section. +2. Click the icon in the header of the "Pickup" or "Shipping" section. 3. Choose Enable from the dropdown. You can also disable the shipping mode by following the same steps. @@ -97,7 +97,7 @@ You can also disable the shipping mode by following the same steps. To ceate a service zone for pick-up or shipping: 1. Go to the location's details page. -2. Click the icon at the top right of the "Pickup" or "Shipping" section. +2. Click the icon in the header of the "Pickup" or "Shipping" section. 3. Choose "Create service zone" from the dropdown. 4. In the form that opens: - In the Name field, enter the name of the service zone. For example, "United States". @@ -119,7 +119,7 @@ To create a shipping option: 1. Go to the location's details page. 2. In the "Pickup" or "Shipping" section, find the service zone you want to add the shipping option to. -3. Click the "Create option" at the right of either "Shipping options", "Pickup options", or "Return options", based on the type of shipping option you're creating. +3. Click the "Create option" next to either "Shipping options", "Pickup options", or "Return options", based on the type of shipping option you're creating. 4. In the form that opens: - If the shipping option isn't a pick-up option, you can choose the price type. Choose **Fixed** if you want to apply fixed pricing for the shipping option, or **Calculated** if the price should be calculated dynamically during checkout. Calculated prices are useful if you're using a third-party fulfillment provider that calculates prices dynamically. - If you chose Fixed, you'll set the price in the next step of the form. @@ -186,7 +186,7 @@ You can manage service zones in pick-up or shipping mode by [creating](#2-create To edit a service zone in a location: 1. Go to the location's details page. -2. In the "Pickup" or "Shipping" sections, find the service zone and click on the icon at its right. +2. In the "Pickup" or "Shipping" sections, find the service zone and click on the icon next to it. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the service zone's name. 5. Once you're done, click the Save button. @@ -198,7 +198,7 @@ To edit a service zone in a location: To manage the areas in a service zone: 1. Go to the location's details page. -2. In the "Pickup" or "Shipping" sections, find the service zone and click on the icon at its right. +2. In the "Pickup" or "Shipping" sections, find the service zone and click on the icon next to it. 3. Choose "Manage areas" from the dropdown. 4. In the form that opens, manage the areas in the service zone: - Click the "Manage areas" button. @@ -219,7 +219,7 @@ Deleting a service zone is irreversible. It will delete all shipping options in To delete a service zone: 1. Go to the location's details page. -2. In the "Pickup" or "Shipping" sections, find the service zone and click on the icon at its right. +2. In the "Pickup" or "Shipping" sections, find the service zone and click on the icon next to it. 3. Choose Delete from the dropdown. 4. Confirm deleting the service zone by clicking the Delete button in the pop-up. @@ -234,7 +234,7 @@ You can manage shipping options in pick-up and shipping modes by [creating](#cre To edit a shipping option's details: 1. Go to the location's details page. -2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the icon at its right. +2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the icon next to it. 3. Choose "Edit option" from the dropdown. 4. In the side window that opens, you can edit the shipping option's price type, name, shipping profile, shipping option type, and whether it's enabled in store for customers to use. 5. Once you're done, click the Save button. @@ -252,7 +252,7 @@ You can't edit a shipping option's fulfillment provider or fulfillment option af To edit the prices of shipping options whose price type is Fixed: 1. Go to the location's details page. -2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the icon at its right. +2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the icon next to it. 3. Choose "Edit prices" from the dropdown. 4. In the [Bulk Editor](../../../tips/bulk-editor/page.mdx) that opens, you can edit the shipping option's price for every currency and region in your store. - Refer to the [Fixed and Conditional Shipping Option Prices](#fixed-and-conditional-shipping-option-prices) section to learn how to set a conditional price for the shipping option. @@ -280,7 +280,7 @@ Deleting a shipping option is irreversible. To delete a shipping option: 1. Go to the location's details page. -2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the icon at its right. +2. In the "Pickup" or "Shipping" sections, find the shipping option and click on the icon next to it. 3. Choose Delete from the dropdown. 4. Confirm deleting the shipping option by entering its name in the pop-up and clicking the "Delete" button. @@ -291,7 +291,7 @@ To delete a shipping option: To change the sales channels associated with a location: 1. Go to the location's details page. -2. Click the icon at the top right of the "Sales Channels" section. +2. Click the icon in the header of the "Sales Channels" section. 3. Choose Edit from the dropdown. 4. In the list that opens, you can select the sales channels to associate with the location, or unselect the ones you want to remove. 5. Once you're done, click the Save button. @@ -305,7 +305,7 @@ To change the sales channels associated with a location: To manage the fulfillment providers available in a location: 1. Go to the location's details page. -2. Click the icon at the top right of the "Fulfillment Providers" section. +2. Click the icon in the header of the "Fulfillment Providers" section. 3. Choose Edit from the dropdown. 4. In the list that opens, you can select the fulfillment providers to associate with the location, or unselect the ones you want to remove. 5. Once you're done, click the Save button. @@ -325,6 +325,6 @@ Deleting a location is irreversible and will delete its service zones and shippi To delete a location: 1. Open the location's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm deleting the location by entering its name and clicking the Delete button. diff --git a/www/apps/user-guide/app/settings/locations-and-shipping/shipping-option-types/page.mdx b/www/apps/user-guide/app/settings/locations-and-shipping/shipping-option-types/page.mdx index 28581d9f86..fb6fe920e9 100644 --- a/www/apps/user-guide/app/settings/locations-and-shipping/shipping-option-types/page.mdx +++ b/www/apps/user-guide/app/settings/locations-and-shipping/shipping-option-types/page.mdx @@ -53,12 +53,12 @@ To create a shipping option type: 1. Go to Settings → Location & Shipping. 2. In the Shipping Configuration section, click on Shipping Option Types. -3. Click the Create button at the top right. +3. Click the Create button in the main section's header. 4. In the form that opens, enter the following information: - **Label**: The name of the shipping option type that can be displayed to customers. For example, "Same Day". - **Code**: A unique identifier for the shipping option type. For example, `same_day`. - **Description**: A brief description of the shipping option type. This is optional but can be helpful to provide more context about the type. For example, "Delivery within the same day". -5. Once you're done, click the Create button at the bottom right. +5. Once you're done, click the Create button at the bottom. ![Create shipping option type form](https://res.cloudinary.com/dza7lstvk/image/upload/v1756371811/User%20Guide/CleanShot_2025-08-28_at_12.02.05_2x_fg66gh.png) @@ -82,7 +82,7 @@ This opens the shipping option type's details page, where you can also manage th To edit the details of a shipping option type: 1. Go to the shipping option type's details page. -2. Click the button in the top right corner of the first section. +2. Click the button in the first section's header. 3. Select "Edit" from the dropdown menu. 4. In the side window that opens, you can edit the shipping option type's label, code, and description. 5. Once you're done, click the Save button. @@ -102,6 +102,6 @@ Deleting a shipping option type is irreversible. To delete a shipping option type: 1. Go to the shipping option type's details page. -2. Click the button in the top right corner of the first section. +2. Click the button in the first section's header. 3. Select "Delete" from the dropdown menu. 4. Confirm the deletion of the shipping option type in the pop-up. diff --git a/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx b/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx index 1394c9ad4e..e85defe8eb 100644 --- a/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx +++ b/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx @@ -43,7 +43,7 @@ Here, you can see a list of all the shipping profiles you have set up in your st To create a shipping profile: 1. Go to Settings → Location & Shipping -> Shipping Profiles. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens: - In the Name field, enter a name for the shipping profile. For example, "Fragile". - In the Type field, enter the type of products that belong to the shipping profile. For example, "fragile" or "heavy". @@ -78,14 +78,14 @@ Metadata is custom data that can be associated with the shipping profile in key- To edit the shipping profile's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. @@ -102,6 +102,6 @@ Deleting a shipping profile is irreversible. To delete a shipping profile: 1. Go to the shipping profile's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm the deletion by entering the shipping profile's name in the pop-up and clicking the Delete button. diff --git a/www/apps/user-guide/app/settings/product-tags/page.mdx b/www/apps/user-guide/app/settings/product-tags/page.mdx index 1b9bb75013..d79cbefc56 100644 --- a/www/apps/user-guide/app/settings/product-tags/page.mdx +++ b/www/apps/user-guide/app/settings/product-tags/page.mdx @@ -32,7 +32,7 @@ To view product tags in your store, go to Settings → Product Tags. Here, you c To create a product tag: 1. Go to Settings → Product Tags. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens, enter a value for the product tag in the Value field. For example, "Digital". 4. Once you're done, click the Create button. @@ -58,7 +58,7 @@ This opens the product tag's details page where you can also manage the product To edit the details of a product tag: 1. Go to the product tag's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the product tag's value. 5. Once you're done, click the Save button. @@ -85,14 +85,14 @@ Metadata is custom data that can be associated with the product tag in key-value To edit the product tag's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. @@ -109,6 +109,6 @@ Deleting a product tag is irreversible. To delete a product tag: 1. Go to the product tag's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm the deletion by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/product-types/page.mdx b/www/apps/user-guide/app/settings/product-types/page.mdx index 64254f1f4e..97d1d76e9b 100644 --- a/www/apps/user-guide/app/settings/product-types/page.mdx +++ b/www/apps/user-guide/app/settings/product-types/page.mdx @@ -32,7 +32,7 @@ To view product types in your store, go to Settings → Product Types. Here, you To create a product type: 1. Go to Settings → Product Types. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens, enter a value for the product type in the Value field. For example, "Digital". 4. Once you're done, click the Create button. @@ -58,7 +58,7 @@ This opens the product type's details page where you can also manage the product To edit the details of a product type: 1. Go to the product type's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the product type's value. 5. Once you're done, click the Save button. @@ -79,14 +79,14 @@ Metadata is custom data that can be associated with the product type in key-valu To edit the product type's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. @@ -103,6 +103,6 @@ Deleting a product type is irreversible. To delete a product type: 1. Go to the product type's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm the deletion by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/profile/page.mdx b/www/apps/user-guide/app/settings/profile/page.mdx index 7bb8f320a6..ee20403c61 100644 --- a/www/apps/user-guide/app/settings/profile/page.mdx +++ b/www/apps/user-guide/app/settings/profile/page.mdx @@ -20,7 +20,7 @@ In this guide, you’ll learn how to view and manage your profile's details and ## View Profile Details -To view your profile details, go to Settings → Profile. You can alternatively click on your name at the bottom right of the sidebar, and choose "Profile settings" from the menu. +To view your profile details, go to Settings → Profile. You can alternatively click on your name at the bottom of the sidebar, and choose "Profile settings" from the menu. In your profile details page, you can view your profile information such as your name, email, and language settings. @@ -33,7 +33,7 @@ In your profile details page, you can view your profile information such as your To edit your profile details and settings: 1. Go to Settings → Profile. -2. Click the icon at the top right of the page. +2. Click the icon in the main section's header. 3. Choose "Edit" from the dropdown. 4. In the side window that opens, you can edit your first and last name, and the Medusa Admin dashboard language. This only changes the language of the admin interface, not the language of the store. It also doesn't change the language for other users in the admin. 5. Once you're done, click the Save button. diff --git a/www/apps/user-guide/app/settings/regions/page.mdx b/www/apps/user-guide/app/settings/regions/page.mdx index d623cc354a..1798d0aa43 100644 --- a/www/apps/user-guide/app/settings/regions/page.mdx +++ b/www/apps/user-guide/app/settings/regions/page.mdx @@ -48,7 +48,7 @@ To view regions in your store, go to Settings → Regions. Here, you can see a l To create a region: 1. Go to Settings → Regions. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens: - In the Name field, enter a name for the region. For example, "Europe". - In the Currency field, select the region's currency. A region can only have one currency. @@ -83,7 +83,7 @@ This opens the region's details page where you can also manage the region. To edit a region's details: 1. Go to the region's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the region's name, currency, payment providers, and settings for automatic taxes and [tax-inclusive pricing](#tax-inclusive-pricing-for-regions). 5. Once you're done, click the Save button. @@ -101,7 +101,7 @@ You can manage a region's countries to add or remove them from the region. To add countries to a region: 1. Go to the region's details page. -2. Click the icon at the top right of the "Countries" section. +2. Click the icon in the "Countries" section's header. 3. Choose "Add countries" from the dropdown. 4. In the list that opens, check the countries you want to add to the region. 5. Once you're done, click the Add button. @@ -125,14 +125,14 @@ Metadata is custom data that can be associated with the region in key-value pair To edit the region's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. @@ -149,6 +149,6 @@ Deleting a region is irreversible. To delete a region from your store: 1. Go to the region's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm deleting the region by typing the region's name in the pop-up and clicking the Delete button. diff --git a/www/apps/user-guide/app/settings/return-reasons/page.mdx b/www/apps/user-guide/app/settings/return-reasons/page.mdx index d142a8b1f7..edb29c1862 100644 --- a/www/apps/user-guide/app/settings/return-reasons/page.mdx +++ b/www/apps/user-guide/app/settings/return-reasons/page.mdx @@ -39,7 +39,7 @@ To view return reasons in your store, go to Settings → Return Reasons. Here, y To create a return reason: 1. Go to Settings → Return Reasons. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens: - Enter in the Value field a unique identifier for the reason that's used internally. It's recommended to use only lowercase letters and underscores (`_`). For example, "damaged" or "wrong_size". - Enter in the Label field what is shown to customers or admin users. @@ -55,7 +55,7 @@ To create a return reason: To edit a return reason: 1. Go to Settings → Return Reasons. -2. Find the return reason to edit and click the icon at its right. +2. Find the return reason to edit and click the icon in its row. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the return reason's value, label, and description. 5. Once you're done, click the Save button. @@ -75,6 +75,6 @@ Deleting a return reason is irreversible. To delete a return reason: 1. Go to Settings → Return Reasons. -2. Find the return reason to delete and click the icon at its right. +2. Find the return reason to delete and click the icon in its row. 3. Choose Delete from the dropdown. 4. Confirm deleting the return reason by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/sales-channels/page.mdx b/www/apps/user-guide/app/settings/sales-channels/page.mdx index f9a52a8b67..c6e8152f10 100644 --- a/www/apps/user-guide/app/settings/sales-channels/page.mdx +++ b/www/apps/user-guide/app/settings/sales-channels/page.mdx @@ -53,7 +53,7 @@ To view sales channels in your store, go to Settings → Sales Channels. Here, y To create a sales channel: 1. Go to Settings → Sales Channels. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens: - In the Name field, enter a name for the sales channel. For example, "Web Storefront". - In the Description field, enter a description of the sales channel. @@ -77,7 +77,7 @@ This opens the sales channel's details page where you can also manage the sales ### Sales Channel Status -The status of a sales channel is shown at the top right of the first section in the details page. The status can be either "Enabled" or "Disabled". You can change the status by [editing the sales channel details](#edit-sales-channel-details). +The status of a sales channel is shown in the header of the first section in the details page. The status can be either "Enabled" or "Disabled". You can change the status by [editing the sales channel details](#edit-sales-channel-details). --- @@ -86,7 +86,7 @@ The status of a sales channel is shown at the top right of the first section in To edit the details of a sales channel: 1. Go to the sales channel's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the sales channel's name, description, and whether it's enabled. 5. Once you're done, click the Save button. @@ -134,6 +134,6 @@ Deleting a sales channel is irreversible. To delete a sales channel: 1. Go to the sales channel's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Delete from the dropdown. 4. Confirm deleting the sales channel by entering the sales channel's name and clicking the "Delete" button in the pop-up. \ No newline at end of file diff --git a/www/apps/user-guide/app/settings/store/page.mdx b/www/apps/user-guide/app/settings/store/page.mdx index ffd9108715..60e068ea1b 100644 --- a/www/apps/user-guide/app/settings/store/page.mdx +++ b/www/apps/user-guide/app/settings/store/page.mdx @@ -32,7 +32,7 @@ To view your store's details, go to Settings → Store. There, you can view and To edit the store’s details: 1. Go to Settings → Store. -2. Click the icon at the top right of the "Store" section. +2. Click the icon in the "Store" section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the store's name, default currency, default region, default sales channel, and default location. These defaults are used in the storefront if no other values are provided. 5. Once you're done, click the Save button. @@ -50,10 +50,10 @@ Your store can support multiple currencies, allowing customers to view prices in To add currencies to your store: 1. Go to Settings → Store. -2. Click the icon at the top right of the "Currencies" section. +2. Click the icon in the "Currencies" section's header. 3. Choose Add from the dropdown. 4. In the list that opens, check the currencies you want to add to the store. - - To enable [tax-inclusive pricing](#edit-tax-inclusive-setting-for-currency) for a currency, enable the toggle at the currency's right. + - To enable [tax-inclusive pricing](#edit-tax-inclusive-setting-for-currency) for a currency, enable the toggle next to the currency. 5. Once you're done, click the Save button. ![Add currencies to store](https://res.cloudinary.com/dza7lstvk/image/upload/v1739963867/User%20Guide/Screenshot_2025-02-19_at_1.17.37_PM_mjrxng.png) @@ -68,7 +68,7 @@ In the store's settings, you can also manage a currency's tax-inclusive price se You can manage whether a currency uses tax-inclusive pricing when adding or editing it. To edit the tax-inclusive setting for a currency: 1. Go to Settings → Store. -2. Click the icon at the right of the currency you want to edit. +2. Click the icon next to the currency you want to edit. 3. Choose "Enable tax-inclusive pricing" or "Disable tax-inclusive pricing" from the dropdown, depending on the current setting. ### Remove Currencies @@ -92,13 +92,13 @@ Metadata is custom data that can be associated with the store in key-value pairs To edit the store's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. diff --git a/www/apps/user-guide/app/settings/tax-regions/page.mdx b/www/apps/user-guide/app/settings/tax-regions/page.mdx index fff06975de..fd06add9f1 100644 --- a/www/apps/user-guide/app/settings/tax-regions/page.mdx +++ b/www/apps/user-guide/app/settings/tax-regions/page.mdx @@ -41,7 +41,7 @@ To view tax regions in your store, go to Settings → Tax Regions. Here, you can To create a tax region: 1. Go to Settings → Tax Regions. -2. Click the Create button at the top right. +2. Click the Create button in the main section's header. 3. In the form that opens: - In the Country field, select the country that this tax region applies to. - Under the "Default tax rate" section, you can optionally enter a name, tax rate, and tax code in their respective fields. @@ -69,7 +69,7 @@ This opens the tax region's details page, where you can also manage the tax regi To edit a tax region: 1. Go to the tax region's details page. -2. Click the icon at the right of the tax region's name. +2. Click the icon at the end of the tax region's row. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the tax region's default tax provider. 5. Once you're done, click the Save button. @@ -83,7 +83,7 @@ To edit a tax region: To edit the default tax rate of a region: 1. Go to the tax region's details page. -2. In the first section, you'll find details of the default tax rate, including its tax rate and code. Click the icon at its right. +2. In the first section, you'll find details of the default tax rate, including its tax rate and code. Click the icon at its end. ![The icon to click on](https://res.cloudinary.com/dza7lstvk/image/upload/v1739974452/User%20Guide/Screenshot_2025-02-19_at_4.13.51_PM_zclvnp.png) @@ -122,7 +122,7 @@ To create a tax rate override for a product or product type in a tax region: To edit a tax rate override: 1. Go to the region's details page. -2. In the "Overrides" section, click the icon at the right of the override you want to edit. +2. In the "Overrides" section, click the icon next to the override you want to edit. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the override's name, rate, code, and whether the tax rate should be combined with the default rate. You can also edit the targets of the override. 5. Once you're done, click the Save button. @@ -140,7 +140,7 @@ Deleting a tax rate override is irreversible. To delete a tax rate override: 1. Go to the region's details page. -2. In the "Overrides" section, click the icon at the right of the override you want to delete. +2. In the "Overrides" section, click the icon next to the override you want to delete. 3. Choose Delete from the dropdown. 4. Confirm deleting the override by clicking the Delete button in the pop-up. @@ -199,7 +199,7 @@ Deleting a sublevel tax region is irreversible. To delete a sublevel tax region: 1. Go to the sublevel tax region's details page. -2. Click the icon at the right of the sublevel tax region's name. +2. Click the icon in the sublevel tax region's row. 3. Choose Delete from the dropdown. 4. Confirm deleting the sublevel tax region by clicking the Delete button in the pop-up. @@ -216,6 +216,6 @@ Deleting a tax region is irreversible. To delete a tax region: 1. Go to the tax region's details page. -2. Click the icon at the right of the tax region's name. +2. Click the icon in the tax region's row. 3. Choose Delete from the dropdown. 4. Confirm deleting the tax region by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/users/page.mdx b/www/apps/user-guide/app/settings/users/page.mdx index 29291365cf..f6fe13a2bf 100644 --- a/www/apps/user-guide/app/settings/users/page.mdx +++ b/www/apps/user-guide/app/settings/users/page.mdx @@ -50,7 +50,7 @@ This opens the user's details page where you can also manage the user. To edit the details of an admin user: 1. Go to the user's details page. -2. Click the icon at the top right of the first section. +2. Click the icon in the first section's header. 3. Choose Edit from the dropdown. 4. In the side window that opens, you can edit the user's first and last names. 5. Once done, click the Save button. @@ -65,14 +65,14 @@ Metadata is custom data that can be associated with the user in key-value pairs. To edit the user's metadata: -1. Click the icon at the right of the "Metadata" section. +1. Click the 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 icon at its right. + - Hover over the row and click the 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 icon at its right. + - Hover over the row and click the icon at its end. - Choose "Delete row" from the dropdown. 3. Once you're done, click the Save button. @@ -90,6 +90,6 @@ To delete a user from your store: 1. Go to Settings → Users. 2. Find the user in the list and click on it. -3. Click the icon at the top right of the first section. +3. Click the icon in the first section's header. 4. Choose Delete from the dropdown. 4. Confirm deleting the user by entering their name and clicking the "Delete" button in the pop-up. diff --git a/www/apps/user-guide/app/tips/bulk-editor/page.mdx b/www/apps/user-guide/app/tips/bulk-editor/page.mdx index ed833fec86..b727dc84dd 100644 --- a/www/apps/user-guide/app/tips/bulk-editor/page.mdx +++ b/www/apps/user-guide/app/tips/bulk-editor/page.mdx @@ -35,7 +35,7 @@ As the bulk editor may include a large number of columns, such as the different To do that: -1. Click on the "View" button at the top left. +1. Click on the "View" button in the top corner. 2. Check or uncheck a column by clicking on it in the dropdown. ![Change viewed columns](https://res.cloudinary.com/dza7lstvk/image/upload/v1739536402/User%20Guide/Screenshot_2025-02-14_at_2.32.59_PM_a6sf4t.png) diff --git a/www/apps/user-guide/app/tips/lists/page.mdx b/www/apps/user-guide/app/tips/lists/page.mdx index 8354c66386..f8cb3358f1 100644 --- a/www/apps/user-guide/app/tips/lists/page.mdx +++ b/www/apps/user-guide/app/tips/lists/page.mdx @@ -11,7 +11,9 @@ export const metadata = { # {metadata.title} -In this guide, you’ll get an overview of lists in Medusa including filters, searching, and more. Each domain in the Medusa Admin, such as products or orders, has a list view displaying the items in that domain. Generally, you can apply advanced filters, search for items, and sort items. +In this guide, you'll learn how to use lists in the Medusa Admin efficiently to view your store's data. + +Each domain in the Medusa Admin, such as products or orders, has a list view that displays the items in that domain. You can apply advanced filters, search for items, and sort items. ![List Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1739538757/User%20Guide/Screenshot_2025-02-14_at_3.07.21_PM_p3vkey.png) @@ -19,13 +21,13 @@ In this guide, you’ll get an overview of lists in Medusa including filters, se Use filters to retrieve items in a list matching specific criteria. -To do that: +To filter items: -1. Click on the "Add filter" button at the top of the list. +1. Click the "Add filter" button at the top of the list. 2. From the dropdown, choose the criteria you want to filter by, such as Tag. -3. This shows a new set of values to filter the list by. Select the value(s) you want to filter by. +3. This will show a new set of values to filter the list by. Select the value(s) you want to filter by. -After selecting the value(s), the list only includes the items matching your filters. You can also apply multiple filters. +After selecting the value(s), the list will only include items that match your filters. You can also apply multiple filters. ![Add Filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1739538873/User%20Guide/Screenshot_2025-02-14_at_3.13.51_PM_jq7o7f.png) @@ -39,7 +41,7 @@ To clear all applied filters, click on the "Clear all" link at the end of the li To search for items in a list: -1. Click the search input at the top right of the list. +1. Click the search input in the list header. 2. Enter your search term. The list is updated in real-time with items matching the search query. ![Search Items](https://res.cloudinary.com/dza7lstvk/image/upload/v1739540581/User%20Guide/Screenshot_2025-02-14_at_3.42.41_PM_ijhthi.png) @@ -51,16 +53,16 @@ To search for items in a list: To configure the sorting of items in the list: 1. Click on the button. -2. Choose the field to filter by (for example, Created date) and the direction of filter (ascending or descending). +2. Choose the field to sort by (for example, Created date) and the direction of sort (ascending or descending). -On clicking the new configuration, the list will be updated with the new sorting. +When you click the new configuration, the list will be updated with the new sorting. ![Sort Items](https://res.cloudinary.com/dza7lstvk/image/upload/v1739540693/User%20Guide/Screenshot_2025-02-14_at_3.44.37_PM_roprfq.png) --- -## Multiple Pages +## List Pagination -Lists in the Medusa Admin span across multiple pages if the number of items in that list are more than twenty. +Lists in the Medusa Admin span across multiple pages if the number of items in that list is more than twenty. You can navigate between pages using the "Prev" and "Next" buttons at the bottom of the list.